Includes disponíveis: emailDetails
GET https://api.dooki.com.br/v2/{alias}/checkout/statuses
Parâmetro | Tipo | Descrição |
orderId | int | Retorna os status esperado por um pedido. |
Response de status
{"data": [{"id": 1,"alias": "created","name": "Pedido realizado","description": "O pedido foi realizado","email_details": {"data": {"subject": "Pedido realizado","message": "Seu pedido foi realizado. Obrigado."}}},{"id": 2,"alias": "authorized","name": "Pedido autorizado","description": "O pedido foi autorizado e está aguardando captura","email_details": {"data": {"subject": "Pedido autorizado","message": "Estamos aguardando a confirmação do pagamento..."}}},]}
Alias | Nome | Descrição |
| Pedido realizado | O pedido foi realizado. |
| Pedido autorizado | O pedido foi autorizado e está aguardando captura. |
| Aguardando confirmação de pagamento | O pedido ainda não foi pago. |
| Pagamento aprovado | O pedido foi pago/capturado. |
| Produtos em separação | Os produtos estão em separação, aguardando postagem. |
| Em transporte | O pedido já foi postado para a transportadora. |
| Entregue | O pedido foi entregue ao destinatário. |
| Pedido cancelado | O pedido foi cancelado. |
| Pagamento não aprovado | O pagamento não foi aprovado. |
| Faturado | O pedido foi faturado. |
| Exceção na entrega | O pedido teve um problema em sua entrega. |
Request para alterar o assunto e mensagem do e-mail de um status
{"subject": "Pedido realizado","message": "Seu pedido foi realizado. Obrigado."}
PUT https://api.dooki.com.br/v2/{alias}/checkout/statuses/{id}/email-details
GET https://api.dooki.com.br/v2/{alias}/checkout/banks
Response de bancos
{"data": [{"id": 1,"code": "001","alias": "BANCO_DO_BRASIL","name": "Banco do Brasil"},{"id": 2,"code": "237","alias": "BRADESCO","name": "Bradesco"},{"id": 3,"code": "341","alias": "ITAU","name": "Itaú"},{"id": 4,"code": "033","alias": "SANTANDER","name": "Santander"}],}
GET https://api.dooki.com.br/v2/{alias}/checkout/banks/{id}
Includes disponíveis: form
GET https://api.dooki.com.br/v2/{alias}/checkout/gateways
Response de gateways de pagamento
{"data": [{"alias": "billet","name": "Boleto Bancário","params": {"data": ["env","merchant_id","key"]}},{"alias": "cielo","name": "Cielo","params": {"data": ["env","merchant_id","key"]}},{"alias": "deposit","name": "Depósito Bancário","params": {"data": ["env","merchant_id","key"]}},{"alias": "mercadopago","name": "Mercadopago","params": {"data": ["env","merchant_id","key"]}},// ...]}
GET https://api.dooki.com.br/v2/{alias}/checkout/gateways/{alias}
GET https://api.dooki.com.br/v2/{alias}/checkout/gateways/{alias}/params
GET https://api.dooki.com.br/v2/{alias}/checkout/affiliations
Request
{"name": "Cielo Afilliation","gateway_alias": "cielo","auto_capture": true,"params": {"env": "test","merchant_id": 123456,"key": "key"}}
Response
{"data": [{"id": 88,"auto_capture": false,"has_payment_config": false,"name": "Cielo Affiliation","params": {"env": "test","merchant_id": 123456,"key": "key"},"gateway": {"data": {"alias": "cielo","name": "Cielo","params": {"data": ["env","merchant_id","key"]}}}},]}
POST https://api.dooki.com.br/v2/{alias}/checkout/affiliations
Parâmetro | Tipo | Obrigatório | Descrição |
gateway_alias | string | Sim | Alias do gateway de pagamento. |
name | string | Sim | Nome da afiliação. |
params | array | Sim | Parâmetros da afiliação. |
GET https://api.dooki.com.br/v2/{alias}/checkout/affiliations/{id}
PUT https://api.dooki.com.br/v2/{alias}/checkout/affiliations/{id}
DELETE https://api.dooki.com.br/v2/{alias}/checkout/affiliations/{id}
GET https://api.dooki.com.br/v2/{alias}/checkout/payments
Response
{"data": [{"id": 1,"alias": "amex","name": "American Express","has_config": true,"is_credit_card": true,"is_deposit": false,"is_billet": false},{"id": 2,"alias": "visa","name": "Visa","has_config": true,"is_credit_card": true,"is_deposit": false,"is_billet": false},{"id": 3,"alias": "diners","name": "Diners","has_config": true,"is_credit_card": true,"is_deposit": false,"is_billet": false},// ...]}
GET https://api.dooki.com.br/v2/{alias}/checkout/payments/{id}
GET https://api.dooki.com.br/v2/{alias}/checkout/payments/{id}/config
Request
{"payment_id": 6,"affiliation_id": 3,"active": true,"default_display": false,"accumulate_discount": false,"ignore_promotions": false,"percent_discount": 0,"min_installment_value": 25,"max_installments_without_tax": 1,"billet_expire_days": 1,}
Response
{"data": {"id": 1,"payment_id": 6,"affiliation_id": 3,"active": true,"default_display": false,"accumulate_discount": false,"ignore_promotions": false,"percent_discount": 0,"min_installment_value": 25,"max_installments_without_tax": 1,"billet_expire_days": 1,"installments": {"data": [{"id": 5241,"payment_id": 2,"installment": 1,"tax": 0,"percent_discount": 5,},// ...]},"affiliation": {"data": {"id": 26,"auto_capture": true,"has_payment_config": true,"name": "Pagarme - bordabordados","params": {"api_key": "api_key","encryption_key": "enc_key"},"gateway": {"data": {"alias": "pagarme","name": "Pagar.me","params": {"data": ["api_key","encryption_key"]}}}}},"payment": {"data": {"id": 2,"alias": "visa","name": "Visa","has_config": true,"is_credit_card": true,"is_deposit": false,"is_billet": false}}}}
POST https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config
Parâmetro | Tipo | Obrigatório | Descrição |
payment_id | int | Sim | ID do pagamento. |
affiliation_id | int | Sim | ID da afiliação. |
active | boolean | Sim | Status da configuração. |
default_display | boolean | Sim | Marca se essa configuração será a padrão para exibição na vitrine. |
accumulate_discount | boolean | Não | Marca se o desconto irá acumular com outros descontos. |
ignore_promotions | boolean | Não | Marca se o desconto excluirá produtos já em promoção |
percent_discount | float | Não | Porcentagem de desconto. |
min_installment_value | float | Não | Valor mínimo da parcela. |
max_installments_without_tax | int | Não | Máximo de parcelas sem juros. |
billet_expire_days | int | Não | Número de dias de vencimento do boleto. |
GET https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config/{id}
PUT https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config/{id}
DELETE https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/config/{id}
GET https://api.dooki.com.br/v2/{alias}/checkout/payments/{id}/installments
Request
{"installments": [{"payment_id": 2,"installment": 1,"tax": 1.5,"percent_discount": 0},{"payment_id": 2,"installment": 2,"tax": 3.0,"percent_discount": 0}]}
Response
{"data": [{"id": 1,"payment_id": 2,"installment": 1,"tax": 1.5,"percent_discount": 0,},{"id": 2,"payment_id": 2,"installment": 2,"tax": 3.5,"percent_discount": 0,},]}
POST https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/installments
Parâmetro | Tipo | Obrigatório | Descrição |
payment_id | int | Sim | ID do pagamento. |
installment | int | Sim | Número da parcela. |
tax | float | Sim | Taxa de juros para a parcela. |
percent_discount | float | Sim | Porcentagem de desconto para a parcela. |
GET https://api.dooki.com.br/v2/{alias}/checkout/payments/{id}/installments/simulate
Parâmetro | Tipo | Obrigatório | Descrição |
amount | float | Sim | Valor simulado. |
min_installment_value | float | Sim | Valor mínimo da parcela. |
max_installments_without_tax | int | Sim | Máximo de parcelas sem juros. |
currency | string | Não | Moeda. |
taxes[0][tax] | array | Sim | Taxa de juros da parcela (em porcentagem). |
taxes[0][installment] | array | Sim | Número da parcela. |
taxes[0][percent_discount] | array | Sim | Desconto (em porcentagem) da parcela. |
Response da simulação de parcelamento
{"data": {"max_installment": "1","max_installment_value": 500,"amount": 500,"text": "1x de R$ 500,00 sem juros","text_with_tax": "1x de R$ 500,00","text_discount_percent": null,"text_discount": null,"installments": [{"amount": 500,"amount_formated": "R$ 500,00","base_value": 500,"tax": "0","tax_value": 0,"discount_percent": 0,"discount_value": 0,"discount_value_formated": "R$ 0,00","installment": "1","installment_value": 500,"installment_value_formated": "R$ 500,00","text": "1x de R$ 500,00 sem juros","text_with_tax": "1x de R$ 500,00","text_discount_percent": null,"text_discount": null}],}}
Includes disponíveis: customer, payment, address, promocode, items, seller
Limite de 100 carrinhos por página usando o parâmetro limit
.
GET https://api.dooki.com.br/v2/{alias}/checkout/carts
Response
{"data": [{"id": 388392,"token": "29d7f5ec-365c-3997-b44d-bca6136dbda2","has_recommendation": true,"totalizers": {"total_items": "1","subtotal": 718.2,"discount": 0,"shipment": 0,"shipment_original_value": null,"shipment_discount_value": 0,"shipment_discount_percent": "0,00","promocode_discount_value": 0,"progressive_discount_value": 0,"combos_discount_value": 0,"total": 718.2,"subtotal_formated": "R$ 718,20","discount_formated": "R$ 0,00","total_formated": "R$ 718,20"},"shipping_service": null,"tracking_data": null,"utm_source": "facebook","utm_campaign": "remarketing","customizations": [],"items": {"data": [{"id": 545699,"sku_id": 46863,"kit_id": null,"quantity": 1,"gift": false,"has_recomm": false,"custom_value": null,"sku": {"data": {// ...}}}]}},]}
Esse tipo de filtro não utiliza a sintaxe global. Neste caso, o parâmetro é passado individualmente via query string na URL.
Parâmetro | Tipo | Descrição |
has_transactions | boolean | Retorna somente carrinhos com transações. |
GET https://api.dooki.com.br/v2/{alias}/checkout/carts/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.
GET https://api.dooki.com.br/v2/{alias}/checkout/carts/stats
GET https://api.dooki.com.br/v2/{alias}/checkout/carts/{id}/transactions
Response de estatísticas de carrinhos abandonados
{"converted_carts": {"amount": "293477.67","amount_formated": "R$ 293.477,67","total": 1445},"utms": [{"utm_source": "facebook","total": 1835},{"utm_source": "Email","total": 65},]}
GET https://api.dooki.com.br/v2/{alias}/config/carts/{id}
Response
{"data": {"id": 1,"active": true,"email_subject": "{name}, os produtos que você escolheu estão te esperando :)","sms_subject": null,"email_frequency": 2,"email_hours_delay": 0.5,"promocode_in_first_email": true,"created_at": {"date": "2018-02-20 21:57:48.000000","timezone_type": 3,"timezone": "America/Sao_Paulo"},"updated_at": {"date": "2020-03-24 11:40:22.000000","timezone_type": 3,"timezone": "America/Sao_Paulo"},"messages": {"data": [{"id": 1,"store_id": 1,"cart_config_id": 1,"active": true,"email_subject": "subject order 1","email_subject_multiple": "subject order multiple 1","email_message": "message order 1","email_message_multiple": "message order multiple 1","sms_message": null,"sms_message_multiple": null,"hours_delay": 1,"promocode_id": null}]}}}
PUT https://api.dooki.com.br/v2/{alias}/config/carts/{id}
Request
| Tipo | Obrigatório | Descrição |
active | boolean | Sim | Ativa/Inativa o envio de email de recuperação de carrinho abandonado |
messages | array | Sim | E-mails que serão enviados para o cliente |
messages.*.active | boolean | Sim | Se esse e-mail em específico será enviado |
messages.*.email_subject | string | Sim | Assunto do e-mail para carrinhos com apenas 1 produto |
messages.*email_subject_multiple | string | Sim | Assunto do e-mail para carrinhos com mais de 1 produto |
messages.*.email_message | string | Sim | Conteúdo do e-mail para carrinhos com apenas 1 produto |
messages.*.email_message_multiple | string | Sim | Conteúdo do em-mail para carrinhos com mais de 1 produto |
messages.*.hours_delay | numeric | Sim | Intervalo de tempo (em horas) em que o e-mail será disparado |
messages.*.sms_message | string | Não | Conteúdo do SMS para carrinhos com apenas 1 produto |
messages.*.sms_message_multiple | string | Não | Conteúdo do SMS para carrinhos com mais de 1 produto |
Response
{"data": {"id": 1,"active": true,"email_subject": "{name}, os produtos que você escolheu estão te esperando :)","sms_subject": null,"email_frequency": 2,"email_hours_delay": 0.5,"promocode_in_first_email": true,"created_at": {"date": "2018-02-20 21:57:48.000000","timezone_type": 3,"timezone": "America/Sao_Paulo"},"updated_at": {"date": "2020-03-24 11:40:22.000000","timezone_type": 3,"timezone": "America/Sao_Paulo"},"messages": {"data": [{"id": 1,"store_id": 1,"cart_config_id": 1,"active": true,"email_subject": "subject order 1","email_subject_multiple": "subject order multiple 1","email_message": "message order 1","email_message_multiple": "message order multiple 1","sms_message": null,"sms_message_multiple": null,"hours_delay": 1,"promocode_id": null}]}}}
PUT https://api.dooki.com.br/v2/{alias}/config/carts/{id}/reset
Includes disponíveis: affiliation, payment, customer, requestData, logs
Transações são criadas para toda tentativa de pagamento. Um pedido pode ter uma ou mais transações (no caso de pagamento com mais de um cartão).
GET https://api.dooki.com.br/v2/{alias}/checkout/transactions
Response de transações
{"data": [{"id": 89000,"customer_id": 37484,"payment_id": 9,"affiliation_id": 26,"authorized": true,"captured": false,"cancelled": false,"gateway_transaction_id": "29687073","gateway_order_id": null,"gateway_authorization_code": null,"gateway_billet_id": null,"amount": 59.39,"installments": 1,"status": "waiting_payment","error_message": null,"error_code": null,"truncated_card": null,"holder_name": null,"holder_document": null,"billet_url": "https://billet.com","billet_our_number": null,"billet_document_number": null,"billet_date": {"date": "2018-01-02 00:00:00.000000","timezone_type": 3,"timezone": "America/Sao_Paulo"},"antifraud_sale_id": null,"sent_to_antifraud": false,"capture_date": null,"authorized_at": {"date": "2017-12-25 04:53:10.000000","timezone_type": 3,"timezone": "America/Sao_Paulo"},"captured_at": null,"cancelled_at": null,"payment": {"data": {"id": 9,"alias": "billet","name": "Boleto Bancário","has_config": true,"is_credit_card": false,"is_deposit": false,"is_billet": true}},}]}
GET https://api.dooki.com.br/v2/{alias}/checkout/transactions/{id}/payment/confirm
GET https://api.dooki.com.br/v2/{alias}/checkout/transactions/{id}/payment/cancel
GET https://api.dooki.com.br/v2/{alias}/checkout/transactions/{id}/payment/gateway/capture
GET https://api.dooki.com.br/v2/{alias}/checkout/transactions/{id}/payment/gateway/cancel
Status | Descrição |
paid | A transação foi paga. |
cancelled | A transação foi cancelada. |
chargeback | A transação sofreu chargeback. |
created | A transação foi criada. |
refused | A transação foi negada. |
waiting_payment | A transação está aguardando pagamento. |
GET https://api.dooki.com.br/v2/{alias}/checkout/transactions/{id}
GET https://api.dooki.com.br/v2/{alias}/checkout/transactions/{id}/logs
Response de logs de transação
Includes disponíveis: bankAccounts
GET https://api.dooki.com.br/v2/{alias}/checkout/sellers
GET https://api.dooki.com.br/v2/{alias}/checkout/sellers/{id}
POST https://api.dooki.com.br/v2/{alias}/checkout/sellers
Request
{"affiliation_id" : 98,"bank_account_id" : 11,"has_split" : false,"transfer_enabled" : false,"active" : true,"name" : "teste","email" : "[email protected]","document" : "12345678912","document_type" : "cpf","transfer_interval" : "daily","transfer_day" : "0","antecipatable_volume_percentage" : "0","automatic_antecipation_enabled" : false,"ref_code" : "1","external_gateway_id" : "1","percentage_products" : "5","percentage_shipping" : "5","charge_processing_fee" : true,"liable" : true}
Response
{"data": [{"id": 1,"bank_account_id": 1,"has_split": false,"transfer_enabled": false,"active": true,"name": "teste","email": "[email protected]","document": "12345678912","document_type": "cpf","transfer_interval": "daily","transfer_day": "0","anticipatable_volume_percentage": 0,"automatic_anticipation": false,"ref_code": 1,"external_gateway_id": null,"percentage_products": 5,"percentage_shipping": 5,"charge_processing_fee": true,"liable": true}]}
Parâmetro | Tipo | Obrigatório | Descrição |
affiliation_id | int/nullable | Não | ID da afiliação. |
bank_account_id | int/nullable | Não | ID da conta bancária. |
has_split | boolean | Não | Split de pagamentos habilitado (default: false). |
transfer_enabled | boolean | Sim | Indica se haverá transferência automática |
active | boolean | Não | Status do vendedor (default: true). |
name | string | Sim | Nome do vendedor. |
Sim | Email do vendedor. | ||
document | string | Sim | Documento do vendedor. |
document_type | string | Sim | Tipo de documento do vendedor (valores aceitos: cpf, cnpj). |
transfer_interval | string | Sim | Intervalo de transferência (valores aceitos: daily, weekly, monthly). |
transfer_day | int | Sim | Dia em que será realizada a transferência (valores aceitos: entre 0 e 31). |
antecipatable_volume_percentage | int | Não | Porcentagem referente ao valor a receber que o vendedor pode antecipar (defaul: 0). |
automatic_anticipation_enabled | boolean | Não | Define se o vendedor pode receber antecipações automáticas (default: false). |
ref_code | string | Sim | Código de referência do vendedor. |
external_gateway_id | string | Não | ID do recebedor no pagarme. |
percentage_products | int | Sim | Porcentagem de comissão em cima dos produtos. |
percentage_shipping | int | Sim | Porcentagem de comissão em cima do frete. |
charge_processing_fee | boolean | Não | Indica se o vendedor será cobrado pelas taxas da transação (default: false). |
liable | boolean | Sim | indica se o vendedor assumirá os riscos de chargeback da transação. |
Obs : Os valores aceitos pelo parâmentro transfer_day são de acordo com o intervalo de transferência (transfer_interval).
Intervalo de transferência | Valor aceito (transfer_day) |
monthly | 1 a 31 |
weekly | 1 a 5 |
daily | 0 |
PUT https://api.dooki.com.br/v2/{alias}/checkout/sellers/{id}
PUT https://api.dooki.com.br/v2/{alias}/checkout/sellers/batch-update
Request - atualização em lote
{"ids" : [66],"attributes" : {"active" : true}}
DELETE https://api.dooki.com.br/v2/{alias}/checkout/sellers/{id}
GET https://api.dooki.com.br/v2/{alias}/checkout/sellers/bank-accounts
GET https://api.dooki.com.br/v2/{alias}/checkout/sellers/bank-accounts/{id}
POST https://api.dooki.com.br/v2/{alias}/checkout/sellers/bank-accounts
Request
{"affiliation_id" : 98,"bank_code" : 1,"external_gateway_id" : "2","agency" : "2222","agency_digit" : "3","account" : "1234","account_digit" : "2","document_number" : "123456789","legal_name" : "teste","type" : "conta_poupanca"}
Response
{"data": [{"id": 1,"affiliation_id": 98,"bank_code": 1,"external_gateway_id": 2,"agency": 2222,"agency_digit": 3,"account": 1234,"account_digit": 2,"document_number": "11111111111","legal_name": "teste","type": "conta_poupanca"}]}
Parâmetro | Tipo | Obrigatório | Descrição |
affiliation_id | int/nullable | Não | ID da afiliação. |
bank_code | string | Sim | Código do banco. |
external_gateway_id | int | Sim | ID no pagarme. |
agency | string | Sim | Número da agência bancaria. |
agency_digit | string | Sim | Dígito da agência bancaria. |
account | string | Sim | Número da conta. |
account_digit | string | Sim | Dígito da conta. |
document_number | string | Sim | Número do documento. |
legal_name | string | Sim | Nome ou razão social do titular da conta. |
type | string | Sim | Tipo da conta (valores aceitos: conta_corrente, conta_poupanca, conta_corrente_conjunta, conta_poupanca_conjunta ). |
PUT https://api.dooki.com.br/v2/{alias}/checkout/sellers/bank-accounts/{id}
DELETE https://api.dooki.com.br/v2/{alias}/checkout/sellers/bank-accounts/{id}