Overview
Visando adequar todas as nossas APIs, onde atualmente já temos um método para recuperar carrinhos (basket) via WebAPI do Commerce, através da implementação feita agora, implementamos um método de carrinhos abandonados via Layer.
Possibilitando aos nossos lojistas uma melhor automação junto a integração com ferramentas de marketing, bem como de envio de e-mail marketing e outras. Trazendo maior automação e gerenciamento do nosso recuperador de carrinhos nativo da plataforma.
O novo método chama-se SearchOrdersCandidates e já está disponível para uso na Layer! :)
Dicionário de Dados:
Abaixo nosso dicionário de dados para que você monte suas consultas na Layer usando do método SearchOrdersCandidates contido dentro de Sales:
| Propriedades | Definição |
| CreatedDate | Data de Criação do carrinho |
| ModifiedDate | Data de Modificação do carrinho |
| ConvertedDate | Data de conversão (gerou pedido) do carrinho |
| Status | Descrição do status |
| OrderNumber | Número do pedido convertido |
| NotificationID | ID de recuperador de carrinho |
| OrderCandidateID | GUID do carrinho abandonado |
| WebsiteID | ID do canal de criação |
| WebSiteName | Nome do canal |
| CustomerID | ID do consumidor (cliente) |
| CustomerName | None do consumidor |
| CustomerEmail | E-mail do consumidor |
| CustomerPhone | Celular do Consumidor |
| OrderCount | Total de pedidos realizados pelo consumidor |
| CustomerGroups | ID de Grupo de Cliente do consumidor |
| BasketId | ID da basket |
| BasketTotal | Total da basket |
| BasketCount | Total de itens na basket (IDs de SKU distintos) |
| PaymentProviderID | ID do meio de pagamento selecionado |
| PaymentType | ID do tipo da forma de pagamento (cartão, boleto, pix, ect). |
| Alias (Payment.payment_methods) | Alias da forma de pagamento selecionada. Tipo GENERICEXTERNAL = nome do parceiro |
| ShippingAddressID | ID de Endereço de entrega do consumidor |
| BillingAddresID | ID de Endereço de Cobrança do Consumidor |
| PickUpStorePointOfSaleID | ID do Ponto de retirada de pedido |
| PickUpStoreContactName | Nome de quem fará a retirada |
| PickUpsToreContactDocumenterNumber | Documento de quem fará a retirada |
| PickUpStoreSellerID | Ponto de retirada de seller (caso haja relação) |
| DeliveryMethodID | ID meio de entrega selecionado |
Requests e Responses:
Para auxiliar na utilização do novo método existente na API, iremos disponibilizar abaixo alguns exemplos de consultas e retornos que poderão ser obtidos com base no dicionário mencionado anteriormente.
1. Consulta e Retorno por WebSiteId:
2. Consulta e Retorno por Status:
3. Consulta e Retorno por PaymentType:
4. Consulta e Retorno por PaymentMethodID:
5. Consulta e Retorno por OrderNumber:
6. Consulta e Retorno por OrderCandidateID:
7. Consulta e Retorno por NotificationID:
8. Consulta e Retorno por DeliveryMethodID:
9. Consulta e Retorno por CustomerId:
10. Consulta e Retorno por CustomerEmail:
11. Consulta e Retorno por CreatedDate:
12. Consulta e Retorno por ConvertedDate:
Para eventuais dúvidas, nosso suporte estará 100% a disposição para lhe auxiliar tanto no processo de utilização da nova API quanto as dúvidas que surgirem durante a utilização da nova funcionalidade.