Endpoints
Solicitar detalhes do pedido concluído
POST | https://api.iglobalstores.com/2.0/order-completed - Crie uma nova solicitação de informações relacionadas a um pedido concluído.
Solicitação HTTPS
| Campo | Notas |
|---|---|
| Método HTTP | POST |
| URL do Endpoint | https://api.iglobalstores.com/2.0/order-completed |
| Protocolo | HTTPS |
| Formato da mensagem | JSON |
| Cabeçalho HTTP de aceitação | Accept: application/json |
| Cabeçalho HTTP do token de segurança | serviceToken: seu-valor-de-token-de-testeAdicione um cabeçalho à sua solicitação HTTPS chamado serviceToken com um valor do seu token de API de segurança de teste. (Entre em contato com seu Gerente de Conta para obter este token.) |
| Cabeçalho HTTP de tipo de conteúdo | Content-Type: application/jsonComo você estará enviando dados JSON para o serviço, adicione um cabeçalho à sua solicitação HTTPS chamado Content-Type com um valor de application/json |
Pares chave/valor JSON no corpo da solicitação
Formato da Mensagem: JSON
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
22
23
24
25
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Definições JSON da solicitação
| Campo | Notas |
|---|---|
billingAddress OBRIGATÓRIO | Este é o endereço de faturamento do pedido. Este é um mapa contendo os seguintes campos de endereço: address1, address2, address3, city, state, stateCode, postalCode e countryCode. Esses campos contidos são ou obrigatórios ou não obrigatórios com base no país. O endpoint de localização retorna quais campos de endereço específicos são necessários ou não para cada país. Observação: stateCode sempre não é necessário e não é declarado no endpoint de localização. Você pode passar stateCode, se disponível. |
billingCompany OPCIONAL | Este é o nome da empresa de faturamento do pedido. |
billingEmail OBRIGATÓRIO | Este é o endereço de e-mail de faturamento do pedido. |
billingName OBRIGATÓRIO | Este é o nome completo de faturamento do pedido. |
billingPhone OBRIGATÓRIO | Este é o número de telefone de faturamento do pedido. |
items[index].orderGrandTotal OBRIGATÓRIO | Este é o total pago pelo comprador pelo seu pedido em USD (Dólares Americanos). Por favor, forneça sem vírgulas, sem o símbolo de dólar "$" e com duas casas decimais. Valor de exemplo: 2102.99 |
items[index].orderNumber OBRIGATÓRIO | Este é o número do seu pedido para o pedido recém-completado. Valor de exemplo: 854725421 |
paymentTypeCode OBRIGATÓRIO | O método de pagamento usado pelo comprador para pagar pelo seu pedido. Valores de exemplo: PayPal ou Visa ou MC ou AMEX ou DISC |
prepaidDutyTax OBRIGATÓRIO | O comprador optou por prepay seus impostos e taxas de importação ou foi obrigado a prepay-los? Se sim, defina como verdadeiro; se não, defina como falso. Valores de exemplo: true ou false |
shippingQuoteId OBRIGATÓRIO | Este é o ID da cotação de frete escolhida pelo comprador. Os detalhes do carrinho precisam ser os mesmos que eram quando as cotações de frete foram obtidas. Se os detalhes do carrinho tiverem mudado, então você deveria ter solicitado novas cotações de frete antes de completar o pedido do comprador. |
shipToCompany OPCIONAL | Este é o nome da empresa da pessoa que receberá o pedido enviado. |
shipToEmail OBRIGATÓRIO | Este é o endereço de e-mail da pessoa que receberá o pedido enviado. |
shipToName OBRIGATÓRIO | Este é o nome completo da pessoa que receberá o pedido enviado. |
shipToPhone OBRIGATÓRIO | Este é o número de telefone da pessoa que receberá o pedido enviado. |
Resposta HTTPS
Formato da mensagem: JSON
Exemplo de resposta apenas para Canadá e Austrália
Nota: As respostas reais conterão todos os países suportados.
Exemplo de resposta
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Definições JSON de resposta
| Campo | Notas |
|---|---|
deniedParty | Este é um mapa dos resultados da triagem de partes negadas. Se definido como nulo, então a triagem de partes negadas não foi realizada. Entre em contato com seu representante da Zonos se encontrar isso. |
deniedParty.flagged | Se este pedido correspondeu ou não a um registro nas listas consolidadas de partes negadas da Zonos. Se verdadeiro, revise este pedido antes de processá-lo. Em caso de dúvida, não processe um pedido que esteja marcado como verdadeiro. Valores de exemplo: verdadeiro ou falso |
deniedParty.source | Se o campo marcado foi definido como verdadeiro, este campo conterá referências de origem úteis para revisar por que o pedido foi marcado como correspondente a uma parte negada. |
igOrderId | Identificador da Zonos para o pedido recém-completado. Valor de exemplo: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
API Legacy Order Completed
Saiba como a API Legacy Order Complete funciona.O endpoint Order Completed aceita os detalhes finais do pedido do comprador, verifica os detalhes do pedido para partes negadas e retorna os resultados juntamente com um ID de pedido específico da Zonos.