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ê o Dicionário de Dados da WebAPI que conectará o front-end ao back-end e API que conectará o back-end ao serviço externo promocional, de modo que é possível saber todas as Propriedades do projeto, bem como seus respectivos Tipos, Descrições e Observações.
Abaixo a tabela de dados:
Propriedade: | Tipo: | Descrição: | Observações: |
CreatedDate | Datetime | Data de criação da requisição | |
| SessionID | String | Sessão do cliente (consumidor) que está navegando na loja para rastreabilidade | Obrigatório |
| ShopperTicketID | String | ShopperTicketID do cliente (consumidor) que está navegando na loja para rastreabilidade | |
| BasketID | Int | Id da basket (carrinho) para rastreabilidade | |
| Source | String | Nome do canal (ex: Reshop) | |
| PromotionID | Int | Id da promoção cadastrada no Admin | Obrigatório |
| PromotionName | String | Nome da promoção cadastrada no Admin | |
| PromotionDocumentNumber | String | CNPJ do intermediador da promoção | |
| CustomerID | Int | Id do cliente (consumidor) que está navegando na loja | |
| Cpf | String | CPF do cliente (consumidor), deve ser informado na busca do benefício caso o mesmo não esteja logado | Necessário quando o cliente (consumidor) não estiver logado e queira realizar uma busca de benefícios por item |
| Rg | String | RG do cliente (consumidor) | |
| String | E-mail do cliente (consumidor) | ||
| CellPhone | String | Celular do cliente (consumidor) | |
| Birthday | Date | Data de aniversário do cliente (consumidor), ISO 8601 | |
| DeliveryRegion | - - - | Estado e CEP definidos no cadastro do cliente (consumidor) | |
| UF | String | Estado da entrega definido no cadastro do cliente (consumidor) | |
| Cep | String | Cep da entrega definido no cadastrado do cliente (consumidor) | |
| BasketItemID | Int | Id do item da basket que irá receber o desconto | |
| Name | String | Nome do produto | |
| ProductID | Int | Id do produto | Obrigatório para busca por item e quando for aplicar um desconto em item Obrigatório na aplicação por item |
| SkuId | Int | Id do sku | Obrigatório na aplicação por item |
| IntegrationID | String | Id de integração | |
| Quantity | Int | Quantidade do produto no carrinho | Obrigatório na aplicação de benefícios por item |
| Price | Decimal(2) | Preço do item na basket | |
| SpecialType | Char | No = 'N', Warranty = 'W'(Garantia), Gift = 'G'(Brinde), Wrap = 'P'(Embalagem), Service = 'S'(Serviço adicional), Custom = 'C', GiftCertificate = 'T', | |
| Brand | String | Marca do item | |
| Categories | String | Categorias | |
| DeliveryMethodID | String | Id do meio de entrega | Obrigatório na aplicação de benefícios em frete |
| DeliveryAmount | Decimal(2) | Valor do meio de entrega | |
| DeliveryName | String | Nome do meio de entrega | |
| Alias | String | Alias do meio de entrega | |
| PaymentMethodID | Int | Id do meio de pagamento | |
| PaymentType | String | Tipo do meio de pagamento CreditCard, Pix, PaymentSlip etc... | |
| IntegrationID | String | Código de integração configurado no meio de pagamento | |
| Alias | String | Alias do meio de pagamento. Exemplo: Visa, mastercard, picpay, santander, mercadopago etc... | |
| MinInstallmentAmount | Int | Valor mínimo das parcelas | |
| MaxInstallments | Int | Valor máximo das parcelas | |
| MaxInstallmentsNoInterest | Int | Valor máximo das parcelas sem juros | |
| InterestRate | Decimal(2) | Taxa de juros | |
| SubTotal | Decimal(2) | Somatório dos itens do carrinho | |
| Total | Decimal(2) | SubTotal + DeliveryAmount - DiscountAmount - PaymentAmount(Gift) - LoyaltyCardAmount | |
| PromotionID | Int | Id da promoção cadastrada no Admin | Obrigatório na aplicação de benefício |
| PromotionName | String | Nome da promoção cadastrada no Admin | |
| PromotionDocumentNumber | String | CNPJ do intermediador da promoção | |
| Benefits | - - - | Array de benefícios retornados pela promoção | |
| BenefitType | Int | Tipo de benefício: 0 = item, 1= order, 2 = Delivery | Obrigatório na aplicação do benefício |
| BenefitValue | Decimal(2) | Valor do benefício | Obrigatório na aplicação do benefício |
| BenefitPercent | Decimal(2) | Percentual do benefício | Obrigatório na aplicação do benefício |
| ExternalPromotionID | String | Identificador retornado pela integração para retornarmos ao parceiro informando que usamos determinado benefício | Obrigatório na aplicação do benefício |
| ExternalPromotionTargetID | Int | Informa aonde será aplicado o benefício 0 = item, 1= order, 2 = Delivery | Obrigatório na aplicação do benefício |
| ExternalPromotionType | Int | Informa o tipo de promoção: 0 = coupon, 1 = discount, 2 = promotion | Obrigatório na aplicação do benefício |
| ExternalNamePromotion | String | Exemplo: cupom-boas-vindas de 10% em todos skus da loja | |
| ShowExternalPromotionNameInStore | String | Quando enviado será exibido o nome da promoção na loja | |
| ExternalCouponCode | String | Código do cupom caso a promoção seja acionada por cupom | |
| ExternalDescriptionRules | String | Descrição das regras | |
| ActivationQty | Int | Quantidade para acionar uma promoção | |
| DiscountType | String | Percentage = 'P' ou Value = 'V' | Obrigatório na aplicação do benefício |
| CalculationBasisType | String | Valor original= OriginalAmount = 'O' ou Valor descontado= DiscountedAmount = 'D' | Obrigatório na aplicação do benefício |
| ExpiresIn | Datetime | Data e hora que expira a promoção | |
| UrlImage | String | Url de divulgação da promoção | |
| Message | String | Mensagem para ser exibido no front | |
| BalanceAmount | Decimal(2) | Saldo de cashback para utilização no pedido | |
| Amount | Decimal(2) | Valor do cashback que será aplicado | Obrigatório na aplicação do benefício |
| OrderID | String | ID do Pedido que foi aplicado a promoção externa | |
| CreatedDate | Datetime | Data e hora de criação do pedido | |
| Status | Int | 0 - Criação do pedido em andamento 1 - Pedido criado 2 - Pedido pago 3 - Pedido cancelado | |
| ModifiedDate | DateTime | Data e hora da última alteração no pedido | |
| Key | String | Chave que identifica o tipo de erro | Caso o parceiro queira retornar um erro personalizado para exibir no front, pode usar esse objeto |
| ErrorMessage | String | Mensagem de erro | |
| ErrorCode | String | Código de erro | |
| ExternalPromotionIDs | String | Benefícios utilizados no pedido | |
| BenefitsAction | Int | RemoveItemDiscount = 0, RemoveOrderDiscount = 1, RemoveDeliveryDiscount = 2, RemoveCashbackPayment = 3, RemoveAllDiscountsByExternalPromotionID = 4, RemoveAllDiscountsByExternalExternalCouponCode = 5 |
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.