Detalhes do Pedido

Saiba como funciona o endpoint de Detalhes do Pedido.

O endpoint orderDetail é utilizado para recuperar com segurança os detalhes e o status do pedido concluído através do Zonos Checkout.

Endpoint

Nota: As chaves de resposta podem ser modificadas e/ou chaves adicionais podem ser adicionadas. Se você for utilizar o endpoint, por favor configure o seu código para acomodar essas possibilidades.

POST | `https://api.iglobalstores.com/v2/orderDetail`

Requisição HTTPS

campo	notas
Método HTTP	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protocolo	HTTPS
Formato da Mensagem	JSON
Cabeçalho HTTP Accept	Accept: application/json
Cabeçalho HTTP Content-Type	Content-Type: application/json

Pares chave/valor JSON no corpo da requisição

campo	notas
`orderId` OPCIONAL, se passando o parâmetro `referenceId`	O Id do pedido da Zonos pode ser passado com ou sem o Id da sua loja e hífen (Exemplo: 123-45678 ou 45678). Observação: Após a conclusão do pedido e pagamento, o cliente será redirecionado para uma página de Conclusão de Pedido / Agradecimento de Pedido hospedada no seu domínio. A URL conterá um parâmetro de querystring "orderId" que conterá esse valor. `inteiro / string`
`referenceId` OPCIONAL, se passando o parâmetro “orderId”	Este parâmetro é utilizado para buscar os dados de um pedido pelo `referenceId` único passado no endpoint de Serviço da API `createTempCart`. Este parâmetro deve ser omitido ou nulo quando se pretende buscar os detalhes do pedido com base no parâmetro `orderId`. `string`
`secret` OBRIGATÓRIO	GUID secreto da API fornecido pela Zonos`string`
`storeId` OBRIGATÓRIO	ID da loja fornecido pela Zonos.`inteiro`

Respostas de erro HTTP

Código de Erro	mensagem	significado
415	Tipo de mídia não suportado	Entidade HTML. O cabeçalho HTTP "Content-Type" é inválido.
406	Não Aceitável	Entidade HTML. O cabeçalho HTTP "Accept" é inválido.
400	Solicitação Inválida	“error”:”orderId: 999-99999 não é um orderId válido”“error”:”Não foi possível encontrar um pedido com orderId: 999-99999”“error”:”Credenciais de segurança inválidas”“error”:”Corpo do post inválido”“error”:”Parâmetro orderId ou referenceId é obrigatório”“error”:”Não é possível especificar ambos os parâmetros orderId e referenceId”“error”:”Nenhum pedido encontrado com orderId: 999-99999”“error”:”Parâmetro store obrigatório”“error”:”Nenhum pedido encontrado com referenceId: 999999 para storeId: 999”“error”:”referenceId: 999999 para storeId: 999 foi duplicado”“error”:”Não foi possível recuperar o pedido com referenceId: 999999”
500	Erro Interno do Servidor	“error”:”Não foi possível processar os detalhes do pedido”

Definições JSON de resposta

campo	notas
`error`	Este parâmetro está presente apenas quando ocorre um erro e conterá uma descrição do erro.`string`
`order`	Este é um mapa dos detalhes do pedido.`JSON string`
`order.billingZip`	Endereço de faturamento para o pedido - os valores foram inseridos no Zonos Checkout.`string`
`orderboxCount`	Este campo descreve as caixas que serão usadas para enviar o pedido, passadas na solicitação createTempCart .`string`
`order.carrierAccountNumber`	Número da conta de transporte própria do visitante; usado quando as contas de transporte do visitante estão habilitadas`string`
`order.carrierAccountShippingMethod`	O método de envio selecionado na conta de transporte própria do visitante; usado quando as contas de transporte do visitante estão habilitadas`string`
`order.cslListMatch`	Correspondência na Lista de Triagem Consolidada (CSL). Um booleano que indica quando as informações do cliente produziram uma correspondência na Lista de Triagem Consolidada dos EUA e devem ser revisadas quanto a uma possível afiliação a partes negadas.`boolean`
`order.customerSelectedShippingName`	Nome de exibição da opção de envio dentro do Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Um mapa da divisão de impostos/direitosNota - Se aplicável, a Taxa de Processamento Internacional (IPF) não está incluída.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Valor da taxa de corretagem em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Valor da taxa de desembolso em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.duty`	Valor dos direitos em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Valor da taxa de pré-pagamento em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Valor do IVA/imposto sobre a taxa de desembolso em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.vatTax`	Valor do IVA/imposto em USD, não inclui o IVA/imposto sobre a taxa de desembolso; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesTotal`	Total de direitos e impostos em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.foreignCurrencyCode`	O código da moeda na qual o pagamento do pedido foi liquidado.`string`
`remittance_amount`	O valor do dinheiro que precisa ser remetido para um país específico (por exemplo, VAT do Reino Unido).`decimal`
`order.grandTotal`	Total geral em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.grandTotalForeign`	Total geral na moeda liquidada; ponto flutuante positivo, duas casas decimais`integer`
`order.items`	Uma lista de mapas de itensO mapa de itens contém detalhes sobre o item que foram passados para o Zonos Checkout durante a criação do carrinho temporárioPara mais detalhes sobre as propriedades do item, por favor, revise a documentação da API createTempCart `JSON string`
`order.itemsCount`	Contagem de itens do pedido`integer`
`order.itemsTotal`	Total de itens/produtos em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.itemsTotalForeign`	Total de itens/produtos na moeda liquidada; ponto flutuante positivo, duas casas decimais`integer`
`order.items[index].height`	Ponto flutuante positivo, duas casas decimais`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Ponto flutuante positivo, duas casas decimais`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Ponto flutuante positivo, duas casas decimais `inteiro`
`order.items[index].width`	Ponto flutuante positivo, duas casas decimais `inteiro`
`order.items[index].unitPrice`	Ponto flutuante positivo, duas casas decimais `inteiro`
`order.merchantOrderId`	`MerchantOrderId` associado ao pedido através do endpoint de serviço updateMerchantOrderId. `string`
`order.misc1`	Valor adicional associado ao pedido através do endpoint de serviço createTempCart. `string`
`order.misc2`	Valor adicional associado ao pedido através do endpoint de serviço createTempCart. `string`
`order.misc3`	Valor adicional associado ao pedido através do endpoint de serviço createTempCart. `string`
`order.misc4`	Valor adicional associado ao pedido através do endpoint de serviço createTempCart. `string`
`order.misc5`	Valor adicional associado ao pedido através do endpoint de serviço createTempCart. `string`
`order.misc6`	Valor adicional associado ao pedido através do endpoint de serviço createTempCart. `string`
`order.nationalIdentifier`	Informações adicionais de endereço de faturamento internacional para o pedido quando necessário. Os valores foram inseridos no Zonos Checkout. `string`
`order.notes`	Uma lista de mapas de notas; o mapa de notas contém detalhes sobre a nota do pedido. `string JSON`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Um booleano indicando se esta foi uma nota criada pelo cliente sobre o pedido, envio, etc. `boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Um booleano indicando se esta nota foi marcada como importante
`order.notes[index].note`	O conteúdo da nota `string`
`order.optInEmail`	Indica que o cliente selecionou a caixa de seleção para "inscrever-se em nossa newsletter" dentro do Zonos Checkout. Aplicável apenas se você optou por exibir esta caixa de seleção na página de checkout. `boolean`
`order.orderId`	O número de identificação do pedido no sistema Zonos. `string`
`order.orderDate`	O timestamp de criação do pedido em millis no UTC/GMT. `millis`
`order.orderDateString`	O timestamp de criação do pedido em string no UTC/GMT. `string`
`order.orderStatus`	O status/estado do pedido no sistema Zonos. Para mais detalhes sobre o uso de `orderStatus`, por favor, revise o documento Recuperar um pedido aqui. Informações adicionais sobre os status do pedido podem ser encontradas no documento Atualizar um pedido aqui. `string`
`order.orderStatusDate`	O timestamp em millis no UTC/GMT da mudança mais recente de `orderStatus` no sistema Zonos. `millis`
`order.orderStatusDateString`	O timestamp em string no UTC/GMT da mudança mais recente de `orderStatus` no sistema Zonos. `string`
`order.paymentProcessing`	Um mapa dos detalhes de `paymentProcessing`. Alguns parâmetros podem não ser aplicáveis à sua conta e serão excluídos da resposta. `string JSON`
`order.paymentProcessing.captureDate`	A data de captura do pagamento em millis, se disponível. Se o Zonos estiver processando o pagamento, este nó será excluído da resposta. `millis`
`order.paymentProcessing.captureDateString`	A data de captura do pagamento em string, se disponível. Se o Zonos estiver processando o pagamento, este nó será excluído da resposta. `string`
`order.paymentProcessing.cardType`	Marca do cartão de crédito. Se o Zonos estiver processando o pagamento, este nó será excluído da resposta. `string`
`order.paymentProcessing.lastFour`	Os últimos quatro números do número do cartão de crédito de faturamento. Se o Zonos estiver processando o pagamento, este nó é excluído da resposta. `string`
`order.paymentProcessing.paymentGateway`	Nome do gateway de pagamento. Se o Zonos estiver processando o pagamento, indicará "iGlobal_CC" ou "iGlobal_PayPal". `string`
`order.paymentProcessing.transactionType`	Indica o tipo de transação "AUTH_CAPTURE" ou "AUTH_ONLY". Se o Zonos estiver processando o pagamento, este nó é excluído da resposta. `string`
`order.poNumber`	Um número de ordem de compra para a ordem especificada dentro do Zonos Checkout; usado quando as ordens de compra estão habilitadas. `string`
`order.quotedDutyTaxes`	Deveres e impostos cotados no Zonos Checkout, exibidos em USD; ponto flutuante positivo, duas casas decimais. `integer`
`order.quotedDutyTaxesForeign`	Deveres e impostos cotados no Zonos Checkout. Exibido na moeda liquidada; ponto flutuante positivo, duas casas decimais. `integer`
`order.referenceId`	`referenceId` único associado à ordem através do serviço de endpoint da API createTempCart. `string`
`order.shipComplete`	Indica se a ordem deve ser enviada em várias partes. `boolean`
`order.shippingCarrierServiceLevel`	Identificador do transportador e nível de serviço para a opção de envio selecionada. `string`
`order.shippingInstructions`	Instruções personalizáveis para o nível de serviço de envio. `string`
`order.shippingTotal`	Total de envio em USD; ponto flutuante positivo, duas casas decimais. `integer`
`order.shippingTotalForeign`	Total de envio na moeda liquidada; ponto flutuante positivo, duas casas decimais. `integer`
`order.testOrder`	Indica se a ordem é um pedido de teste. `boolean`
`order.trackingNumber`	Número de rastreamento gerado para o envio, se aplicável. `string`
`order.zip`	Endereço de destino / envio para a ordem - os valores foram inseridos no Zonos Checkout ou foram passados para a ordem através do redirecionamento para o Zonos Checkout. `string`

Tipos de dados adicionais:

order.address1
order.address2
order.address3
order.altPhone
order.billingAddress1
order.billingAddress2
order.billingAddress3
order.billingAltPhone
order.billingCity
order.birthDate
order.billingCompany
order.billingCountryCode
order.billingCountryName
order.billingEmail
order.billingName
order.billingPhone
order.billingState
order.city
order.company
order.countryCode
order.countryName
order.email
order.items[index].countryOfOrigin
order.items[index].description
order.items[index].imageURL
order.items[index].itemBrand
order.items[index].itemCategory
order.items[index].itemColor
order.items[index].itemCustomization
order.items[index].itemDescriptionDetailed
order.items[index].itemDescriptionLong
order.items[index].itemFabricContent
order.items[index].itemHSCode
order.items[index].itemLtlClass
order.items[index].itemMaterial
order.items[index].itemURL
order.items[index].productId
order.items[index].sku
order.items[index].productId
order.items[index].weightUnits
order.name
order.phone
order.state

Esta página foi útil?

Dúvidas?

Entre em contato conosco.

Ver Zonos

políticas e acordos