Entrar

Reservar cupom

POST https://{organization}.myguper.com/api/loyalty/coupon/{transactionId}/reserve

Reserva um código de cupom de um lote (couponBatchId) para uma transação específica. Seleciona um código disponível no lote, calcula o desconto conforme a configuração do lote (fixo ou percentual sobre total_item) e reserva o resgate contra a transação (transactionId é o confirmToken).

Use primeiro Buscar cupom para encontrar um lote compatível com o carrinho, depois chame este endpoint com o couponBatchId escolhido. Liquide o cupom com Liquidar cupom após a confirmação do pedido.

Campos monetários (total_item) são enviados como inteiros em centavos — veja Valores monetários.

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
transactionId * string ID da transação — o `confirmToken` da predição a que a reserva será vinculada.

Corpo da requisição

Content-Type: application/json

{
    "couponBatchId": 123,
    "interface": "generic",
    "storeId": "2",
    "clientId": 123,
    "total_item": 96390                                         // cents
}

Respostas

Copied to clipboard