🚧

Atenção

Os pedidos são criados e enviados para alocação assim que sua chamada para nossa API é realizada.

🚧

Atenção com o número de pontos de retiradas!

Ao criar um pedido, atualmente só consideramos um pickup.

🚧

Atenção com o endereço!

Os campos lat e lng não são obrigatórios e é extremamente recomendado informar o mais completo possível o endereço, nele contendo Nome da rua, número, Bairro, Cidade, Estado, CEP e caso possua complemento, adicionar no seu respectivo campo!

🚧

Endereços

Quando usado a estimativa pré criação do pedido é recomendável que os parâmetros passados para o nó de address sejam iguais, tanto para criação quanto para estimativa do pedido

Argumentos

NomeTipoDescrição
paymentMethodStringIdentificador da forma de pagamento registrada no sistema
trackingKeyStringIdentificador externo da order
pickupspickupLista de pontos de retiradas
packagespackagesLista de pacotes que serão entregues

PackageOrder

NomeTipoDescrição
recipientrecipientNó com as informações sobre o destinatário
addressaddressNó com as informações sobre o endereço do(a) destinatário/retirada
chargechargeNó com as informações sobre pagamentos
dimensionsdimensionsNó com as dimensões de um pacote

Recipient

NomeTipoDescrição
nameStringCampo para informar o nome do destinatário
emailStringCampo para informar o e-mail do destinatário
phoneStringCampo para informar o telefone do destinatário

Address

NomeTipoDescrição
latStringCampo para informar a latitude do(a) destinatário/retirada
lngStringCampo para informar a longitude do(a) destinatário/retirada
addressStringCampo para informar o endereço do(a) destinatário/retirada
complementStringCampo para informar o complemento do destinatário/retirada

Charge

NomeTipoDescrição
valueStringCampo para informar o valor a ser cobrado
methodIntCampo para informar o método de pagamento
changeStringCampo para informar o valor esperado de troco

Dimensions

NomeTipoDescrição
widthIntCampo para informar a largura do pacote (dado em centimetros)
heightIntCampo para informar altura do pacote (dado em centimetros)
lengthIntCampo para informar o comprimento do pacote (dado em centimetros)
weightIntCampo para informar o peso do pacote (dado em gramas)

Retorno

NomeTipoDescrição
successBooleanCampo que informa se o pedido foi realizado com sucesso
errorserrorsNó contendo informações caso algum erro aconteça
ordersordersNó contendo informações do pedido
Language
Click Try It! to start a request and see the response here!