WebAPI - Consulta (Pedido, Itens, Fretes, Pagamentos e Cashback)

Este tutorial irá auxiliar na realização no desenvolvimento da integração com um serviço promocional externo através da nossa WebAPI de Fidelidade, o mesmo prevê a Consulta de benefícios para Pedidos, Itens, Meios de Entrega e Meios de Pagamento através da WebAPI, bem como a obtenção de verificação (consulta) do saldo Cashback no respectivo carrinho (pedido).

Abaixo será possível verificar os exemplo de Consulta (geral ou informando o Id da promoção) que o lojista deverá realizar entre o front de loja ao back (via Store Front - WebAPI) para obter os benefícios promocionais para um determinado um Pedido, Item do Pedido, Meios de Entrega, Meios de Pagamento ou até mesmo para consulta do saldo Cashback de um determinado pedido (carrinho):

Para que o front (WebAPI) de loja realize uma consulta no back-end (API), é possível se guiar no exemplo de consulta abaixo: 

GetBenefits (consulta):

$.ajax({
    type: 'POST',
    url: 'http://localhost:42555/carrinho/Benefits',
    contentType: 'application/json',
    success: function(response) {
        console.log('Requisição bem-sucedida:', response);
    },
    error: function(error) {
        console.error('Erro na requisição:', error);
    }
});

Para que o front (WebAPI) de loja realize uma consulta no back-end (API) informando um id de promoção específico, é possível se guiar no exemplo de consulta abaixo:

GetBenefitsWithPromotionId (consulta):

var endpoint = 'http://localhost:42555/carrinho/Benefits';
var promotionData =
{
    "PromotionID": 6129,    
};

$.ajax({
    type: 'POST',
    url: endpoint,
    data: JSON.stringify(promotionData),
    contentType: 'application/json',
    success: function(response) {
        console.log('Requisição bem-sucedida:', response);
    },
    error: function(error) {
        console.error('Erro na requisição:', error);
    }
});

Abaixo há o exemplo de retorno das consultas (geral ou informando o Id da promoção) que o parceiro irá retornar ao front do cliente (Store Front) através da API, de modo que o lojista realize o devido tratamento dos dados, podendo desta maneira manusear benefícios de um Pedido, Item do Pedido, Meios de Entrega, Meios de Pagamento ou para o Cashback, mas sempre para um carrinho (pedido) específico:

ResponseBenefits (retorno da consulta):

[
    {
        "Benefits": {
            "Cashback": {
                "BalanceAmount": 242.04
            },
            "DeliveryDiscounts": [
                {
                    "ActivationQty": 0,
                    "CalculationBasisType": "O",
                    "DeliveryMethods": [
                        {
                            "Alias": "fe_offline",
                            "DeliveryAmount": 62.43,
                            "DeliveryMethodID": "25",
                            "DeliveryName": "Entrega própria"
                        }
                    ],
                    "DiscountPercent": 5,
                    "DiscountType": "P",
                    "DiscountValue": 0,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "CUPOM123",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-delivery-coupon",
                    "ExternalPromotionName": "Desconto de 10% em todos os itens - V",
                    "ExternalPromotionTargetID": 2,
                    "ExternalPromotionType": 0,
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                },
                {
                    "ActivationQty": 0,
                    "CalculationBasisType": "O",
                    "DeliveryMethods": [
                        {
                            "Alias": "fe_offline",
                            "DeliveryAmount": 62.43,
                            "DeliveryMethodID": "25",
                            "DeliveryName": "Entrega própria"
                        }
                    ],
                    "DiscountPercent": 0,
                    "DiscountType": "V",
                    "DiscountValue": 10,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-delivery-discount",
                    "ExternalPromotionName": "Desconto de 10 reais em todos os itens",
                    "ExternalPromotionTargetID": 2,
                    "ExternalPromotionType": 1,
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                },
                {
                    "ActivationQty": 2,
                    "CalculationBasisType": "D",
                    "DeliveryMethods": [
                        {
                            "Alias": "fe_offline",
                            "DeliveryAmount": 62.43,
                            "DeliveryMethodID": "25",
                            "DeliveryName": "Entrega própria"
                        }
                    ],
                    "DiscountPercent": 5,
                    "DiscountType": "P",
                    "DiscountValue": 0,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-delivery-promotion",
                    "ExternalPromotionName": "Desconto de 10% em todos os itens - Valor descontado",
                    "ExternalPromotionTargetID": 2,
                    "ExternalPromotionType": 2,
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                }
            ],
            "ItemsDiscounts": [
                {
                    "ActivationQty": 0,
                    "CalculationBasisType": "O",
                    "DiscountPercent": 5,
                    "DiscountType": "P",
                    "DiscountValue": 0,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "CUPOM123",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-item-coupon",
                    "ExternalPromotionName": "Desconto de 10% em todos os itens - V",
                    "ExternalPromotionTargetID": 0,
                    "ExternalPromotionType": 0,
                    "Items": [
                        {
                            "BasketItemID": 71577,
                            "Brand": "5 Estrelas",
                            "Categories": "Esporte e Lazer/Fitness",
                            "IntegrationID": "TESTE-REPLICAÇÃOO",
                            "Price": 500,
                            "ProductID": 984994,
                            "ProductName": "Camera Fotográfica Canon - teste 1",
                            "Quantity": 5,
                            "SkuID": 984995,
                            "SpecialType": "N"
                        },
                        {
                            "BasketItemID": 71578,
                            "Brand": "Padrão",
                            "Categories": "Musical",
                            "IntegrationID": "",
                            "Price": 10,
                            "ProductID": 985094,
                            "ProductName": "Produto sem Estoque e sem Avaliações",
                            "Quantity": 1,
                            "SkuID": 985095,
                            "SpecialType": "N"
                        }
                    ],
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                },
                {
                    "ActivationQty": 0,
                    "CalculationBasisType": "O",
                    "DiscountPercent": 0,
                    "DiscountType": "V",
                    "DiscountValue": 10,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-item-discount",
                    "ExternalPromotionName": "Desconto de 10 reais em todos os itens",
                    "ExternalPromotionTargetID": 0,
                    "ExternalPromotionType": 1,
                    "Items": [
                        {
                            "BasketItemID": 71577,
                            "Brand": "5 Estrelas",
                            "Categories": "Esporte e Lazer/Fitness",
                            "IntegrationID": "TESTE-REPLICAÇÃOO",
                            "Price": 500,
                            "ProductID": 984994,
                            "ProductName": "Camera Fotográfica Canon - teste 1",
                            "Quantity": 5,
                            "SkuID": 984995,
                            "SpecialType": "N"
                        },
                        {
                            "BasketItemID": 71578,
                            "Brand": "Padrão",
                            "Categories": "Musical",
                            "IntegrationID": "",
                            "Price": 10,
                            "ProductID": 985094,
                            "ProductName": "Produto sem Estoque e sem Avaliações",
                            "Quantity": 1,
                            "SkuID": 985095,
                            "SpecialType": "N"
                        }
                    ],
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                },
                {
                    "ActivationQty": 2,
                    "CalculationBasisType": "D",
                    "DiscountPercent": 5,
                    "DiscountType": "P",
                    "DiscountValue": 0,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-item-promotion",
                    "ExternalPromotionName": "Desconto de 10% em todos os itens - Valor descontado",
                    "ExternalPromotionTargetID": 0,
                    "ExternalPromotionType": 2,
                    "Items": null,
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                }
            ],
            "OrderDiscounts": [
                {
                    "ActivationQty": 0,
                    "CalculationBasisType": "O",
                    "DiscountPercent": 5,
                    "DiscountType": "P",
                    "DiscountValue": 0,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "CUPOM123",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-order-coupon",
                    "ExternalPromotionName": "Desconto de 10% em todos os itens - V",
                    "ExternalPromotionTargetID": 1,
                    "ExternalPromotionType": 0,
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                },
                {
                    "ActivationQty": 0,
                    "CalculationBasisType": "O",
                    "DiscountPercent": 0,
                    "DiscountType": "V",
                    "DiscountValue": 10,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-order-discount",
                    "ExternalPromotionName": "Desconto de 10 reais em todos os itens",
                    "ExternalPromotionTargetID": 1,
                    "ExternalPromotionType": 1,
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                },
                {
                    "ActivationQty": 2,
                    "CalculationBasisType": "D",
                    "DiscountPercent": 5,
                    "DiscountType": "P",
                    "DiscountValue": 0,
                    "ExpiresIn": "2023-09-13T09:07:18.9601815-03:00",
                    "ExternalCouponCode": "",
                    "ExternalDescriptionRules": "Regras da promoção",
                    "ExternalPromotionID": "promo1-order-promotion",
                    "ExternalPromotionName": "Desconto de 10% em todos os itens - Valor descontado",
                    "ExternalPromotionTargetID": 1,
                    "ExternalPromotionType": 2,
                    "ShowExternalPromotionNameInStore": false,
                    "UrlImage": "https://example.com/promo1.jpg"
                }
            ],
            "PaymentDiscounts": [
                {
                    "ExternalPromotionID": "promo1-delivery-coupon",
                    "PaymentMethods": [
                        {
                            "Alias": "VISA",
                            "IntegrationID": null,
                            "InterestRate": 0,
                            "MaxInstallments": 10,
                            "MaxInstallmentsNoInterest": 10,
                            "MinInstallmentAmount": 0,
                            "PaymentMethodID": 979,
                            "PaymentType": "CreditCard"
                        },
                        {
                            "Alias": "PIX",
                            "IntegrationID": null,
                            "InterestRate": 0,
                            "MaxInstallments": 0,
                            "MaxInstallmentsNoInterest": 0,
                            "MinInstallmentAmount": 0,
                            "PaymentMethodID": 964,
                            "PaymentType": "Pix"
                        }
                    ]
                },
                {
                    "ExternalPromotionID": "promo1-item-discount",
                    "PaymentMethods": [
                        {
                            "Alias": "VISA",
                            "IntegrationID": null,
                            "InterestRate": 0,
                            "MaxInstallments": 10,
                            "MaxInstallmentsNoInterest": 10,
                            "MinInstallmentAmount": 0,
                            "PaymentMethodID": 979,
                            "PaymentType": "CreditCard"
                        },
                        {
                            "Alias": "PIX",
                            "IntegrationID": null,
                            "InterestRate": 0,
                            "MaxInstallments": 0,
                            "MaxInstallmentsNoInterest": 0,
                            "MinInstallmentAmount": 0,
                            "PaymentMethodID": 964,
                            "PaymentType": "Pix"
                        }
                    ]
                },
                {
                    "ExternalPromotionID": "promo1-order-discount",
                    "PaymentMethods": [
                        {
                            "Alias": "VISA",
                            "IntegrationID": null,
                            "InterestRate": 0,
                            "MaxInstallments": 10,
                            "MaxInstallmentsNoInterest": 10,
                            "MinInstallmentAmount": 0,
                            "PaymentMethodID": 979,
                            "PaymentType": "CreditCard"
                        },
                        {
                            "Alias": "PIX",
                            "IntegrationID": null,
                            "InterestRate": 0,
                            "MaxInstallments": 0,
                            "MaxInstallmentsNoInterest": 0,
                            "MinInstallmentAmount": 0,
                            "PaymentMethodID": 964,
                            "PaymentType": "Pix"
                        }
                    ]
                }
            ]
        },
        "BenefitsErrors": [],
        "Transaction": {
            "BasketID": 33369,
            "PromotionDocumentNumber": null,
            "PromotionID": 6129,
            "PromotionName": "Benefício Externo",
            "SessionID": "nq3uxsd2ofkfs1sp1mbx3gmv",
            "ShopperTicketID": "e784f4c0-9a00-46bd-94a5-99f8a376e189",
            "Source": "Loja"
        }
    }
]

Nossa Collection no Postman com todas as chamadas necessárias para lhe auxiliar nesta jornada estão disponíveis pelo arquivo abaixo:

Benefits.postman_collection_v2 (6).json

Para eventuais dúvidas, nosso time de relacionamento ao cliente estará 100% a disposição para lhe auxiliar tanto no processo de configuração quanto as dúvidas que surgirem durante a utilização da nova funcionalidade.