Atributos
Pares de chave/valor JSON no corpo da solicitação
POST | https://api.zonos.com/v1/orders
HEADER zonos-version: 2021-01-01
O cabeçalho acima é uma entrada obrigatória para que esta solicitação de pedido completo seja concluída com sucesso.
| Campo | Notas |
|---|---|
account_order_id OPCIONAL | O número do pedido em formato de string. |
landed_cost_id OBRIGATÓRIO | O identificador único de landed cost para o comerciante ou exportador. |
parties OBRIGATÓRIO | Uma lista das partes envolvidas no envio. Isso inclui as informações da parte que está enviando o pacote, recebendo o pacote, intermediando o pacote e responsável pelo pagamento de taxas e impostos. Fornecer as partes ship_from e ship_to é obrigatório. |
parties.city OBRIGATÓRIO | Uma string para a cidade, bairro, distrito ou vila do endereço da parte listada. |
parties.contact_email OBRIGATÓRIO | Uma string para o e-mail de contato. |
parties.contact_name OBRIGATÓRIO | Uma string para o nome de contato. |
parties.contact_phone OBRIGATÓRIO | O número de telefone de contato. |
parties.company_name OPCIONAL | O nome da empresa. |
parties.country OBRIGATÓRIO | O país, representado por um código ISO de duas letras. |
parties.line1 OBRIGATÓRIO | Uma string para a linha 1 do endereço. |
parties.line2 OBRIGATÓRIO | Uma string para a linha 2 do endereço. |
parties.postal_code OBRIGATÓRIO | Uma string para o código postal. Opcional para ship_to dependendo do país de importação. |
parties.state OPCIONAL | Uma string para o código do estado quando disponível. Apenas necessário no Canadá e no Brasil para ship_to. |
parties.tax_id OPCIONAL | A parte ship_to deve fornecer um ID fiscal para importar para países como o Brasil. Se não for fornecido para remessas para o Brasil, a remessa será retida na alfândega até que o destinatário possa ser contatado para fornecer o ID fiscal. Se o destinatário não puder ser contatado, as entregas provavelmente serão atrasadas, resultando potencialmente em pacotes devolvidos ou abandonados. |
parties.type OBRIGATÓRIO | O tipo de parte que as informações fornecidas representam. Os valores possíveis incluem ship_to, ship_from, shipper, sold_to, duties_taxes_payor e broker. |
test OPCIONAL | Se preenchido com o valor true, você não será faturado por encargos relacionados a este pedido. |
tracking_numbers OPCIONAL | Uma lista para os números de rastreamento do pedido. |
Exemplo de solicitação
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_order_id": "123456",
"landed_cost_id": "ldct_1LOYliG6NmEu31cVkvGHvv",
"parties": [
{
"city": "Campinas",
"contact_email": "info@example.com",
"contact_name": "Jean-Luc Picard",
"contact_phone": "1234567890",
"company_name": "Starfleet",
"country": "BR",
"line1": "49 Chapadao Rua",
"line2": null,
"postal_code": "75828-000",
"state": "SP",
"tax_id": "12-3456789",
"type": "ship_to"
}
],
"tracking_numbers": ["1Z12345E0205271688"]
}
Resposta de exemplo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"id": "ordr_5LwjnR9AW6L9eXs9lfeMC7",
"landed_cost_id": "ldct_1LOYliG6NmEu31cVkvGHvv",
"account_order_id": "123456",
"zonos_order_id": "1000151",
"parties": [
{
"id": "prty_12165151351",
"city": "Campinas",
"contact_email": "info@example.com",
"contact_name": "Jean-Luc Picard",
"contact_phone": "1234567890",
"company_name": "Starfleet",
"country": "BR",
"line1": "49 Chapadao Rua",
"line2": null,
"line3": null,
"postal_code": "75828-000",
"state": "SP",
"tax_id": "12-3456789",
"type": "ship_to"
}
],
"tracking_numbers": ["1Z12345E0205271688"]
}
Solicitar um pedido completo
Explore os pares de chave/valor em uma solicitação de pedido completo.
A API de Pedido Completo permite que você crie uma nova solicitação para informações de pedido concluído, fornecendo detalhes essenciais para um processamento preciso. Esta API garante a conclusão bem-sucedida do pedido especificando informações vitais sobre as partes envolvidas e os números de rastreamento, entre outros campos obrigatórios.