Qual é o pedido HTTPS da Checkout API?

O pedido HTTPS da Checkout API inclui o método HTTP (POST), o endpoint ('https://api.iglobalstores.com/v2/orderDetail'), o protocolo (HTTPS), o formato da mensagem (JSON) e os cabeçalhos HTTP (Accept: application/json, Content-Type: application/json).

Quais são os pares chave/valor JSON no corpo do pedido?

Os pares chave/valor JSON no corpo do pedido incluem 'orderId', 'referenceId', 'secret' e 'storeId'. 'orderId' e 'referenceId' são opcionais, mas tem de ser enviado um deles. 'secret' e 'storeId' são obrigatórios.

Quais são as possíveis respostas HTTP de erro?

As possíveis respostas HTTP de erro incluem 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request) e 500 (Internal Server Error). Cada código de erro corresponde a um tipo específico de erro.

Quais são as definições do JSON de resposta?

As definições do JSON de resposta incluem vários parâmetros relacionados com os detalhes da encomenda, como 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' e muitos outros. Cada parâmetro fornece informações específicas sobre a encomenda.

Checkout•

InícioReferência da API Checkout REST API Detalhes da encomenda

Detalhes da encomenda

Q: Qual é o endpoint da Checkout API?

O endpoint da Checkout API é 'orderDetail'. Este endpoint da API é utilizado para obter com segurança os detalhes e o estado de uma encomenda concluída através do Zonos Checkout.

Saiba como funciona o endpoint de detalhes da encomenda.

O endpoint orderDetail é utilizado para obter com segurança os detalhes e o estado de uma encomenda concluída através do Zonos Checkout.

Endpoint

Nota: as chaves da resposta podem ser modificadas e/ou podem ser adicionadas novas chaves. Se for utilizar o endpoint, configure o seu código para contemplar estas possibilidades.

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

Pedido 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 do pedido

campo↕	notas↕
`orderId` OPCIONAL, se for enviado o parâmetro `referenceId`	O ID da encomenda Zonos pode ser enviado com ou sem o ID da sua loja e o hífen (exemplo: 123-45678 ou 45678). Nota: após a conclusão da encomenda e do pagamento, o cliente será redirecionado para uma página de conclusão da encomenda / agradecimento alojada no seu domínio. O URL incluirá um parâmetro de query string “orderId” que conterá este valor.`integer / string`
`referenceId` OPCIONAL, se for enviado o parâmetro “orderId”	Este parâmetro é utilizado para consultar os dados de uma encomenda através do `referenceId` único enviado no endpoint `createTempCart` do API Service. Este parâmetro deve ser omitido ou ficar a null quando se pretende consultar os detalhes da encomenda 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.`integer`

Respostas HTTP de erro

Código de erro↕	mensagem↕	significado↕
415	Unsupported media type	Entidade HTML. O cabeçalho HTTP “Content-Type” é inválido.
406	Not Acceptable	Entidade HTML. O cabeçalho HTTP “Accept” é inválido.
400	Bad Request	“error”:”orderId: 999-99999 is not a valid orderId”“error”:”Could not find an order with orderId: 999-99999”“error”:”Invalid security credentials”“error”:”Invalid post body”“error”:”Parameter orderId or referenceId is required”“error”:”Cannot specify both Parameters orderId and referenceId”“error”:”No order found with orderId: 999-99999”“error”:”Parameter store required”“error”:”No order found with referenceId: 999999 for storeId: 999”“error”:”referenceId: 999999 for storeId: 999 has been duplicated”“error”:”Couldn’t retrieve order with referenceId: 999999”
500	Internal Server Error	“error”:”Couldn’t process order details”

Definições do JSON de resposta

campo↕	notas↕
`error`	Este parâmetro só está presente quando ocorre um erro e conterá uma descrição do erro.`string`
`order`	Mapa com os detalhes da encomenda.`JSON string`
`order.billingZip`	Morada de faturação da encomenda - os valores foram introduzidos no Zonos Checkout.`string`
`orderboxCount`	Este campo descreve as caixas que serão utilizadas para enviar a encomenda, enviadas no pedido createTempCart .`string`
`order.carrierAccountNumber`	Número da conta da transportadora do próprio visitante; utilizado quando as contas de transportadora do visitante estão ativadas`string`
`order.carrierAccountShippingMethod`	Método de envio selecionado na conta da transportadora do próprio visitante; utilizado quando as contas de transportadora do visitante estão ativadas`string`
`order.cslListMatch`	Correspondência na Consolidated Screening List (CSL). Booleano que indica quando as informações do cliente produziram uma correspondência na Consolidated Screening List dos EUA e devem ser revistas para verificar uma possível ligação a partes recusadas (denied parties).`boolean`
`order.customerSelectedShippingName`	Nome apresentado da opção de envio no Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Mapa da discriminação de direitos/impostosNota - se aplicável, a IPF (International Processing Fee) não está incluída.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Montante da taxa de corretagem aduaneira em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Montante da taxa de adiantamento (disbursement fee) em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.dutyTaxesBreakdown.duty`	Montante dos direitos aduaneiros em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Montante da taxa de pré-pagamento em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Montante do IVA/imposto sobre a taxa de adiantamento em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.dutyTaxesBreakdown.vatTax`	Montante do IVA/imposto em USD, não inclui o IVA/imposto sobre a taxa de adiantamento; vírgula flutuante positiva, duas casas decimais`integer`
`order.dutyTaxesTotal`	Total de direitos e impostos em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.foreignCurrencyCode`	O código da moeda em que o pagamento da encomenda foi liquidado.`string`
`remittance_amount`	O montante que tem de ser entregue a um país específico, por exemplo, _ IVA do Reino Unido_.`decimal`
`order.grandTotal`	Total geral em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.grandTotalForeign`	Total geral na moeda de liquidação; vírgula flutuante positiva, duas casas decimais`integer`
`order.items`	Lista de mapas de artigosO mapa de artigo contém detalhes sobre o artigo que foram enviados para o Zonos Checkout na criação do carrinho temporárioPara mais detalhes sobre as propriedades dos artigos, consulte a documentação da API createTempCart `JSON string`
`order.itemsCount`	Número de linhas de artigos da encomenda`integer`
`order.itemsTotal`	Total de artigos / produtos em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.itemsTotalForeign`	Total de artigos / produtos na moeda de liquidação; vírgula flutuante positiva, duas casas decimais`integer`
`order.items[index].height`	Vírgula flutuante positiva, duas casas decimais`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Vírgula flutuante positiva, duas casas decimais`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Vírgula flutuante positiva, duas casas decimais`integer`
`order.items[index].width`	Vírgula flutuante positiva, duas casas decimais`integer`
`order.items[index].unitPrice`	Vírgula flutuante positiva, duas casas decimais`integer`
`order.merchantOrderId`	`MerchantOrderId` associado à encomenda através do endpoint do serviço de API updateMerchantOrderId .`string`
`order.misc1`	Valor adicional associado à encomenda através do endpoint do serviço de API createTempCart .`string`
`order.misc2`	Valor adicional associado à encomenda através do endpoint do serviço de API createTempCart .`string`
`order.misc3`	Valor adicional associado à encomenda através do endpoint do serviço de API createTempCart .`string`
`order.misc4`	Valor adicional associado à encomenda através do endpoint do serviço de API createTempCart .`string`
`order.misc5`	Valor adicional associado à encomenda através do endpoint do serviço de API createTempCart .`string`
`order.misc6`	Valor adicional associado à encomenda através do endpoint do serviço de API createTempCart .`string`
`order.nationalIdentifier`	Informações adicionais da morada de faturação internacional da encomenda, quando necessárias. Os valores foram introduzidos no Zonos Checkout.`string`
`order.notes`	Lista de mapas de notas; o mapa de nota contém detalhes sobre a nota da encomenda.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Booleano que indica se esta nota sobre a encomenda, o envio, etc. foi criada pelo cliente.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Um `boolean` que indica 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 verificação “subscreva a nossa newsletter” no Zonos CheckoutAplicável apenas se tiver optado por apresentar esta caixa de verificação na página de checkout`boolean`
`order.orderId`	O número de identificação da encomenda no sistema Zonos`string`
`order.orderDate`	Marca temporal da criação da encomenda em milissegundos, em UTC/GMT.`millis`
`order.orderDateString`	Marca temporal da criação da encomenda em formato string, em UTC/GMT.`string`
`order.orderStatus`	O estado da encomenda no sistema Zonos. Para mais detalhes sobre a utilização de `orderStatus`, consulte o documento Obter uma encomenda aqui.Pode encontrar informações adicionais sobre os estados das encomendas no documento Atualizar uma encomenda aqui.`string`
`order.orderStatusDate`	Marca temporal em milissegundos, em UTC/GMT, da alteração mais recente de `orderStatus` no sistema Zonos.`millis`
`order.orderStatusDateString`	Marca temporal em formato string, em UTC/GMT, da alteração mais recente de `orderStatus` no sistema Zonos.`string`
`order.paymentProcessing`	Mapa dos detalhes de `paymentProcessing`. Alguns parâmetros podem não se aplicar à sua conta e serão excluídos da resposta.`JSON string`
`order.paymentProcessing.captureDate`	A data da captura do pagamento em milissegundos, se disponível.Se for a Zonos a processar o pagamento, este nó é excluído da resposta.`millis`
`order.paymentProcessing.captureDateString`	A data da captura do pagamento em formato string, se disponível.Se for a Zonos a processar o pagamento, este nó é excluído da resposta.`string`
`order.paymentProcessing.cardType`	Marca do cartão de créditoSe for a Zonos a processar o pagamento, este nó é excluído da resposta.`string`
`order.paymentProcessing.lastFour`	Os últimos quatro dígitos do número do cartão de crédito de faturação.Se for a Zonos a processar o pagamento, este nó é excluído da resposta.`string`
`order.paymentProcessing.paymentGateway`	Nome do gateway de pagamentoSe for a Zonos a processar o pagamento, indicará “iGlobal_CC” ou “iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Indica o tipo de transação“AUTH_CAPTURE” ou “AUTH_ONLY”.Se for a Zonos a processar o pagamento, este nó é excluído da resposta.`string`
`order.poNumber`	Número da ordem de compra da encomenda indicado no Zonos Checkout; utilizado quando as ordens de compra estão ativadas`string`
`order.quotedDutyTaxes`	Direitos e impostos cotados no Zonos Checkout, apresentados em USD; vírgula flutuante positiva, duas casas decimais`integer`
`order.quotedDutyTaxesForeign`	Direitos e impostos cotados no Zonos Checkout. Apresentados na moeda de liquidação; vírgula flutuante positiva, duas casas decimais`integer`
`order.referenceId`	`referenceId` único associado à encomenda através do endpoint do serviço de API createTempCart.`string`
`order.shipComplete`	Indica se a encomenda deve ser enviada em várias partes`boolean`
`order.shippingCarrierServiceLevel`	Identificador da transportadora e do nível de serviço da 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 do envio em USD; vírgula flutuante positiva, duas casas decimais `integer`
`order.shippingTotalForeign`	Total do envio na moeda de liquidação; vírgula flutuante positiva, duas casas decimais`integer`
`order.testOrder`	Indica se a encomenda é uma encomenda de teste.`boolean`
`order.trackingNumber`	Número de seguimento gerado para o envio, se aplicável.`string`
`order.zip`	Morada de destino / envio da encomenda - os valores foram introduzidos no Zonos Checkout ou foram enviados para a encomenda 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

Marcar uma demonstração