Qual é o ponto final Checkout API?

O ponto final de Checkout API é 'orderDetail'. Este endpoint de API é usado para recuperar com segurança os detalhes e o status de um pedido concluído por meio de Zonos Checkout.

Qual é a solicitação HTTPS para Checkout API?

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

Quais são os pares chave/valor JSON no corpo da solicitação?

Os pares chave/valor JSON no corpo da solicitação incluem 'orderId', 'referenceId', 'secret' e 'storeId'. 'orderId' e 'referenceId' são opcionais, mas um deles deve ser enviado. 'secret' e 'storeId' são obrigatórios.

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

Possíveis respostas de erro HTTP incluem 415 (Tipo de mídia não suportado), 406 (Não aceitável), 400 (Solicitação incorreta) e 500 (Erro interno do servidor). Cada código de erro corresponde a um tipo específico de erro.

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

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

Checkout•

InícioReferência da API Checkout REST API Detalhes do pedido

Detalhes do pedido

Descubra como funciona o endpoint de detalhes do pedido.

O endpoint orderDetail é usado para recuperar com segurança os detalhes e o status de um pedido concluído por meio de Zonos Checkout.

Endpoint

Observação: As teclas de resposta podem ser modificadas e/ou teclas adicionais podem ser adicionadas. Se você for usar o endpoint, configure seu código para levar em conta essas possibilidades.

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

solicitação HTTPS

Campo↕	Notas↕
Método HTTP	POSTR
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protocolo	HTTPS
Formato da mensagem	JSON
Cabeçalho de aceitação HTTP	Aceitar: aplicativo/json
Tipo de conteúdo do cabeçalho HTTP	Tipo de conteúdo: aplicativo/json

Pares de chave/valor JSON no corpo da solicitação

campo↕	notas↕
`orderId` OPCIONAL, se parâmetro `referenceId`	O ID do pedido Zonos pode ser enviado com ou sem o ID e o script da sua loja (exemplo: 123-45678 ou 45678). Nota: Após finalizar o pedido e o pagamento, o cliente será redirecionado para uma página de checkout/agradecimento do pedido hospedada em seu domínio. A URL conterá um parâmetro de string de consulta "orderId" que incluirá esse valor.`integer / string`
`referenceId` OPCIONAL, se for passado o parâmetro "orderId"	Este parâmetro é usado para consultar dados de um pedido usando o único `referenceId` enviado no terminal de serviço da API `createTempCart`. Este parâmetro deve ser omitido ou deixado nulo quando o detalhe do pedido for consultado conforme o parâmetro `orderId`.`string`
`secret` NECESSÁRIO	GUID secreto da API fornecido por Zonos`string`
`storeId` NECESSÁRIO	ID da loja fornecida por Zonos.`integer`

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 "Aceitar" é inválido.
400	Solicitação incorreta	“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 da postagem inválido”“error”:”O 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”:”Parameter store necessário”“error”:”Nenhum pedido encontrado com referenceId: 999999 para storeId: 999”“error”:”referenceId: 999999 para storeId: 999 foi duplicado”“erro”:”Não foi possível recuperar o pedido com referenceId: 999999”
500	Erro interno do servidor	“erro”: “Não foi possível processar os detalhes do pedido”

Definições de resposta JSON

campo↕	notas↕
`error`	Este parâmetro estará presente somente quando ocorrer 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 cobrança do pedido: Valores inseridos em Zonos Checkout.`string`
`orderboxCount`	Este campo descreve as caixas que serão utilizadas para envio do pedido, passadas na solicitação createTempCart request.`string`
`order.carrierAccountNumber`	Número da conta da transportadora do visitante; usado quando as contas da operadora do visitante estão habilitadas`string`
`order.carrierAccountShippingMethod`	Método de envio selecionado na conta da transportadora do próprio visitante; usado quando as contas da operadora do visitante estão habilitadas`string`
`order.cslListMatch`	Correspondência na lista consolidada Screening (CSL). Um booleano que indica quando as informações do cliente foram correspondidas com a Lista Consolidada Screen dos EUA e devem ser revisadas para possível afiliação de parte negada.`boolean`
`order.customerSelectedShippingName`	Nome de exibição da opção de envio em Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Mapa da discriminação tarifária/impostoNota: Se aplicável, o IPF (Taxa Internacional de Processamento) não está incluído.`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 descarte em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.duty`	Valor da tarifa em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Valor da taxa pré-paga em dólares americanos; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Valor do IVA/imposto sobre taxa de alienação em USD; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesBreakdown.vatTax`	Valor do IVA/imposto em USD, não inclui IVA/imposto sobre taxa de alienação; ponto flutuante positivo, duas casas decimais`integer`
`order.dutyTaxesTotal`	Total de taxas e impostos em dólares americanos; ponto flutuante positivo, duas casas decimais`integer`
`order.foreignCurrencyCode`	Código da moeda em que foi liquidado o pagamento da ordem.`string`
`remittance_amount`	A quantia de dinheiro que deve ser remetida para um país específico, por exemplo _ IVA do Reino Unido_.`decimal`
`order.grandTotal`	Total geral em dólares americanos; ponto flutuante positivo, duas casas decimais`integer`
`order.grandTotalForeign`	Total geral na moeda de liquidação; 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 foi enviado para Zonos Checkout ao criar o carrinho temporário. Para obter mais detalhes sobre as propriedades do item, consulte createTempCart doc. de API`JSON string`
`order.itemsCount`	Contagem de linha de item 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 de liquidação; 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`integer`
`order.items[index].width`	Ponto flutuante positivo, duas casas decimais`integer`
`order.items[index].unitPrice`	Ponto flutuante positivo, duas casas decimais`integer`
`order.merchantOrderId`	`MerchantOrderId` associado ao pedido por meio da API de endpoint de serviço updateMerchantOrderId .`string`
`order.misc1`	Valor adicional associado ao pedido por meio da API de endpoint de serviço createTempCart .`string`
`order.misc2`	Valor adicional associado ao pedido por meio da API de endpoint de serviço createTempCart .`string`
`order.misc3`	Valor adicional associado ao pedido por meio da API de endpoint de serviço createTempCart .`string`
`order.misc4`	Valor adicional associado ao pedido por meio da API de endpoint de serviço createTempCart .`string`
`order.misc5`	Valor adicional associado ao pedido por meio da API de endpoint de serviço createTempCart .`string`
`order.misc6`	Valor adicional associado ao pedido por meio da API de endpoint de serviço createTempCart .`string`
`order.nationalIdentifier`	Informações adicionais de endereço de cobrança internacional para o pedido, quando necessário. Os valores foram inseridos em Zonos Checkout.`string`
`order.notes`	Uma lista de mapas de notas; o mapa de notas contém detalhes sobre a nota do pedido.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Um booleano que indica se esta foi uma nota criada pelo cliente sobre o pedido, frete, etc.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Um `boolean` indicando se esta nota foi marcada como importante
`order.notes[index].note`	Conteúdo da nota`string`
`order.optInEmail`	Indica que o cliente marcou a caixa de seleção "inscreva-se em nossa newsletter" em Zonos CheckoutAplicável somente se você optou por exibir esta caixa de seleção na página de checkout`boolean`
`order.orderId`	Número de identificação do pedido no sistema Zonos`string`
`order.orderDate`	Carimbo de data e hora de criação do pedido em milissegundos em UTC/GMT.`millis`
`order.orderDateString`	String de carimbo de data/hora de criação do pedido em UTC/GMT.`string`
`order.orderStatus`	O status do pedido no sistema Zonos. Para obter mais detalhes sobre como usar `orderStatus`, consulte o documento Recuperar um pedido aqui.Informações adicionais sobre status de pedidos estão no documento Atualizar um pedido aqui.`string`
`order.orderStatusDate`	Carimbo de data e hora em milissegundos em UTC/GMT da alteração mais recente de `orderStatus` no sistema Zonos.`millis`
`order.orderStatusDateString`	Sequência de carimbo de data/hora UTC/GMT da alteração 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.`JSON string`
`order.paymentProcessing.captureDate`	Data de captura do pagamento em milissegundos, se disponível.Se Zonos processar o pagamento, esse nó será excluído da resposta.`millis`
`order.paymentProcessing.captureDateString`	Data de captura do pagamento em string, se disponível. Se Zonos processar o pagamento, este nó será excluído da resposta. `string`
`order.paymentProcessing.cardType`	Marca de cartão de créditoSe Zonos processar o pagamento, este nó será excluído da resposta.`string`
`order.paymentProcessing.lastFour`	Os últimos quatro dígitos do número do cartão de crédito de cobrança. Se Zonos processar o pagamento, este nó será excluído da resposta. `string`
`order.paymentProcessing.paymentGateway`	Nome do gateway de pagamentoSe Zonos 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 Zonos processar o pagamento, este nó será excluído da resposta.`string`
`order.poNumber`	Número do pedido especificado em Zonos Checkout; usado quando as ordens de compra estão ativadas`string`
`order.quotedDutyTaxes`	Direitos e impostos cotados em Zonos Checkout, exibidos em dólares americanos; ponto flutuante positivo, duas casas decimais`integer`
`order.quotedDutyTaxesForeign`	Direitos e impostos cotados em Zonos Checkout. Mostrado na moeda de liquidação; ponto flutuante positivo, duas casas decimais`integer`
`order.referenceId`	`referenceId` exclusivo associado ao pedido por meio do endpoint de serviço da API createTempCart.`string`
`order.shipComplete`	Indica se o pedido deve ser enviado em diversas partes`boolean`
`order.shippingCarrierServiceLevel`	Identificador da transportadora e nível de serviço da opção de envio selecionada`string`
`order.shippingInstructions`	Instruções personalizáveis para nível de serviço de remessa`string`
`order.shippingTotal`	Total de envio em USD; ponto flutuante positivo, duas casas decimais `integer`
`order.shippingTotalForeign`	Total de envio na moeda de liquidação; ponto flutuante positivo, duas casas decimais`integer`
`order.testOrder`	Indica se o pedido é um pedido experimental.`boolean`
`order.trackingNumber`	Número de rastreamento gerado para a remessa, se aplicável.`string`
`order.zip`	Endereço de envio/destino do pedido: Os valores foram inseridos em Zonos Checkout ou enviados para o pedido redirecionando para 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

Agendar uma demonstração