Pedidos

Includes disponíveis: items, customer, marketplace, status, statuses, shipping_address, promocode, transactions, comments, files, discounts, seller, labels

Listar pedidos

GET https://api.dooki.com.br/v2/{alias}/orders

Visualizar pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}

{
    "status": "paid",
    "number": "22222293",
    "customer_id": 141,
    "value_total": 100,
    "value_products": 10,
    "value_shipment": 0,
    "value_discount": 0,
    "value_tax": 0,
    "days_delivery": 2,
    "items": [
        {
            "product_id": 9375,
            "sku_id": 19606,
            "quantity": 1,
            "price": 19.00,
            "sku": "10-021-Avela"
        },
        {
            "product_id": 9375,
            "sku_id": 19222,
            "quantity": 2,
            "price": 19.00,
            "sku": "10-021-Azul"
        }
    ],
    "address": [
        {
            "street": "Rua Teste",
            "number": 123,
            "neighborhood": "Centro",
            "receiver": "John Snow",
            "zipcode": 14940000,
            "city": "São Paulo",
            "uf": "SP"
        }
    ],
    "transactions": [
        {
            "customer_id": 141,
            "payment_id": 123,
            "affiliation_id": 123,
            "gateway_transaction_id": 222,
            "amount": 100.00,
            "installments": 1,
            "status": "paid",
            "holder_name": "John Snow",
            "holder_document": "000000000"
        }    
    ]
}

Criar pedido

POST https://api.dooki.com.br/v2/{alias}/orders

Request para criar um pedido

Para criar um pedido, será necessário ter um cliente pré-cadastrado.

Parâmetro	Tipo	Obrigatório	Descrição
status	string	Sim	Status do pedido. Veja os valores aceitos
number	int	Sim	Número do pedido.
customer_id	int	Sim	ID do cliente.
marketplace_id	int	Não	ID do marketplace.
value_total	float	Sim	Valor total do pedido.
value_products	float	Sim	Valor dos produtos.
value_shipment	float	Sim	Valor do frete.
value_discount	float	Sim	Valor do desconto.
value_tax	float	Não	Valor da taxa.
shipment_service	string	Sim	Método de entrega. Exemplo: pac, sedex, transportadora
days_delivery	int	Sim	Prazo (em dias) para entrega.
ip	string	Não	Número do IP do cliente.
items	array	Sim	Objeto de ítens.
items[product_id]	int	Sim	ID do produto.
items[sku_id]	int	Sim	ID do SKU.
items[quantity]	int	Sim	Quantidade comprada.
items[price]	float	Sim	Preço unitário.
items[sku]	string	Sim	Código SKU.
items[gift]	boolean	Não	Marca se o item é para presente ou não.
items[gift_value]	float	Não	Valor da embalagem de presente.
address	array	Sim	Objeto endereço de entrega.
address[street]	string	Sim	Nome da rua.
address[number]	string	Sim	Número do endereço.
address[neighborhood]	string	Sim	Bairro.
address[complement]	string	Não	Complemento.
address[reference]	string	Não	Referência.
address[zipcode]	string	Sim	CEP de entrega.
address[city]	string	Sim	Cidade de entrega.
address[uf]	string	Sim	Estado de entrega.
transactions	array	Não	Objeto de transações
transactions[customer_id]	int	Sim	ID do cliente.
transactions[payment_id]	int	Não	ID do meio de pagamento. Referências
transactions[affiliation_id]	int	Não	ID da afiliação. Referências.
transactions[gateway_transaction_id]	string	Não	ID da transação no Gateway de pagamento.
transactions[gateway_authorization_code]	string	Não	Código de autorização no Gateway de pagamento.
transactions[gateway_order_id]	string	Não	Código do pedido no Gateway de pagamento.
transactions[gateway_billet_id]	string	Não	ID do boleto no Gateway de pagamento.
transactions[amount]	float	Sim	Total cobrado na transação.
transactions[installments]	int	Sim	Número de parcelas.
transactions[status]	string	Sim	Status da transação.
transactions[holder_name]	string	Sim	Nome do pagador.
transactions[holder_document]	string	Sim	Documento do pagador.
transactions[truncated_card]	string	Não	Número truncado do cartão de crédito.
transactions[billet_url]	string	Não	URL do boleto.
transactions[billet_date]	string	Não	Data de vencimento do boleto.
transactions[antifraud_sale_id]	string	Não	Númer do pedido no antifraude.

Request para atualizar um pedido

{
    "sync_by_erp": true,
    "shipment_service": "PAC",
    "track_url": "http://www.test.com",
    "track_code": "TRACKCODE",
    "status_id": 3,
    "status_details": "Status observation."
}

Atualizar o status através de um alias

{
    "status": "paid",
}

Response de pedidos

{
    "data": [
        {
            "id": 1,
            "customer_id": 1,
            "status_id": 3,
            "promocode_id": null,
            "marketplace_id": null,
            "authorized": false,
            "sync_by_erp": false,
            "has_recomm": true,
            "delivered": false,
            "number": 48075,
            "marketplace_partner_id": null,
            "marketplace_sale_number": null,
            "value_total": 59.39,
            "value_products": 49.9,
            "value_shipment": 15.48,
            "value_tax": 0,
            "shipment_service": "INTELIPOST_CORREIOS_PAC_1",
            "shipment_quote_id": "3536091764",
            "track_code": null,
            "track_url": null,
            "days_delivery": 23,
            "date_delivery": {
                "date": "2018-01-25 00:00:00.000000",
                "timezone_type": 3,
                "timezone": "America/Sao_Paulo"
            },
            "utm_source": "facebook",
            "utm_campaign": "remarketing",
            "total_comments": 0,
            "ip": "127.0.0.1",
            "status": {
                "data": {
                    "id": 3,
                    "alias": "waiting_payment",
                    "name": "Aguardando confirmação do pagamento",
                    "description": "Aguardando confirmação de pagamento"
                }
            },
            "marketplace": {
                "data": []
            },
            "customer": {
                "data": {
                    "id": 2,
                    "marketplace_id": null,
                    "active": true,
                    "type": "f",
                    "name": "John Snow",
                    "razao_social": null,
                    "first_name": "John",
                    "last_name": "Snow",
                    "email": "[e-mail]",
                    "cnpj": null,
                    "cpf": "0000000000",
                    "phone": {
                        "area_code": "32",
                        "number": "646464654",
                        "formated_number": "(64) 6464-6464"
                    },
                    "utm_source": null,
                    "utm_campaign": null,
                    "ip": "127.0.0.1",
                }
            },
            "items": {
                "data": [
                    {
                        "id": 121745,
                        "product_id": 9373,
                        "sku_id": 19598,
                        "price_cost": 0,
                        "price": 49.9,
                        "quantity": 1,
                        "gift": false,
                        "gift_value": 0,
                        "has_recomm": 0,
                        "custom_value": null,
                        "customizations": [
                            {
                                "id": 8,
                                "name": "Primeira Letra",
                                "value": "L"
                            }
                        ],
                        "sku": {
                            "data": {
                                "id": 19598,
                                "product_id": 9373,
                                "sku": "06-011-Vermelho",
                                "erp_id": "06-011-Vermelho",
                                "blocked_sale": false,
                                "barcode": "9900000010546",
                                "title": "Cortina Riviera 2,00m x 1,70m para Varão Simples - Vermelho/Palha Vermelho",
                                "days_availability": 1,
                                "days_availability_formated": "1 dia útil",
                                "width": 23,
                                "height": 7,
                                "length": 29,
                                "weight": 0.84,
                                "quantity_managed": false,
                                "variations": [
                                    {
                                        "name": "Cor",
                                        "value": "Vermelho",
                                        "value_id": 379
                                    }
                                ],
                                "order": 0,
                                "total_in_stock": 1027,
                            }
                        }
                    }
                ]
            }
        }
    ],
    // Retorna a soma dos pedidos listados
    // e também o ticket médio
    "stats": {
        "amount": 14534.00,
        "average_ticket": 189.00
    }
}

Atualizar pedido

PUT https://api.dooki.com.br/v2/{alias}/orders/{id}

Parâmetro	Tipo	Obrigatório	Descrição
sync_by_erp	boolean	Não	Marca se o pedido foi importado pelo ERP.
delivered	boolean	Não	Marca se o pedido foi entregue.
shipment_service	string	Não	Altera o método de entrega.
track_url	string	Não	URL de rastreamento.
track_code	string	Não	Código de rastreamento.
status_id	int	Não	Status do pedido. Veja os valores aceitos.
status	string	Não	Alias do status status do pedido. Veja os valores aceitos.
status_details	string	Não	Alguma observação para anexar ao status.

Atualizar informações de boleto

PUT http://api.dooki.com.br/v2/:alias/orders/:id/billet

Headers

Name	Type	Description
Authorization	string	Token de autenticação

Request Body

Name	Type	Description
gateway_transaction_id	string	ID da transação gerada pelo gateway
billet_date	string	Data de vencimento do boleto, formato Y-m-d
billet_url	string	Url do boleto
billet_barcode	string	Código de barras do boleto

200

{
    // Payload de busca de um pedido
}

Atualizar o endereço de entrega do pedido:

PUT https://api.dooki.com.br/v2/{alias}/orders/{id}/addresses/{addressId}

Parâmetro	Tipo	Obrigatório	Descrição
receiver	boolean	Não	Marca se o pedido foi entregue.
reference	string	Não	Referência.
street	string	Sim	Nome da rua do endereço.
number	string	Sim	Número do endereço.
neighborhood	string	Sim	Bairro do endereço.
complement	string	Não	Complemento do endereço.
city	string	Sim	Nome da cidade.
uf	string	Sim	UF do estado.

Filtros personalizados

Parâmetro	Tipo	Descrição
status_id	array	Retorna que possuem os status informados. Exemplo: /orders?status_id[]=3&status_id=4
q	string	Busca pedidos pelo número, código de rastreio, nome do cliente, CPF/CNPJ do cliente, e-mail do cliente e pelo ID da transação no Gateway de pagamentos
channel	string	Pedidos por canal de venda. Valores aceitos: store ou marketplace
affiliation_id	array	Retorna pedidos realizados em afiliações específicas
utm_campaing	array	Pedidos filtrados por utm_campaign
utm_source	array	Pedidos filtrados por utm_source
product_id	array	Pedidos filtrados por produtos específicos
promocode_id	array	Pedidos filtrados por cupons de desconto especificos

Listar filtros de busca

GET https://api.dooki.com.br/v2/{alias}/orders/filters

Listar produtos de um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/items

Listar transações de um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/transactions

Listar histórico de status de um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/statuses

Listar embalagens de um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/boxes

Exportar pedidos

GET https://api.dooki.com.br/v2/{alias}/orders/export

Dica: os filtros de busca também estão disponíveis no endpoint de exportação.

O sistema enviará para o usuário um e-mail com o link para download da planilha com os registros.

Gerar declaração de conteúdo de um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/content-statement?token={token_de_autenticação}

Exportar pedidos para um determinado serviço

GET https://api.dooki.com.br/v2/{alias}/orders/export/{service}

Etiquetas de entrega

Listar etiquetas de um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/labels

Criar etiqueta

POST https://api.dooki.com.br/v2/{alias}/orders/{id}/labels

Request para criar uma etiqueta

{
    "code": "123123123132",
    "tracking_code": "P182371823713BR",
    "tracking_url": "https://url.com/P182371823713BR",
    "shipping_service": "pac",
    "file_url": "https://url.com/label.pdf"
}

Parâmetro	Tipo	Obrigatório	Descrição
shipping_service	string	Não	Nome do serviço de entrega.
code	string	Não	Código da etiqueta.
tracking_code	string	Não	Código de rastreamento da etiqueta.
tracking_url	string	Não	URL de rastreamento.
file_url	string	Sim	URL do arquivo da etiqueta.

Atualizar etiqueta

PUT https://api.dooki.com.br/v2/{alias}/orders/{id}/labels/{labelId}

Excluir etiqueta

DELETE https://api.dooki.com.br/v2/{alias}/orders/{id}/labels/{labelId}

Comentários de um pedido

Listar comentários

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/comments

Criar um comentário

POST https://api.dooki.com.br/v2/{alias}/orders/{id}/comments

Request para incluir um comentário

{
    "comments": "A comment test."
}

Response de comentários de pedido

{
    "data": [
        "id": 9908,
        "user_id": 1,
        "comments": "A comment test.",
        "edited": false,
        "user": {
            "data": {
                "id": 1,
                "active": true,
                "name": "John Snow",
                "email": "[e-mail]",
                "avatar_url": "https://secure.gravatar.com/avatar/c873ba11b62067c4bf74b6ac3b97a980?s=80&r=g&d=identicon",
            }
        }
    ]
}

Parâmetro	Tipo	Obrigatório	Descrição
comments	string	Sim	Conteúdo do comentário.

Visualizar um comentário

GET https://api.dooki.com.br/v2/{alias}/orders/{orderId}/comments/{id}

Atualizar um comentário

PUT https://api.dooki.com.br/v2/{alias}/orders/{orderId}/comments/{id}

Excluir um comentário

DELETE https://api.dooki.com.br/v2/{alias}/orders/{orderId}/comments/{id}

Nota fiscal de um pedido

Listar nota fiscal

GET https://api.dooki.com.br/v2/{alias}/orders/{orderId}/invoices

Criar uma nota fiscal

POST https://api.dooki.com.br/v2/{alias}/orders/{id}/invoices

Request para incluir uma nota fiscal

{
    "series": "000",
    "number": "000",
    "key": "000",
    "date": "2018-01-01",
    "value": 100.00,
    "products_value": 80.00,
    "cfop": "cfop",
    "url": "http://url.com",
    "force_invoiced_status": true
}

Response de nota fiscal

{
    "data": [
        "id": 1,
        "series": "000",
        "number": "000",
        "key": "000",
        "date": {
            "date": "2018-01-01 00:00:00.000000",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
        },
        "value": null,
        "products_value": null,
        "cpfop": null,
        "url": null,
    ]
}

Parâmetro	Tipo	Obrigatório	Descrição
series	string	Não	Número de série da nota.
key	string	Não	Chave da nota.
number	string	Sim	Número da nota.
date	date	Sim	Data da nota.
value	float	Sim	Valor da nota.
products_value	float	Sim	Valor dos produtos da nota.
url	string	Não	URL da nota.
force_invoiced_status	boolean	Não	Marca se o status do pedido será marcado como invoiced

Atualizar uma nota fiscal

PUT https://api.dooki.com.br/v2/{alias}/orders/{orderId}/invoices/{id}

Excluir uma nota fiscal

DELETE https://api.dooki.com.br/v2/{alias}/orders/{orderId}/invoices/{id}

Rastreamento de um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/tracking

Response de tracking de pedido

{
    "data": [
        {
            "id": 38033,
            "status": "Objeto postado após o horário limite da agência",
            "locale": "Local: AGF PRUDENTE DE MORAES - IBITINGA/SP",
            "date": {
                "date": "2017-12-19 18:48:00.000000",
                "timezone_type": 3,
                "timezone": "America/Sao_Paulo"
            },
        },
        {
            "id": 38056,
            "status": "Objeto encaminhado ",
            "locale": "AGF PRUDENTE DE MORAES - IBITINGA/SP",
            "date": {
                "date": "2017-12-19 20:34:00.000000",
                "timezone_type": 3,
                "timezone": "America/Sao_Paulo"
            },
        },
    ],
}

Criar status de rastreamento

POST https://api.dooki.com.br/v2/{alias}/orders/{id}/tracking

Request para criar status de rastreamento

{
    "status": "Em transporte",
    "date": "2018-02-18 08:00:00",
    "locale": "CD São Paulo",
    "delivered": true,
    "notify_customer": true,
}

Parâmetro	Tipo	Obrigatório	Descrição
status	string	Sim	Nome do status. Exemplo: "Em trânsito"
date	datetime	Sim	Data do evento.
locale	string	Sim	Descrição do local do evento. Exemplo: "CD São Paulo"
delivered	boolean	Sim	Marca se o status é considerado como Entregue ao destinatário.
notify_customer	boolean	Não	Informa se o cliente será notificado sobre este novo status.

Consultar anti-fraude para um pedido

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/antifraud

Ao consultar o anti-fraude, a API retornará uma chave com os serviços que o cliente possui integração e o HTML do formulário que deverá ser renderizado e enviado em sua aplicação.

Response de consulta de anti-fraude

{
    "data": [
        "clearsale_form" {
            "name": "Clearsale Form",
            "output": "<html>...</html>"
        }
    ]
}

E-mails de um pedido

Listar e-mails

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/emails

Response de e-mails

{
    "data": [
        {
            "id": 1,
            "subject": "Subject",
            "from": "Merchant Name <[e-mail]>",
            "to": "[e-mail]",
            "cc": null,
            "bcc": "[e-mail]",
            "file_url": "http://url.to/email.html",
        }
    ]
}

Visualizar e-mail

GET https://api.dooki.com.br/v2/{alias}/orders/{id}/emails/{messageId}