Sign in

Coupon: Settlement

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

Settles a coupon by couponCode — marks it as redeemed and binds it to the originating orderId. The (organization, interface, code) triple must match a non-redeemed coupon_codes row; re-submitting a code that has already been redeemed returns 409 Conflict.

Try-it values populated from environment ACME (Demo)


Authentication

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.

Headers

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.

Path parameters

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

Request body

Content-Type: application/json

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

Responses

Copied to clipboard