API  Versão 1 – Português (Brasil)

Pedido

Selecionar IDs de Pedidos

https://deliverydireto.com.br/wspdv/api/selecionaPedidosAlteradosAPartirDe

Busca os IDs dos pedidos criados ou alterados a partir de uma determinada data (especificada nos parâmetros da requisição), para uma ou mais lojas (também especificadas no parâmetro da requisição). Para realizar a busca para mais de uma loja, separar os IDs das lojas com vírgulas. Os IDs buscados são identificadores únicos para cada pedido dentro do Delivery Direto. É possível adicionar um filtro adicional para realizar a busca pelo status do pedido no Delivery Direto.

Parâmetro Requerido Formato Descrição
login Sim string E-mail do usuário cadastrado no Delivery Direto.
senha Sim string Senha do usuário cadastrado no Delivery Direto
key Sim string Chave exclusiva de cada integração
idFrn Sim integer Código que identifica a loja na qual será realizada a busca. É necessário que o login esteja vínculado com a loja desejada.
contentType Sim string Define o formato do retorno. Opções: ‘xml’ ou ‘json’
data Sim string String contendo a data da busca, no formato “aaaa-MM-dd HH:mm:ss”
status Não string Filtro por situação do pedido no sistema. É possível filtrar por mais de um valor, bastando separá-los por vírgula. Caso não seja utilizado, pedidos de todos os status serão retornados, excetuando os ocultos e cancelados. Valores possíveis: ’00’: EM ESPERA ’01’: ACEITO ’02’: EM TRÂNSITO/PRONTO PARA RETIRADA ’03’: ENTREGUE ’04’: RETIRADO ’05’: RECUSADO ’06’: OCULTO ’07’: ATENÇÃO ’08’: CANCELADO

Observação: o status “ATENÇÃO” dos pedidos representa problema problema com pagamento online, ou problema com o processamento do cartão de crédito.

https://deliverydireto.com.br/wspdv/api/selecionaPedidosAlteradosAPartirDe?login=testeapi@teste.com&senha=teste123&key=cYk7Tyxhi3MLvzvGNUIAtMeTads6ALCY&idFrn=18&contentType=json&data=2019-07-06&status=08

Campos-base

Parâmetro Requerido Formato Descrição
status Sim string

Status da resposta. Pode assumir os seguintes valores:

’00’: Sucesso

’01’: Autenticação inválida

’02’: Erro

’03’: Erro inesperado

message Sim string Mensagem referente à resposta
date Sim string Data da resposta, no formato: “dd/MM/yyyy HH:mm:ss”
numFound Sim integer Quantidade de itens encontrados pela busca
body Não array Lista de códigos de pedidos encontrados pela busca

Campos contidos em body

Parâmetro Requerido Formato Descrição
codPedido Sim string

Código identificador único do pedido, no Delivery Direto.

JSON
{
“wspdv-response”: {
“response-status”: “00”,
“response-message”: “7 pedidos encontrados”,
“response-date”: “11/07/2019 19:49:34”,
“response-numFound”: “7”,
“response-body”: {
“@class”: “list”,
“codPedido”: [
66682,
66683,
66684,
66685,
66686,
66687,
66689
]
}
}
}
XML
<wspdv-response>
<response-status>00</response-status>
<response-message>7 pedidos encontrados</response-message>
<response-date>12/07/2019 13:21:54</response-date>
<response-numFound>7</response-numFound>
<response-body class=”list”>
<codPedido>66682</codPedido>
<codPedido>66683</codPedido>
<codPedido>66684</codPedido>
<codPedido>66685</codPedido>
<codPedido>66686</codPedido>
<codPedido>66687</codPedido>
<codPedido>66689</codPedido>
</response-body>
</wspdv-response>

Recuperar informações de um Pedido

https://deliverydireto.com.br/wspdv/api/selecionaPedidos

Recupera informações de um pedido específico identificado por codPedido. Este identificador de pedido pode ser obtido através de chamadas a selecionaPedidosAlteradosAPartirDe.

Parâmetro Requerido Formato Descrição
login Sim string E-mail do usuário cadastrado no Delivery Direto.
senha Sim string Senha do usuário cadastrado no Delivery Direto
key Sim string Chave exclusiva de cada integração
idFrn Sim integer Código que identifica a loja na qual será realizada a busca. É necessário que o login esteja vínculado com a loja desejada.
contentType Sim string Define o formato do retorno. Opções: ‘xml’ ou ‘json’
codPedido Sim string Id do pedido desejado

 

https://deliverydireto.com.br/wspdv/api/selecionaPedidos?login=testeapi@teste.com&senha=teste123&key=cYk7Tyxhi3MLvzvGNUIAtMeTads6ALCY&idFrn=18&contentType=json&codPedido=66687

Campos-base

Parâmetro Requerido Formato Descrição
status Sim string

Status da resposta. Pode assumir os seguintes valores:

’00’: Sucesso

’01’: Autenticação inválida

’02’: Erro

’03’: Erro inesperado

message Sim string Mensagem referente à resposta
date Sim string Data da resposta, no formato: “dd/MM/yyyy HH:mm:ss”
numFound Sim integer Quantidade de itens encontrados pela busca
body Não array Lista de códigos de pedidos encontrados pela busca

Campos contidos em body

Parâmetro Requerido Formato Descrição
codPedido Sim string Código identificador único do pedido, no Delivery Direto.
idPedidoCurto Sim string Código identificado do pedido encurtado.
idFrn Não integer Código que identifica a loja na qual foi realizado o pedido.
dataEntrega Não string Data e horário em que foi realizado a entrega/retirada do pedido, no formato: “dd/MM/yyyy HH:mm:ss”
dataPedido Não string Data e horário de quando o pedido foi feito pelo cliente, no formato: “dd/MM/yyyy HH:mm:ss”
dataAgendamento Não string Data e horário do agendamento (UTC), no formato: “dd/MM/yyyy HH:mm:ss”
togo Sim boolean Representa se o pedido é delivery (true) ou a ser retirado na loja (false)
vlrTaxa Sim double Valor da taxa de entrega
vlrPratos Sim double Valor dos itens do pedido
vlrTroco Sim double Valor do troco solicitado
vlrDesconto Sim double Valor total de desconto
vlrTotal Sim double Valor total do pedido (soma de todos os outros valores)
obsPedido Não string Observações do pedido
condicaoPgto Sim string

Código que representa as formas de pagamento utilizadas. Os códigos são separados por barras. Valores possíveis:

‘DIN’: Dinheiro

‘TRE’: Ticket refeição

‘DEB’: Cartão de débito

‘CRE’: Cartão de crédito

formaPgto Sim string

Detalhes mais extensivos da forma de pagamento: dinheiro, maestro, ticket refeição, visa, mastercard, alelo, american express, etc

codCupom Não string

Código do cupom utilizado no pedido

nome Sim string

Nome do cliente que realizou o pedido

email Não string

Email do cliente que realizou o pedido

dddTelefone Não string

DDD do telefone do cliente que realizou o pedido. Formato: ”XX”

numTelefone Não string

Número do telefone do cliente que realizou o pedido. Formato:“XXXXXXXXX”

telefones Não array

Lista de telefones do cliente que realizou o pedido

logradouro Não string

Logradouro do endereço do cliente

logradouroNum Não string

Número do endereço do cliente

cidade Não string

Cidade do endereço do cliente

estado Não string

Estado (UF) do endereço do cliente

bairro Não string

Bairro do endereço do cliente

complemento Não string

Complemento do endereço do cliente

cep Não string

Cep do endereço do cliente, n formato: “XXXXXXX” (sem hífen)

lat Não float

Latitude do endereço do cliente

lng Não float

Longitude do endereço do cliente

minEspera Não integer

Tempo mínimo (em minutos) de espera para o pedido ser entregue

maxEspera Não integer

Tempo máximo (em minutos) de espera para o pedido ser entregue

clienteNovo Sim boolean

Retorna ’true’ caso o cliente tenha uma quantidade de pedidos menor ou igual a 1. Caso contrário retorna ’false’

cpfCliente Não string

CPF do cliente que realizou o pedido

cpfNota Não string

Se requerido pelo cliente, retorna o CPF informado na compra do pedido

status Sim string

A situação do pedido no sistema do Delivery Direto.

Valores possíveis:

‘EM ESPERA’: Pedido aguardando confirmação pelo lojista

‘APROVADO’: Pedido aprovado pelo lojista

‘RECUSADO’: Pedido recusado pelo lojista

‘PRONTO PARA RETIRADA’: Pedido para retirada encontra-se pronto para a retirada

‘EM TRÂNSITO’: Pedido para entrega encontra-se a caminho do cliente

‘RETIRADO’: Pedido para retirada foi retirado pelo cliente

‘ENTREGUE’: Pedido para entrega foi entregue para o cliente

‘OCULTO’: Pedido cancelado pelo lojista, ou pedido agendado em que a data atual não encontra-se próxima da data do agendamento

‘ATENÇÃO’: pedido com problema no pagamento online, ou problema com o processamento do cartão de crédito

 

pagamentos Sim array

Lista de informações refente ao método de pagamento

Campos contidos em telefones

Parâmetro Requerido Formato Descrição
ddd Não string DDD do telefone do cliente que realizou o pedido. Formato: ”XX”
numero Não string Número do telefone do cliente que realizou o pedido. Formato:“XXXXXXXXX”

Campos contidos em pagamentos

Parâmetro Requerido Formato Descrição
codFormaPagto Sim string

Identificador do método de pagamento. Valores possíveis: ‘P00’: ONLINE

P01′: VISA (CRÉDITO) ‘P02’: ALELO ‘P03’: MASTERCARD (CRÉDITO) ‘P04’: AMERICAN EXPRESS ‘P05’: M. MAESTRO (DÉBITO) ‘P06’: TICKET RESTAURANTE ‘P07’: SODEXO ‘P08’: DINHEIRO ‘P09’: REDESHOP ‘P10’: ELO ‘P11’: VR ‘P12’: DINERS CLUB ‘P13’: BANRISUL ‘P14’: GREEN CARD REFEIÇÃO ‘P15’: DISCOVER ‘P16′: VISA ELECTRON (DÉBITO) P17’: HIPERCARD ‘P6005’: AURA ‘P6006’: JCB ‘P6007’: HIPER

descricaoFormaPagto
Sim string

Descrição do método de pagamento

valor Sim double

Valor do pagamento

JSON
{
“wspdv-response”: {
“response-status”: “00”,
“response-message”: “Pedido 66687 encontrado.”,
“response-date”: “12/07/2019 13:43:12”,
“response-body”: {
“@class”: “pedido”,
“codPedido”: “66687”,
“idPedidoCurto”: “66687”,
“dataPedido”: “2019-07-08T19:33:32+00:00”,
“togo”: true,
“vlrTaxa”: 20,
“vlrPratos”: 0.02,
“vlrTroco”: 0,
“vlrDesconto”: 0,
“vlrTotal”: 20.02,
“condicaoPgto”: “CRE”,
“formaPgto”: “AMEX”,
“nome”: “Rafael”,
“dddTelefone”: “11”,
“numTelefone”: “909999999”,
“telefones”: [
{
“ddd”: “11”,
“numero”: “909999999”
}
],
“logradouro”: “Rua Estela”,
“logradouroNum”: “1”,
“cidade”: “São Paulo”,
“estado”: “SP”,
“bairro”: “Vila Mariana”,
“cep”: “04011001”,
“clienteNovo”: false,
“cpfCliente”: “05895571069”,
“status”: “APROVADO”,
“pagamentos”: [
{
“codFormaPagto”: “P04”,
“descricaoFormaPagto”: “AMERICAN EXPRESS”,
“valor”: 20.02
}
]
}
}
}
XML
<wspdv-response>
<response-status>00</response-status>
<response-message>Pedido 1045 encontrado.</response-message>
<response-date>18/04/2016 17:04:23</response-date>
<response-body class=”pedido”>
<codPedido>1045</codPedido>
<idPedidoCurto>1045</idPedidoCurto>
<dataEntrega>24/03/16 14:08</dataEntrega>
<togo>1</togo>
<vlrTaxa>5</vlrTaxa>
<vlrPratos>12</vlrPratos>
<vlrTroco>0</vlrTroco>
<vlrDesconto>30</vlrDesconto>
<vlrTotal>5</vlrTotal>
<nome>Rafael</nome>
<email>rafael.castilho@kekanto.com</email>
<logradouro>Rua Garcia Rodrigues</logradouro>
<logradouroNum>20</logradouroNum>
<cidade>São Paulo</cidade>
<estado>SP</estado>
<bairro>Parque Mandaqui</bairro>
<cep>02422140</cep>
<clienteNovo>0</clienteNovo>
</response-body>
</wspdv-response>

Recuperar informações dos Itens de um Pedido

https://deliverydireto.com.br/wspdv/api/selecionaItens

Recupera os itens de um pedido específico identificado por codPedido. Este identificador de pedido pode ser obtido através de chamadas a selecionaPedidosAlteradosAPartirDe.

Neste caso, utilizamos o termo item para descrever genéricamente tanto produtos quanto opções que são encontrados em um pedido. Opções de um determinado produto aparecem sequencialmente após seu produto-pai nos resultados da busca. As variações às quais a opção pertencem são representadas no nome da opção no formato: “nomeVariação: nomeOpção”.

Parâmetro Requerido Formato Descrição
login Sim string E-mail do usuário cadastrado no Delivery Direto.
senha Sim string Senha do usuário cadastrado no Delivery Direto
key Sim string Chave exclusiva de cada integração
idFrn Sim integer Código que identifica a loja na qual será realizada a busca. É necessário que o login esteja vínculado com a loja desejada.
contentType Sim string Define o formato do retorno. Opções: ‘xml’ ou ‘json’
codPedido Sim string Id do pedido desejado

 

https://deliverydireto.com.br/wspdv/api/selecionaItens?login=test@testeme.com&senha=123456&key=cYk7Tyxhi3MLvzvGNUIAtMeTads6ALCY&idFrn=1&codPedido=1045

Campos-base

Parâmetro Requerido Formato Descrição
status Sim string

Status da resposta. Pode assumir os seguintes valores:

’00’: Sucesso

’01’: Autenticação inválida

’02’: Erro

’03’: Erro inesperado

message Sim string Mensagem referente à resposta
date Sim string Data da resposta, no formato: “dd/MM/yyyy HH:mm:ss”
numFound Sim integer Quantidade de itens encontrados pela busca
body Não array Lista de códigos de pedidos encontrados pela busca

Campos contidos em body

Parâmetro Requerido Formato Descrição
item Sim array Lista de itens do pedido

Campos contidos em item

Parâmetro Requerido Formato Descrição
codPedido Sim string Código identificador único do pedido, no Delivery Direto
sequencia Sim integer Número que indica a ordem do item dentro da lista
quantidade Sim double

Quantidade do item. Para opções (representadas por itens do tipo ‘EXTRA’), a quantidade é igual à quantidade selecionada pelo cliente do restaurante.

Em caso de variações com tipo de cálculo “média”, enviamos a fração equivalente à parte que a opção representa do total

vlrUnitLiq Sim double Valor líquido unitário do item, com o desconto (se existir) já subtraído
codProdutoBasePdv Não string Código do produto-base (representado por item do tipo ‘CUSTOM’)
codProdutoPdv Sim string

Código do item para a utilização do sistema parceiro

codTipoProdutoPdv Sim string

Código que representa o tipo de item sendo expresso.

Valores possíveis:

‘FIXED’: produto sem opções

‘CUSTOM’: produto com opções

‘EXTRA’: opções de um produto. Aparece sequencialmente apos o produto ‘CUSTOM’

descricao Sim string Nome do item
codUnidade Não string Campo não utilizado
obsItem Não string Observação do item
grupoExtra Não integer Identificador do agrupamento de uma opção, determinada pela configuração da variação no cardápio da loja
tipoCalculo Não string

Método de cálculo da variação (representada por grupoExtra).

Valores possíveis:

‘SOMA’: o valor total da variação é dado pela soma de todas as opções selecionadas

‘MEDIA’: o valor total da variação é dado pela soma de todas as opções selecionadas, dividida pela quantidade de opções selecionadas

‘MAIOR’: o valor total da variação é dado pelo maior valor dentre os valores das opções selecionadas

‘MENOR’: o valor total da variação é dado pelo menor valor dentre os valores das opções selecionadas

XML

<wspdv-response>
<response-status>00</response-status>
<response-message>Foram encontrados 1 itens para o pedido
66715.</response-message>
<response-date>12/07/2019 14:23:08</response-date>
<response-body class=”list”>
<item>
<codPedido>66715</codPedido>
<sequencia>1</sequencia>
<quantidade>1</quantidade>
<vlrUnitLiq>9.99</vlrUnitLiq>
<codProdutoPdv/>
<codTipoProdutoPdv>FIXED</codTipoProdutoPdv>
<codUnidade>unid</codUnidade>
<obsItem/>
<descricao>Especial Burger</descricao>
</item>
</response-body>
<response-numFound>1</response-numFound>
</wspdv-response>

Atualizar o status de um Pedido

https://deliverydireto.com.br/wspdv/api/confirmaProcessamento

Atualiza o status de um determinado pedido no Delivery Direto. A atualização deve respeitar a sequência de transição entre estados do Delivery Direto.

Parâmetro Requerido Formato Descrição
login Sim string E-mail do usuário cadastrado no Delivery Direto.
senha Sim string Senha do usuário cadastrado no Delivery Direto
key Sim string Chave exclusiva de cada integração
idFrn Sim integer Código que identifica a loja na qual será realizada a busca. É necessário que o login esteja vínculado com a loja desejada.
contentType Sim string Define o formato do retorno. Opções: ‘xml’ ou ‘json’
codPedido Sim string Id do pedido desejado
status Não string Novo status que o pedido irá assumir. Valores possíveis: ‘WAI’: Pedido em espera ‘APP’: Pedido aprovado e em produção ‘TRA’: Pedido em trânsito (para pedidos de entrega) ou pronto para ser retirado (para pedidos de retirada) ‘PRO’: Pedido processado, ou seja, entregue (para pedidos de entrega) ou retirado (para pedidos de retirada) ‘REJ’: Pedido recusado (apenas para pedidos que ainda não foram aceitos) ‘ERR’: Pedido cancelado (apenas para pedidos aceitos ou pedidos em trânsito/prontos retirada)
motivo Não string Motivo da rejeição ou do cancelamento do pedido

 

https://deliverydireto.com.br/wspdv/api/alteraStatusProduto?contentType=json&idFrn=18&login=test@testeme.com&senha=123456&key=cYk7Tyxhi3MLvzv&codProduto=102931&status=00

Campos-base

Parâmetro Requerido Formato Descrição
status Sim string

Status da resposta. Pode assumir os seguintes valores:

’00’: Sucesso

’01’: Autenticação inválida

’02’: Erro

’03’: Erro inesperado

message Sim string Mensagem referente à resposta
date Sim string Data da resposta, no formato: “dd/MM/yyyy HH:mm:ss”
body Sim boolean Retorna ‘true’ se atualização foi sucesso, ‘false’ caso contrário

JSON

{
“wspdv-response”: {
“response-status”: “00”,
“response-message”: “Status de 2 produtos atualizados.”,
“response-date”: “08/07/2020 15:58:24”,
“response-body”: true
}
}