Entrar

Reservar cupón

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

Reserva un código de cupón de un lote (couponBatchId) para una transacción específica. Selecciona un código disponible en el lote, calcula el descuento según la configuración del lote (fijo o porcentual sobre total_item) y reserva el canje contra la transacción (transactionId es el confirmToken).

Usa primero Buscar cupón para encontrar un lote compatible con el carrito, luego llama a este endpoint con el couponBatchId elegido. Liquida el cupón con Liquidar cupón después de confirmar el pedido.

Los campos monetarios (total_item) se envían como enteros en centavos — véase Valores monetarios.

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
transactionId * string ID de la transacción — el `confirmToken` de la predicción a la que se vincula la reserva.

Cuerpo de la petición

Content-Type: application/json

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

Respuestas

Copied to clipboard