Obtenha métodos de envio com base nos parâmetros de endereço e pacote.
Lista métodos de devolução para o parceiro especificado com parâmetros adicionais como disponibilidade.
POST /v1/shipping-methods/quote
Exemplo de solicitação
{ "orderReferenceId": "EXMPL0001234", "currency": "EUR", "options": { "weightUnit": "g", "dimensionUnit": "mm", "label": { "format": "pdf" } }, "partner": { "clientName": "ExampleCustomer" }, "receiver": { "person": { "firstName": "Foo", "lastName": "Bar", "company": "", "email": "[email protected]", "phone": "01273552886" }, "address": { "country": "GB", "state": "East Sussex", "city": "Brighton", "postcode": "BN1 8YQ", "addressLine1": "11 London Rd", "addressLine2": "", "addressLine3": "", "street": "London Rd", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": null } }, "sender": { "person": { "firstName": "", "lastName": "", "company": "Example Company", "email": "[email protected]", "phone": "01666 123456" }, "address": { "country": "DE", "state": "", "city": "Donauwörth", "postcode": "86609", "addressLine1": "Am Wassergraben 11", "addressLine2": null, "addressLine3": null, "street": "Am Wassergraben", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": "DE123456789000", "iossNumber": null, "eoriNumber": "GB987654321000", "pcccNumber": null, "australianBusinessNumber": null } }, "packages": [ { "packageReferenceId": "EXMPL0001234-0-1", "grossWeight": 810, "netWeight": 760, "length": 229, "width": 200, "height": 36, "boxType": "rectangle", "volumetricWeight": 700, "items": [ { "itemReferenceId": "EXMPL0001234-0-1-ITEM1", "description": "Mug", "value": 48, "quantity": 4, "weight": 760, "hsCode": "44199090", "countryOfOrigin": "DE" } ] } ]}Exemplo de resposta de sucesso
{ "items": [ { "carrier": { "name": "DHL", "uid": "dhl" }, "method": { "name": "DHL Global Parcel", "uid": "dhl_global_parcel", "price": 3.32, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } }, { "carrier": { "name": "UPS", "uid": "ups" }, "method": { "name": "UPS Standard Tariff", "uid": "ups_standard_tariff", "price": 5.25, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } } ], "count": 2}Exemplo de resposta de erro
{ "orderReferenceId": "EXMPL0001234", "code": "VALIDATION_ERROR", "message": "There are errors in submitted data", "errors": [ { "code": "NO_SUCH_CHOICE_ERROR", "reference": "options.label.format", "message": "The value you selected is not a valid choice." }, { "code": "IS_BLANK_ERROR", "reference": "receiver.address.country", "message": "This value should not be blank." } ]}Request
Parameter | Tipo | Descrição |
orderReferenceId (obrigatório) | string | ID único para pedido de envio. ID fornecido por você. |
moeda (obrigatório) | string | Moeda do pedido de envio em formato de 3 letras. |
opções (opcional) | Opções | Parâmetros opcionais. |
parceiro (opcional) | Parceiro | Detalhes do parceiro. |
destinatário (obrigatório) | Destinatário | Detalhes do destinatário. |
remetente (obrigatório) | Remetente | Detalhes do remetente. |
pacotes (obrigatório) | Package[] | Detalhes do pacote. |
Opções
Parameter | Tipo | Descrição |
unidade de peso (opcional) | string | Unidade de peso. Opções disponíveis: g, kg, oz, lb. Por padrão: g. |
unidade de dimensão (opcional) | string | Unidade de comprimento. Opções disponíveis: mm, cm, in. Por padrão: mm. |
rótulo (opcional) | Label | Configurações de formato de etiqueta. |
Label
Parameter | Tipo | Descrição |
formato (opcional) | string | Formato da etiqueta. Opções disponíveis: pdf, zpl (*). Por padrão: pdf. |
Nota: Formatos diferentes de pdf podem não estar habilitados para determinadas transportadoras.
Parceiro
Parameter | Tipo | Descrição |
clientName (opcional) | string | Perfil de cliente para envio. |
Destinatário
Parameter | Tipo | Descrição |
pessoa (obrigatório) | Destinatário | Dados pessoais do destinatário. |
endereço (obrigatório) | Endereço | Detalhes do endereço do destinatário. |
alfândega (opcional) | Alfândega do Destinatário | Detalhes alfandegários do destinatário. |
Remetente
Parameter | Tipo | Descrição |
pessoa (obrigatório) | Remetente | Dados pessoais do remetente. |
endereço (obrigatório) | Endereço | Detalhes do endereço do remetente. |
alfândega (obrigatório para envios internacionais) | Alfândega do Remetente | Detalhes alfandegários do remetente. |
Destinatário
Parameter | Tipo | Descrição |
nome (obrigatório) | string | Nome do destinatário. |
sobrenome (obrigatório) | string | Sobrenome da pessoa destinatária. |
empresa (opcional) | string | O título da empresa. |
e-mail (opcional*) | string | Endereço de e-mail da pessoa. Isso pode ser usado para notificações de envio. |
telefone (opcional*) | string | Número de telefone da pessoa. Isso pode ser usado para notificações de envio. |
Nota: *E-mail e telefone podem ser campos obrigatórios dependendo da transportadora
Remetente
Parameter | Tipo | Descrição |
nome (opcional) | string | Nome do remetente. |
sobrenome (opcional) | string | Sobrenome da pessoa remetente. |
empresa (obrigatório) | string | O título da empresa remetente. |
e-mail (opcional*) | string | Endereço de e-mail da pessoa / empresa remetente. |
telefone (opcional*) | string | Número de telefone da pessoa / empresa remetente. |
Nota: *E-mail e telefone podem ser campos obrigatórios dependendo da transportadora
Endereço
Parameter | Tipo | Descrição |
país (obrigatório) | string | Código do país no formato de 2 letras. |
estado (opcional*) | string | Estado / município / região. |
cidade (obrigatório) | string | Cidade. |
CEP (obrigatório) | string | CEP. |
endereço linha 1 (obrigatório) | string | Primeira linha do endereço postal. Deve incluir rua e número da casa. |
linha de endereço 2 (opcional) | string | Segunda linha do endereço postal. Número do apartamento / escritório / andar. |
linha de endereço 3 (opcional) | string | Terceira linha do endereço postal. |
rua (opcional*) | string | Rua (obrigatório para endereços na DE). |
número da casa (opcional*) | string | Número da casa (obrigatório para endereços na DE). |
bairro (opcional*) | string | Bairro (obrigatório para endereços na AU / NZ). |
Nota: *Estes campos opcionais são obrigatórios para países e transportadoras específicos.
Alfândega do Destinatário
Parameter | Tipo | Descrição |
Número de IVA (opcional) | string | Número de IVA do destinatário. |
Alfândega do Remetente
Parameter | Tipo | Descrição |
Número de IVA (opcional*) | string | Número de IVA do remetente. |
número ioss (opcional*) | string | Número IOSS do remetente. |
número EORI (opcional*) | string | Número EORI do remetente. |
pcccNumber (opcional*) | string | Número PCCC do remetente. |
número de empresa australiano (opcional*) | string | Número de negócio australiano do remetente. |
Nota: *Dependendo do país do remetente e do destinatário, esses campos podem ser obrigatórios.
Pacote
Parameter | Tipo | Descrição |
packageReferenceId (obrigatório) | string | ID do pacote fornecido pelo parceiro. |
peso bruto (obrigatório) | número | Peso da embalagem + peso dos itens (em gramas por padrão). |
peso líquido (opcional) | número | Peso dos itens (em gramas por padrão). |
comprimento (obrigatório) | número | Comprimento do pacote (em mm por padrão). |
largura (obrigatório) | número | Largura do pacote (em mm por padrão). |
altura (obrigatório) | número | Altura do pacote (em mm por padrão). |
peso volumétrico (opcional) | número | Peso calculado com base no tamanho do pacote (em gramas por padrão). |
tipo de caixa (opcional) | string | Formato da caixa (ex.: retângulo, tubo). |
valor (obrigatório para envios internacionais) | número | Valor total de todos os itens na embalagem (na moeda selecionada). |
itens (obrigatório para envios internacionais) | Item[] | Matriz de itens no pacote. |
Item*
Parameter | Tipo | Descrição |
itemReferenceId (obrigatório) | string | ID fornecido pelo parceiro do item do pacote. |
descrição (obrigatório) | string | Descrição do item. |
quantidade (obrigatório) | número | Quantidade do item. |
valor (obrigatório) | número | Valor do item (na moeda selecionada). |
peso (obrigatório) | número | Peso do item (em gramas por padrão). |
código HS (obrigatório) | string | Código do Sistema Harmonizado (Wiki). |
país de origem (obrigatório) | string | Código do país no formato de 2 letras onde o item foi produzido. |
Nota: *Todos os parâmetros do Item são necessários apenas para envios internacionais.
Resposta bem-sucedida
Parameter | Tipo | Descrição |
contagem | número | Número de resultados encontrados. |
Itens | Itens de resposta | Uma matriz das cotações |
Itens de resposta
Parameter | Tipo | Descrição |
transportadora | TransportadoraDeItensDeResposta | Detalhes da transportadora. |
método | ResponseItemsMethod | Detalhes do método de envio. |
TransportadoraDeItensDeResposta
Parameter | Tipo | Descrição |
transportadora | string | Transportadora utilizada para o pedido. |
uid | string | Método de envio utilizado para o pedido. |
ResponseItemsMethod
Parameter | Tipo | Descrição |
nome | string | Nome do método de envio. |
uid | string | UID do método de envio. |
preço | número | Preço estimado do método de envio para o parceiro. |
maxShipmentDays | número | Número máximo de dias para o método de envio. |
diasMínimoDeEnvio | número | Dias mínimos de envio do método de entrega. |
deliveryPaddingDays (opcional) | número | Dias de margem para entrega do método de envio. |
Resposta de erro
Parameter | Tipo | Descrição |
orderReferenceId | string | ID único para pedido de envio fornecido por você. |
código | string | Código de erro. |
mensagem | string | Mensagem de erro. |
detalhe (opcional) | objeto | Mensagem de erro detalhada (objeto JSON de uma estrutura arbitrária). |
erros (opcional) | ResponseErrorDetails[] | Matriz de erros. |
Detalhes do Erro de Resposta
Parameter | Tipo | Descrição |
código | string | Código de erro. |
mensagem | string | Mensagem de erro |
referência (opcional) | string | ID de referência. |
Próximo Passo: 🔗[GCL] Logistics API - Tracking
📝 Não é o que você precisava?
Ajude-nos a melhorar este artigo, envie-nos um e-mail para [email protected] — por favor, inclua o título do artigo.