Entrar

Cancelamento parcial

POST https://{organization}.myguper.com/api/loyalty/cancelPartial/{TID}

Cancela itens específicos de uma transação já confirmada. Retorna o resgate (cashback) que deve ser estornado para o cliente e reverte o acúmulo (cashback) gerado para esses itens.

Os itens são identificados por id (SKU) e, quando necessário, por price — nunca pela posição do item dentro da requisição. Quando o mesmo id aparece em mais de uma linha do pedido:

  • Todas as linhas têm o mesmo preço unitário — price é opcional. As linhas são consumidas na ordem em que foram enviadas no rewardByOrder, então cancelar uma unidade pega a primeira linha que ainda tenha quantidade não cancelada. Como as linhas são equivalentes, o estorno é o mesmo qualquer que seja a escolhida.
  • As linhas têm preços unitários diferentes — price passa a ser obrigatório. Sem esse dado a requisição falha com 409 em vez de adivinhar uma linha, porque cancelar a linha errada estornaria o valor incorreto.

Reenviar todos os itens da compra original continua sendo o caminho mais seguro.

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
TID * string ID da transação (o `confirmToken` da confirmação original).

Corpo da requisição

Content-Type: application/json

{
    "items": [
        {
            "id": "1",
            "quantity": 1,                                      // optional
            "price": 96390                                      // optional, cents
        }
    ]
}

Respostas

{
    "TID": "6ea795c61088f27baa304d3dce8e4e7a85b99f78378d1101dbfc82864759e798",
    "redemption": [
        { "cardId": 331467, "value": "949" },
        { "cardId": 331471, "value": "1748" },
        { "cardId": 331486, "value": "3432" }
    ],
    "reward": [
        { "cardId": 331532, "value": 1601 },
        { "cardId": 331533, "value": 6574 }
    ]
}

Relacionados

Copied to clipboard