Entrar

Cancelación parcial

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

Cancela ítems específicos de una transacción ya confirmada. Devuelve el canje (cashback) que debe reembolsarse al cliente y revierte la acumulación (cashback) generada para esos ítems.

Los ítems se identifican por id (SKU) y, cuando hace falta, por price — nunca por la posición del ítem dentro de la petición. Cuando el mismo id aparece en más de una línea del pedido:

  • Todas las líneas tienen el mismo precio unitario — price es opcional. Las líneas se consumen en el orden en que se enviaron en rewardByOrder, así que cancelar una unidad toma la primera línea que aún tenga cantidad sin cancelar. Como las líneas son equivalentes, el reembolso es el mismo sin importar cuál se elija.
  • Las líneas tienen precios unitarios distintos — price pasa a ser obligatorio. Sin ese dato la petición falla con 409 en lugar de adivinar una línea, porque cancelar la línea equivocada reembolsaría un monto incorrecto.

Reenviar todos los ítems de la compra original sigue siendo lo más seguro.

Try-it values populated from environment ACME (Demo)


Autenticación

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.

Encabezados

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 de ruta

Name Type Description
TID * string ID de la transacción (el `confirmToken` de la confirmación original).

Cuerpo de la petición

Content-Type: application/json

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

Respuestas

{
    "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