Entrar

Acúmulo por pedido

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

Calcula o cashback que um determinado pedido pode acumular. Este endpoint opera em dois modos: Privado e Público. Escolha o modo conforme o seu caso de uso abaixo.

Try-it values populated from environment ACME (Demo)

Modes

Retorna dados do cliente, informações de resgate disponível e um token de confirmação que pode ser usado depois no confirmOrder. Exige um token de usuário válido.

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.

Corpo da requisição

Content-Type: application/json

{
    "interface": "generic",
    "storeId": "1",
    "checkoutId": "ck_demo_a1b2-c3d4",                          // optional
    "purchaseType": "delivery",                                 // optional
    "client": {                                                 // optional
        "id": "123123",                                         // optional
        "name": "Tintim",                                       // optional
        "document": "32165987",                                 // optional
        "email": "tintim@guper.co",                             // optional
        "countryCallingCode": 55,                               // optional
        "cellphone": "19954264546"                              // optional
    },
    "attendants": {                                             // optional
        "cashier": {                                            // optional
            "id": "123"
        },
        "salesperson": {                                        // optional
            "id": "342"
        }
    },
    "items": [
        {
            "id": "1",                                          // SKU id
            "productId": "1",                                   // optional
            "name": "Smartphone Guper MK1",
            "categoryId": "20",                                 // optional
            "brandId": "20",                                    // optional
            "sellerId": "1",                                    // optional
            "tax": 1232,                                        // optional, cents
            "quantity": 1,                                      // int ≥ 1
            "price": 96390,                                     // cents
            "listPrice": 100000                                 // optional, cents
        }
    ],
    "shipping": [                                               // optional
        {
            "id": "AA123456785BR",
            "courierId": "correios-br",
            "courierName": "Correios",
            "price": 2000,                                      // cents
            "listPrice": 2000                                   // optional, cents
        }
    ]
}

Respostas

{
    "organization": "acme",
    "interface": "generic",
    "customerId": 708,
    "cashback": {
        "thisOrder": {
            "redeemable": {
                "total": 522,
                "item": [{ "id": "1", "value": 522 }]
            },
            "accumulating": {
                "total": 4819,
                "item": [{ "id": "1", "value": 4819 }]
            }
        },
        "userBalance": { "total": 0, "availableAmount": 0 }
    },
    "confirmToken": "54eb6281f4e3e13671a5e4c95609f4a69247a5f38d01bef99768399bb6645c49",
    "smartpos": "https://acme.myguper.com/smartpos/54eb6281f4e3e13671a5e4c95609f4a69247a5f38d01bef99768399bb6645c49",
    "expiresAt": "2024-05-21T11:21:27-03:00",
    "dateTime": "2024-05-21T10:51:27-03:00"
}

Notas

Resgate barrado pela regra da carteira. Quando a carteira tem mínimo dinâmico (minOrderRate), o saldo do cliente só pode ser usado se o pedido valer N vezes esse saldo — 3 com saldo de R$ 30,00 exige uma compra de R$ 90,00. É tudo-ou-nada: abaixo disso não resgata nada, nem parte.

Nesse caso redeemable.total volta 0 e redeemable.blocked diz o porquê:

"redeemable": {
    "total": 0,
    "item": [],
    "blocked": [
        {
            "wallet": 60,
            "reason": "minOrderRate",
            "rate": 3,
            "balance": 3000,
            "required": 9000,
            "missing": 1500
        }
    ]
}

wallet é o id da política, rate o multiplicador, balance o saldo considerado, required quanto o pedido precisaria valer e missing o que falta (required − total do pedido). Valores em centavos.

O saldo continua intacto — userBalance segue mostrando ele, e o mesmo cliente resgata normalmente num carrinho maior. Mostre o missing: "faltam R$ 15,00 para usar seu saldo". O mesmo bloco aparece em Atualizar transação, que reaplica a regra quando o carrinho muda.

Copied to clipboard