Introdução

Para atender os nossos clientes, desenvolvemos esta API onde é possível realizar as consultas de transações e vendas da plataforma, de transações específicas ou por determinados períodos.

Este manual cobre o modelo transacional via API, que realiza a conexão com a Doppus utilizando protocolo HTTPS tendo sua chamada através de Web Services em REST.

Testes na API

Com o objetivo de facilitar a implementação desta API, em alguns métodos são disponibilizadas endpoints de testes que, ao serem executados, validam normalmente os parâmetros enviados. No entanto, como resultado, são sempre retornados valores fixos, apenas como exemplo, independente dos parâmetros enviados.

Autenticação

As APIs listadas nessa documentação utilizam autenticação OAuth2, isso significa que em todas as requisições é necessário informar um token de acesso que será obtido através da autenticação com o seu Client ID e Client Secret.

Token de acesso

Endpoint responsável pela geração do token de acesso utilizado nas demais requisições. Para isso utilizamos HTTP Basic Authentication.

Requisição

POST https://api.app.doppus.com/3.0/auth/

Parâmetros

Header Parameters

Content-type

string Obrigatório
Default: "application/x-www-form-urlencoded"
Tipo do conteúdo padrão application/x-www-form-urlencoded.

Authorization

string Obrigatório
Authorization: Basic AuthString
Onde AuthString é a concatenação do seu Client ID, seguido de “:” (dois pontos) mais seu Client Secret, convertidos para base64.

Como exemplo: Para o Client ID igual a client-01 e Client Secret igual a secret-key-02, teremos o texto client-01:secret-key-02 após a concatenação, convertendo para base64 teremos o resultado 2xpZW50LTAxOnNlY3JldC1rZXktMDI=.

Neste caso o Authorization no header da requisição será: Authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=

FormData Parameters

grant_type

string Obrigatório
Default: "client_credentials"
Usar o valor fixo "client_credentials".

Response

200 Retorna o token de acesso

400 Requisição inválida

Request samples

CURL

curl -X POST \
https://api.app.doppus.com/3.0/auth \
-H 'authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=' \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials'

Response samples

200: Retorna o token de acesso 400: Requisição inválida

{
    "success": true,
    "error": [],
    "return_type": 0,
    "message": "Access token successfully generated.",
    "data": {
        "token": "b3d9217f-4eb7-6f1f-a9c7-99ef069faed0",
        "token_type": "Bearer",
        "expire_in": 3600
    }
}

Vendas

Consultas a uma transação específica ou transações de um determinado período podem ser realizadas através de requisições aos endpoints abaixo.

Consultar venda

Para realizar uma consulta a uma transação específica basta acionar o endpoint abaixo informando o código da transação.

Requisição

GET https://api.app.doppus.com/3.0/sales/{transaction_code}

Endpoint para testes

GET https://api.app.doppus.com/3.0/sales_test/{transaction_code}/

Este endpoint retornará sempre dados estáticos de uma transação qualquer. O objetivo é você testar o envio dos parâmetros e o tratamento dos dados recebidos.

Parâmetros

Header Parameters

Content-type

string Obrigatório
Default: "application/json"
Tipo do conteúdo padrão application/json.

Authorization

string Obrigatório
Authorization: Bearer AuthString
Onde AuthString é o token de acesso obtido no endpoint de autenticação.

Path parameters

transaction_code

string(8) Obrigatório
Código de transação da venda. Informe apenas números.

Response

200 Requisição realizada

Response schema

Propriedade	Tipo	Descrição
success	boolean	Retorna verdadeiro se sucesso ou falso se falhou.
error	array	Detalhes do erro.
error[].message	string	Mensagem detalhando o erro.
error[].field	string	Parâmetro onde ocorreu o erro.
return_type	integer	Tipo de retorno.
message	string	Mensagem de retorno quando sucesso na requisição.
data	object	Conjunto de dados retornados.
data.transaction_code	string	Código de transação da venda.
data.registration_date	datetime	Data de registro da venda.
data.customer	object	Conjunto de dados do cliente.
data.customer.name	string(50)	Nome do cliente.
data.customer.doc_type	string(4)	Tipo de documento do cliente (CPF/CNPJ)
data.customer.doc	string(30)	Documento do cliente.
data.customer.email	string(100)	E-mail do cliente.
data.customer.phone	string(15)	Celular ou telefone fixo do cliente.
data.address	object	Conjunto de dados do endereço do cliente.
data.address.zipcode	string(9)	CEP do endereço do cliente.
data.address.address	string(100)	Logradouro do cliente.
data.address.number	string(20)	Número do endereço do cliente.
data.address.complement	string(50)	Complemento do endereço do cliente.
data.address.neighborhood	string(50)	Bairro do endereço do cliente.
data.address.city	string(50)	Cidade do endereço do cliente.
data.address.state	string(2)	Estado do endereço do cliente.
data.transaction	object	Conjunto de dados da transação.
data.transaction.cost_price	float	Preço de custo total dos itens.
data.transaction.other_costs	float	Outros custos.
data.transaction.sale_price	float	Preço de venda total dos itens.
data.transaction.shipping_value	float	Valor total do frete dos itens.
data.transaction.total	float	Valor total dos itens.
data.transaction.discount	float	Desconto total dos itens.
data.transaction.interest_value	float	Total de juros cobrados.
data.transaction.total_paid	float	Valor total pago.
data.transaction.tax_value	float	Valor total dos impostos.
data.transaction.affiliate_commission	float	Total de comissões para afiliados.
data.transaction.coproducers_commission	float	Total de comissões para co-produtores.
data.transaction.platform_rate	float	Taxa Doppus.
data.transaction.doppus_fee	float	Taxa da adquirente.
data.transaction.estimated_profit	float	Lucro total estimado.
data.payment	object	Conjunto de dados de pagamento da venda.
data.payment.payment_type	integer	Código do tipo de pagamento (1: Cartão de crédito/2: Boleto bancário).
data.payment.payment_type_text	string	Descrição do tipo de pagamento (Cartão de crédito/Boleto bancário).
data.payment.due_date	date	Data de vencimento do boleto bancário.
data.payment.digitable_line	string(55)	Linha digitável para pagamento do boleto bancário.
data.payment.plots	integer	Número de parcelas de pagamento.
data.items	array	Conjunto de dados dos itens da venda.
data.items[].code	string(5)	Código do item.
data.items[].description	string(100)	Descrição do item.
data.items[].options	string(200)	Variações do item. Ex.: Cor: Azul / Tamanho: G.
data.items[].image	string(150)	Endereço da imagem do item.
data.items[].type	integer	Código do tipo de produto (1: Produto físico / 2: Info-produto / 3: Dropshipping / 5: Order bump)
data.items[].type_text	string	Descrição do tipo de produto (Produto físico / Info-produto / Dropshipping / Order bump)
data.items[].amount	integer	Quantidade de itens.
data.items[].cost_price	float	Valor de custo do item.
data.items[].other_costs	float	Outros custos do item.
data.items[].sale_price	float	Preço de venda do item.
data.items[].tax_value	float	Valor estimado do imposto.
data.items[].affiliate_commission	float	Comissão para afiliado.
data.items[].affiliate_code	string(10)	Código do afiliado.
data.items[].affiliate_name	string(50)	Nome do afiliado.
data.items[].affiliate_email	string(100)	E-mail do afiliado.
data.items[].coproducers_commission	float	Total de comissões para co-produtores.
data.shipping	object	Conjunto de dados de frete.
data.shipping.method	string(50)	Método de envio.
data.shipping.deadline	integer	Prazo de entrega em dias corridos.
data.tracking	object	Conjunto de dados de traqueamento.
data.tracking.discount_coupon	string(20)	Cupom de desconto utilizado.
data.tracking.utm_source	string(100)	Informações de rastreamento, recurso.
data.tracking.utm_medium	string(100)	Informações de rastreamento, mídia.
data.tracking.utm_campaign	string(100)	Informações de rastreamento, campanha.
data.tracking.utm_term	string(100)	Informações de rastreamento, termos.
data.tracking.utm_content	string(100)	Informações de rastreamento, conteúdo.
data.tracking.ip_address	string(100)	IP de origem da transação.
data.links	object	Conjunto de dados dos links de retorno.
data.links.get	string(150)	Link para consulta da transação via API.
data.links.url_billet	string(150)	Link para exibição do boleto bancário.
data.is_upsell	boolean	Retorna se a venda é um upsell.
data.last_status_date	datetime	Data da última alteração de status.
data.status_code	integer	Código do status da venda.
data.status_text	string(30)	Descrição do status da venda.
data.status_log	array	Conjunto de dados do histórico de status.
data.status_log[].registration_date	datetime	Data de registro do status.
data.status_log[].status	integer	Código do status da venda.
data.status_log[].status_text	string(30)	Descrição do status da venda.
data.status_log[]message	string(100)	Mensagem descritiva do status.

400 Requisição inválida

401 Autenticação inválida

Request samples

CURL

curl -X GET \
'https://api.app.doppus.com/3.0/sales/27536126/'

Response samples

200: Requisição realizada 400: Requisição inválida 401: Autenticação inválida

{
    "success": true,
    "error": [],
    "return_type": 0,
    "message": "Transaction found.",
    "data": {
        "transaction_code": "27536126",
        "registration_date": "2020-12-07 20:45:49",
        "customer": {
            "name": "Elton John",
            "doc_type": "CPF",
            "doc": "919.359.381-59",
            "email": "eltonjohn@gmail.com",
            "phone": "(48) 99123-4567"
        },
        "address": {
            "zipcode": "88123-456",
            "address": "Rua dos Artistas",
            "number": "123",
            "neighborhood": "Centro",
            "city": "Florianópolis",
            "state": "SC"
        },
        "transaction": {
            "cost_price": 119.76,
            "sale_price": 143.07,
            "shipping_value": 3.2,
            "total": 145.07,
            "discount": 1.2,
            "platform_rate": 2.9,
            "doppus_fee": 3.1,
            "estimated_profit": 25.31
        },
        "payment": {
            "payment_type": 2,
            "payment_type_text": "Boleto bancário",
            "due_date": "2020-12-07",
            "digitable_line": "03399.23559 15900.000009 31179.301010 4 84340000002610"
        },
        "items": [
            {
                "code": "44293",
                "description": "Curso de Guitarra",
                "type": 2,
                "type_text": "Produto digital/serviço",
                "amount": 1,
                "cost_price": 7.65,
                "sale_price": 10.98
            },
            {
                "code": "24231",
                "description": "Guitarra Fender",
                "type": 1,
                "type_text": "Produto físico",
                "amount": 1,
                "cost_price": 112.11,
                "sale_price": 132.09
            }
        ],
        "shipping": {
            "method": "Remessa Personalizada 1",
            "deadline": 12
        },
        "tracking": {
            "ip_address": "192.230.12.168"
        },
        "links": {
            "get": "https://api.app.doppus.com/3.0/sales/27536126",
            "url_billet": "https://doppus.com/checkout/billet/4261.4734.37fd"
        },
        "last_status_date": "2020-12-07 20:45:49",
        "status_code": 0,
        "status_text": "Aguardando",
        "status_log": [
            {
                "registration_date": "2020-12-07 20:45:49",
                "status": 0,
                "status_text": "Aguardando",
                "message": "EM ABERTO"
            }
        ]
    }
}

{
    "success": false,
    "error": [
        {
            "message": "Expiration_year parameter not informed or invalid.",
            "field": null
        }
    ],
    "return_type": 4,
    "message": null,
    "data": []
}

{
    "success": false,
    "error": [
        {
            "message": "Invalid or expired authentication token.",
            "field": null
        }
    ],
    "return_type": 5,
    "message": null,
    "data": []
}

Consultar vendas por data de transação

Para realizar consultas das transações ocorridas em um determinado período basta acionar o endpoint abaixo informando os parâmetros solicitados.

Requisição

GET https://api.app.doppus.com/3.0/sales/

Endpoint para testes

GET https://api.app.doppus.com/3.0/sales_test/

Este endpoint retornará sempre dados estáticos de duas transações quaisquer. O objetivo é você testar o envio dos parâmetros e o tratamento dos dados recebidos.

Parâmetros

Header Parameters

Content-type

string Obrigatório
Default: "application/json"
Tipo do conteúdo padrão application/json.

Authorization

string Obrigatório
Authorization: Bearer AuthString
Onde AuthString é o token de acesso obtido no endpoint de autenticação.

Path parameters

registration_date_start

string(10) Obrigatório
Data inicial do período desejado. Utilize o formato 'YYYY-MM-DD'.

registration_date_end

string(10) Obrigatório
Data final do período desejado. Utilize o formato 'YYYY-MM-DD'.

page

integer
Página requisitada de uma paginação com 50 registros. Se não informar será retornada a primeira página.

status

integer
Status desejado. Utilize "1' para aguardando, "2" para recusadas, "3" para canceladas, "4" para pagas, "5" para estornadas, "6" para chargeback, "7" para em análise e "8" para não concluídas.

Response

200 Requisição realizada

Response schema

Propriedade	Tipo	Descrição
success	boolean	Retorna verdadeiro se sucesso ou falso se falhou.
error	array	Detalhes do erro.
error[].message	string	Mensagem detalhando o erro.
error[].field	string	Parâmetro onde ocorreu o erro.
return_type	integer	Tipo de retorno.
message	string	Mensagem de retorno quando sucesso na requisição.
data	array	Conjunto de dados retornados.
data[].transaction_code	string	Código de transação da venda.
data[].registration_date	datetime	Data de registro da venda.
data[].customer	object	Conjunto de dados do cliente.
data[].customer.name	string(50)	Nome do cliente.
data[].customer.doc_type	string(4)	Tipo de documento do cliente (CPF/CNPJ)
data[].customer.doc	string(30)	Documento do cliente.
data[].customer.email	string(100)	E-mail do cliente.
data[].customer.phone	string(15)	Celular ou telefone fixo do cliente.
data[].address	object	Conjunto de dados do endereço do cliente.
data[].address.zipcode	string(9)	CEP do endereço do cliente.
data[].address.address	string(100)	Logradouro do cliente.
data[].address.number	string(20)	Número do endereço do cliente.
data[].address.complement	string(50)	Complemento do endereço do cliente.
data[].address.neighborhood	string(50)	Bairro do endereço do cliente.
data[].address.city	string(50)	Cidade do endereço do cliente.
data[].address.state	string(2)	Estado do endereço do cliente.
data[].transaction	object	Conjunto de dados de pagamento da venda.
data[].transaction.cost_price	float	Preço de custo total dos itens.
data[].transaction.other_costs	float	Outros custos.
data[].transaction.sale_price	float	Preço de venda total dos itens.
data[].transaction.shipping_value	float	Valor total do frete dos itens.
data[].transaction.total	float	Valor total dos itens.
data[].transaction.discount	float	Desconto total dos itens.
data[].transaction.interest_value	float	Total de juros cobrados.
data[].transaction.total_paid	float	Valor total pago.
data[].transaction.tax_value	float	Valor total dos impostos.
data[].transaction.affiliate_commission	float	Total de comissões para afiliados.
data[].transaction.coproducers_commission	float	Total de comissões para co-produtores.
data[].transaction.platform_rate	float	Taxa Doppus.
data[].transaction.doppus_fee	float	Taxa da adquirente.
data[].transaction.estimated_profit	float	Lucro total estimado.
data[].payment	object	Conjunto de dados de pagamento da venda.
data[].payment.payment_type	integer	Código do tipo de pagamento (1: Cartão de crédito/2: Boleto bancário).
data[].payment.payment_type_text	string	Descrição do tipo de pagamento (Cartão de crédito/Boleto bancário).
data[].payment.due_date	date	Data de vencimento do boleto bancário.
data[].payment.digitable_line	string(55)	Linha digitável para pagamento do boleto bancário.
data[].payment.plots	integer	Número de parcelas de pagamento.
data[].items	array	Conjunto de dados dos itens da venda.
data[].items[].code	string(5)	Código do item.
data[].items[].description	string(100)	Descrição do item.
data[].items[].options	string(200)	Variações do item. Ex.: Cor: Azul / Tamanho: G.
data[].items[].image	string(150)	Endereço da imagem do item.
data[].items[].type	integer	Código do tipo de produto (1: Produto físico / 2: Info-produto / 3: Dropshipping / 5: Order bump)
data[].items[].type_text	string	Descrição do tipo de produto (Produto físico / Info-produto / Dropshipping / Order bump)
data[].items[].amount	integer	Quantidade de itens.
data[].items[].cost_price	float	Valor de custo do produto.
data[].items[].other_costs	float	Outros custos do produto.
data[].items[].sale_price	float	Preço de venda do produto.
data[].items[].tax_value	float	Valor estimado do imposto.
data[].items[].affiliate_commission	float	Comissão para afiliado.
data[].items[].affiliate_code	string(10)	Código do afiliado.
data[].items[].affiliate_name	string(50)	Nome do afiliado.
data[].items[].affiliate_email	string(100)	E-mail do afiliado.
data[].items[].coproducers_commission	float	Total de comissões para co-produtores.
data[].shipping	object	Conjunto de dados de frete.
data[].shipping.method	string(50)	Método de envio.
data[].shipping.deadline	integer	Prazo de entrega em dias corridos.
data[].tracking	object	Conjunto de dados de traqueamento.
data[].tracking.discount_coupon	string(20)	Cupom de desconto utilizado.
data[].tracking.utm_source	string(100)	Informações de rastreamento, recurso.
data[].tracking.utm_medium	string(100)	Informações de rastreamento, mídia.
data[].tracking.utm_campaign	string(100)	Informações de rastreamento, campanha.
data[].tracking.utm_term	string(100)	Informações de rastreamento, termos.
data[].tracking.utm_content	string(100)	Informações de rastreamento, conteúdo.
data[].tracking.ip_address	string(100)	IP de origem da transação.
data[].links	object	Conjunto de dados dos links de retorno.
data[].links.get	string(150)	Link para consulta da transação via API.
data[].links.url_billet	string(150)	Link para exibição do boleto bancário.
data[].is_upsell	boolean	Retorna se a venda é um upsell.
data[].last_status_date	datetime	Data da última alteração de status.
data[].status_code	integer	Código do status da venda.
data[].status_text	string(30)	Descrição do status da venda.
data[].status_log	array	Conjunto de dados do histórico de status.
data[].status_log[].registration_date	datetime	Data de registro do status.
data[].status_log[].status	integer	Código do status da venda.
data[].status_log[].status_text	string(30)	Descrição do status da venda.
data[].status_log[].message	string(100)	Mensagem descritiva do status.

400 Requisição inválida

401 Autenticação inválida

Request samples

CURL

curl -X GET \
'https://api.app.doppus.com/3.0/sales/?registration_date_start=2020-11-01& registration_date_end=2020-11-20'

Response samples

200: Requisição realizada 400: Requisição inválida 401: Autenticação inválida

{
    "success": true,
    "error": [],
    "return_type": 0,
    "message": "Transactions found.",
    "data": [
        {
            "transaction_code": "27536126",
            "registration_date": "2020-12-07 20:45:49",
            "customer": {
                "name": "Elton John",
                "doc_type": "CPF",
                "doc": "919.359.381-59",
                "email": "eltonjohn@gmail.com",
                "phone": "(48) 99123-4567"
            },
            "address": {
                "zipcode": "88123-456",
                "address": "Rua dos Artistas",
                "number": "123",
                "neighborhood": "Centro",
                "city": "Florianópolis",
                "state": "SC"
            },
            "transaction": {
                "cost_price": 119.76,
                "sale_price": 143.07,
                "shipping_value": 3.2,
                "total": 145.07,
                "discount": 1.2,
                "platform_rate": 2.9,
                "doppus_fee": 3.1,
                "estimated_profit": 25.31
            },
            "payment": {
                "payment_type": 2,
                "payment_type_text": "Boleto bancário",
                "due_date": "2020-12-07",
                "digitable_line": "03399.23559 15900.000009 31179.301010 4 84340000002610",
            },
            "items": [
                {
                    "code": "44293",
                    "description": "Curso de Guitarra",
                    "type": 2,
                    "type_text": "Produto digital/serviço",
                    "amount": 1,
                    "cost_price": 7.65,
                    "sale_price": 10.98
                },
                {
                    "code": "24231",
                    "description": "Guitarra Fender",
                    "type": 1,
                    "type_text": "Produto físico",
                    "amount": 1,
                    "cost_price": 112.11,
                    "sale_price": 132.09
                }
            ],
            "shipping": {
                "method": "Remessa Personalizada 1",
                "deadline": 12
            },
            "tracking": {
                "ip_address": "192.230.12.168"
            },
            "links": {
                "get": "https://api.app.doppus.com/3.0/sales/27536126",
                "url_billet": "https://doppus.com/checkout/billet/4261.4734.37fd"
            },
            "last_status_date": "2020-12-07 20:45:49",
            "status_code": 0,
            "status_text": "Aguardando",
            "status_log": [
                {
                    "registration_date": "2020-12-07 20:45:49",
                    "status": 0,
                    "status_text": "Aguardando",
                    "message": "EM ABERTO"
                }
            ]
        }
    ]
}

Consultar vendas por data do último status

Para realizar consultas das transações que tiveram seu status alterado em um determinado período basta acionar o endpoint abaixo informando os parâmetros solicitados.

Requisição

GET https://api.app.doppus.com/3.0/sales/

Endpoint para testes

GET https://api.app.doppus.com/3.0/sales_test/

Este endpoint retornará sempre dados estáticos de duas transações quaisquer. O objetivo é você testar o envio dos parâmetros e o tratamento dos dados recebidos.

Parâmetros

Header Parameters

Content-type

string Obrigatório
Default: "application/json"
Tipo do conteúdo padrão application/json.

Authorization

string Obrigatório
Authorization: Bearer AuthString
Onde AuthString é o token de acesso obtido no endpoint de autenticação.

Path parameters

last_status_date_start

string(10) Obrigatório
Data inicial do período desejado. Utilize o formato 'YYYY-MM-DD'.

last_status_date_end

string(10) Obrigatório
Data final do período desejado. Utilize o formato 'YYYY-MM-DD'.

page

integer
Página requisitada de uma paginação com 50 registros. Se não informar será retornada a primeira página.

status

Response

200 Requisição realizada

Response schema

Propriedade	Tipo	Descrição
success	boolean	Retorna verdadeiro se sucesso ou falso se falhou.
error	array	Detalhes do erro.
error[].message	string	Mensagem detalhando o erro.
error[].field	string	Parâmetro onde ocorreu o erro.
return_type	integer	Tipo de retorno.
message	string	Mensagem de retorno quando sucesso na requisição.
data	array	Conjunto de dados retornados.
data[].transaction_code	string	Código de transação da venda.
data[].registration_date	datetime	Data de registro da venda.
data[].customer	object	Conjunto de dados do cliente.
data[].customer.name	string(50)	Nome do cliente.
data[].customer.doc_type	string(4)	Tipo de documento do cliente (CPF/CNPJ)
data[].customer.doc	string(30)	Documento do cliente.
data[].customer.email	string(100)	E-mail do cliente.
data[].customer.phone	string(15)	Celular ou telefone fixo do cliente.
data[].address	object	Conjunto de dados do endereço do cliente.
data[].address.zipcode	string(9)	CEP do endereço do cliente.
data[].address.address	string(100)	Logradouro do cliente.
data[].address.number	string(20)	Número do endereço do cliente.
data[].address.complement	string(50)	Complemento do endereço do cliente.
data[].address.neighborhood	string(50)	Bairro do endereço do cliente.
data[].address.city	string(50)	Cidade do endereço do cliente.
data[].address.state	string(2)	Estado do endereço do cliente.
data[].transaction	object	Conjunto de dados de pagamento da venda.
data[].transaction.cost_price	float	Preço de custo total dos itens.
data[].transaction.other_costs	float	Outros custos.
data[].transaction.sale_price	float	Preço de venda total dos itens.
data[].transaction.shipping_value	float	Valor total do frete dos itens.
data[].transaction.total	float	Valor total dos itens.
data[].transaction.discount	float	Desconto total dos itens.
data[].transaction.interest_value	float	Total de juros cobrados.
data[].transaction.total_paid	float	Valor total pago.
data[].transaction.tax_value	float	Valor total dos impostos.
data[].transaction.affiliate_commission	float	Total de comissões para afiliados.
data[].transaction.coproducers_commission	float	Total de comissões para co-produtores.
data[].transaction.tax_dopus	float	Taxa total da Doppus.
data[].transaction.estimated_profit	float	Lucro total estimado.
data[].payment	object	Conjunto de dados de pagamento da venda.
data[].payment.payment_type	integer	Código do tipo de pagamento (1: Cartão de crédito/2: Boleto bancário).
data[].payment.payment_type_text	string	Descrição do tipo de pagamento (Cartão de crédito/Boleto bancário).
data[].payment.due_date	date	Data de vencimento do boleto bancário.
data[].payment.digitable_line	string(55)	Linha digitável para pagamento do boleto bancário.
data[].payment.plots	integer	Número de parcelas de pagamento.
data[].items	array	Conjunto de dados dos itens da venda.
data[].items[].code	string(5)	Código do item.
data[].items[].description	string(100)	Descrição do item.
data[].items[].options	string(200)	Variações do item. Ex.: Cor: Azul / Tamanho: G.
data[].items[].image	string(150)	Endereço da imagem do item.
data[].items[].type	integer	Código do tipo de produto (1: Produto físico / 2: Info-produto / 3: Dropshipping / 5: Order bump)
data[].items[].type_text	string	Descrição do tipo de produto (Produto físico / Info-produto / Dropshipping / Order bump)
data[].items[].amount	integer	Quantidade de itens.
data[].items[].cost_price	float	Valor de custo do produto.
data[].items[].other_costs	float	Outros custos do produto.
data[].items[].sale_price	float	Preço de venda do produto.
data[].items[].tax_value	float	Valor estimado do imposto.
data[].items[].affiliate_commission	float	Comissão para afiliado.
data[].items[].affiliate_code	string(10)	Código do afiliado.
data[].items[].affiliate_name	string(50)	Nome do afiliado.
data[].items[].affiliate_email	string(100)	E-mail do afiliado.
data[].items[].coproducers_commission	float	Total de comissões para co-produtores.
data[].shipping	object	Conjunto de dados de frete.
data[].shipping.method	string(50)	Método de envio.
data[].shipping.deadline	integer	Prazo de entrega em dias corridos.
data[].tracking	object	Conjunto de dados de traqueamento.
data[].tracking.discount_coupon	string(20)	Cupom de desconto utilizado.
data[].tracking.utm_source	string(100)	Informações de rastreamento, recurso.
data[].tracking.utm_medium	string(100)	Informações de rastreamento, mídia.
data[].tracking.utm_campaign	string(100)	Informações de rastreamento, campanha.
data[].tracking.utm_term	string(100)	Informações de rastreamento, termos.
data[].tracking.utm_content	string(100)	Informações de rastreamento, conteúdo.
data[].tracking.ip_address	string(100)	IP de origem da transação.
data[].links	object	Conjunto de dados dos links de retorno.
data[].links.get	string(150)	Link para consulta da transação via API.
data[].links.url_billet	string(150)	Link para exibição do boleto bancário.
data[].is_upsell	boolean	Retorna se a venda é um upsell.
data[].last_status_date	datetime	Data da última alteração de status.
data[].status_code	integer	Código do status da venda.
data[].status_text	string(30)	Descrição do status da venda.
data[].status_log	array	Conjunto de dados do histórico de status.
data[].status_log[].registration_date	datetime	Data de registro do status.
data[].status_log[].status	integer	Código do status da venda.
data[].status_log[].status_text	string(30)	Descrição do status da venda.
data[].status_log[].message	string(100)	Mensagem descritiva do status.

400 Requisição inválida

401 Autenticação inválida

Request samples

CURL

curl -X GET \
'https://api.app.doppus.com/3.0/sales/?last_status_date_start=2020-11-01& last_status_date_end=2020-11-20'

Response samples

200: Requisição realizada 400: Requisição inválida 401: Autenticação inválida

Tabelas de códigos

Para referência dos códigos utilizados nessa API você pode consultar as tabelas abaixo.

Status de transação

Tabela de referência dos status de transação.

Código	Descrição
1	Aguardando pagamento.
2	Pagamento cancelado (Boleto vencido ou PIX expirado).
3	Pagamento recusado (problemas nos dados ou no cartão de crédito).
4	Transação aguardando análise de pagamento.
5	Transação com pagamento realizado.
6	Pagamento concluído (após período de devolução).
7	Em processo de estorno.
8	Transação com pagamento estornado.
9	Em processo de contestação.
10	Transação com pagamento contestado.
11	Transação com pagamento reclamado (pendente).
12	Transação com pagamento reembolsado.
13	Chargeback realizado.

Retornos de requisição

Tabela de referência dos retornos das requisições a API.

Código	Descrição
1	Requisição bem sucedida. Retorno HTTP 200.
2	Requisição bem sucedida, objeto criado. Retorno HTTP 201.
3	Requisição bem sucedida, sem retorno de dados. Retorno HTTP 204.
4	Requisição inválida. Retorno HTTP 400.
5	Erro na autenticação. Retorno HTTP 401.
6	Sem permissão para executar. Retorno HTTP 403.
7	Recurso não encontrado. Retorno HTTP 404.

Tipos de produto

Tabela de referência dos tipos de produtos de uma transação.

Código	Descrição
1	Produto físico.
2	Info-produto.
3	Dropshipping.
4	Assinatura.
5	Order bump.
6	Kit.

Meios de pagamento

Tabela de referência dos meios de pagamento de uma transação.

Código	Descrição
1	Cartão de crédito.
2	Boleto bancário.
3	PIX.