Documentação Custom v2 Api - SAK

Introdução

Seja bem-vindo(a) a documentação da API Custom.
Através dessa API REST você conseguirá trazer seus carrinhos abandonados e pedidos de qualquer plataforma para dentro do nosso ambiente.

Endpoint API

Na configuração da integração você deve colocar o endereço da API onde os dados serão buscados, exemplo : https://api.seu_site.com/checkouts

Nesta requisição enviamos alguns parâmetros via GET como:

token Token da integração para validar na plataforma
created_at_min Data inicial da busca
created_at_max Data final da busca
type Tipo: pedidos ou carrinho abandonado ('orders' ou 'checkouts')
limit Limite por página
page Número da página
Endpoint Webhook

Cada usuário terá o seu URL de endpoint para fazer a integração dos dados.

Exemplo Pedidos: https://app.sak.com.br/Webhook/get/custom/XXX/orders/create

Exemplo Checkouts: https://app.sak.com.br/Webhook/get/custom/XXX/checkouts/create

Integração dos dados

A seguir segue o formato (JSON) que você deverá enviar para o Endpoint, e assim gravar os dados em nosso sistema.

Formato de Carrinho Abandonado
{ "api_token":"token123", "count":500, "max_limit":100, "limit":25, "page":1, "order":[{ "id":123321, "checkout_token":"GISAGI123321", "created_at":"2019-10-29T20:17:05Z", "checkout_url":"https://www.seu_site.com.br/checkout/123", "total": 54.60 "customer":{ "name":"João da Silva", "email":"joao@gmail.com", "phone_number":+5511987654321, "address_city":"São Paulo", "address_state":"SP", }, "products":{ { "id":12345, "name":"Produto 1", "price":10.20, "qty":1, "image":"https://www.seu_site.com.br/produto-1/produto.jpg" }, { "id":15145627779138, "name":"Produto 2", "cost":22.20, "qty":2, "image":"https://www.seu_site.com.br/produto-2/produto.jpg" } } }] }
Descrição dos dados
POST https://app.sak.com.br/Webhook/get/xxx/XXX/checkouts/create

Parâmetro Tipo Obrigatório Descrição
api_token string sim Token fornecido na integração whatsApp2
count int não Total de resultados
max_limit int não Limite máximo de dados
limit int não Limite por página
page int não Número da página
order array sim Objeto do dado do checkout
order.id int sim Id do checkout
created_at string sim Data e hora da criação do pedido
order.checkout_url string sim URL do carrinho do checkout
order.total float sim Valor total do checkout
order.customer array sim Objeto dos dados do comprador
order.customer.name string sim Nome do comprador
order.customer.email string não E-mail do comprador
order.customer.phone_number string sim Telefone do comprador (DDD+telefone) somente números
order.customer.address_city string não Cidade do endereço do comprador
order.customer.address_state string não Estado do endereço do comprador
order.products array sim Objeto dos produtos
order.products.id int sim Id do produto
order.products.name string sim Nome do produto
order.products.price float sim Valor do produto
order.products.qty int sim Quantidade do produto
order.products.image string sim Imagem do produto

Formato de Pedidos
{ "api_token":"token123", "count":500, "limit":100, "order":[{ "id":123321, "checkout_token":"GISAGI123321", "status":"(pending, order_cancelled, voided, paid)", "billet_url":"https://www.seu_site.com.br/order/billet/123", "codigo_barras":"999999 9 999999 9 9999999 9999999", "link_pix":"link do qrcode do pix", "payment_type":"(boleto, credit_card)", "gateway":"mercado_pago" "checkout_url":"https://www.seu_site.com.br/checkout/123", "tracking_numbers":["L97654321"], "total": 54.60, "created_at":"2019-10-29T20:17:05Z", "updated_at":"2019-10-29T20:17:05Z" "customer":{ "name":"João da Silva", "email":"joao@gmail.com", "doc":12345678910, "phone_number":+5511987654321, "address":"Av. Paulista", "address_number":1000, "address_comp":"Perto do Masp", "address_district":"Bela Vista", "address_city":"São Paulo", "address_state":"SP", "address_country":"Brasil", "address_zip_code":01310200 }, "products":{[ { "id":12345, "name":"Produto 1", "price":10.20, "qty":1, "image":"https://www.seu_site.com.br/produto-1/produto.jpg" }, { "id":15145627779138, "name":"Produto 2", "cost":22.20, "qty":2, "image":"https://www.seu_site.com.br/produto-2/produto.jpg" } ]} }] }
Descrição dos dados
POST https://app.sak.com.br/Webhook/get/xxx/XXX/orders/create

Parâmetro Tipo Obrigatório Descrição
count int não Total de resultados
max_limit int não Limite máximo de dados
limit int não Limite por página
page int não Número da página
api_token string sim Token fornecido na integração whatsApp2
order array sim Objeto do dado do pedido
order.id int sim Id do pedido
order.status string sim Status de pagamento:
pending - Pendente
paid - Pago
voided - Recusado
order_cancelled - Cancelado
order.billet_url string não URL do Boleto
order.codigo_barras string não Linha digitável do Boleto (código de barras)
order.link_pix string não Link do QRcode do pix
order.payment_type string sim Forma de pagamento (boleto ou credit_card)
order.gateway string sim Gateway de Pagamento: moip, mercado_pago, pagseguro, etc
order.checkout_url string sim URL do carrinho do pedido
order.tracking_numbers array não Código de Rastreio
order.total float sim Valor total do pedido
created_at string sim Data e hora da criação do pedido
updated_at string sim Data e hora da alteração do pedido
order.customer array sim Objeto dos dados do comprador
order.customer.name string sim Nome do comprador
order.customer.email string sim E-mail do comprador
order.customer.doc string sim Documento do comprador
order.customer.phone_number string sim Telefone do comprador (DDD+telefone) somente números
order.customer.address string não Endereço do comprador
order.customer.address_number int não Número do endereço do comprador
order.customer.address_comp string não Complemento do endereço do comprador
order.customer.address_district string não Bairro do endereço do comprador
order.customer.address_city string sim Cidade do endereço do comprador
order.customer.address_state string sim Estado do endereço do comprador
order.customer.address_country string sim País do endereço do comprador
order.customer.address_zip_code int não CEP do endereço do comprador
order.products array sim Objeto dos produtos
order.products.id int sim Id do produto
order.products.name string sim Nome do produto
order.products.price float sim Valor do produto
order.products.qty int sim Quantidade do produto
order.products.image string sim Imagem do produto