Entrar

Cupom: Settlement

POST https://{organization}.myguper.com/api/loyalty/coupon/{couponCode}/settlement

Liquida um cupom pelo couponCode — marca como resgatado e vincula ao orderId de origem. A tripla (organization, interface, code) precisa casar com uma linha não resgatada em coupon_codes; reenviar um código já resgatado retorna 409 Conflict.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros do caminho

Name Type Description
couponCode * string The coupon code as printed/distributed.

Corpo da requisição

Content-Type: application/json

{
    "interface": "generic",
    "orderId": "VTEX-99182"
}

Respostas

Copied to clipboard