Criar um checkout

Explore os pares chave/valor envolvidos na criação de um checkout.

Este endpoint da API é usado para enviar informações do carrinho e itens do carrinho do cliente para a API da Zonos.

Você receberá uma resposta JSON contendo um tempCartUUID, um identificador de carrinho exclusivo no Sistema da Zonos. Isso será usado para redirecionar o cliente para o Zonos Checkout para concluir o pedido.

Atributos

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

POST https://api.iglobalstores.com/v1/createTempCart

campo	notas
`boxCount`	Valor de exemplo: 22x15x15(1),8x8x4(2),32x22x14(1) Formato: Lista separada por vírgulas de dimensões de caixa e contagem. No exemplo acima, há um total de 4 caixas. A primeira caixa da lista terá 22 polegadas de comprimento, por 15 polegadas de largura, por 15 polegadas de altura. Haverá apenas uma caixa usada para esse tamanho. Haverá duas caixas do tamanho: 8x8x4 polegadas. É aceitável passar a mesma dimensão de caixa várias vezes se for fácil para você, como: “22x15x15(1),22x15x15(1)”, o que significa 2 caixas do tamanho: 22x15x15 polegadas. Este campo descreve as caixas que serão usadas para enviar o pedido. Não se espera que um comerciante saiba disso no momento do pedido; no entanto, se for conhecido, pode ser passado no formato `string`.
`contShoppingURL`	Este campo é usado para passar uma URL para substituir o HREF do botão "Continuar comprando" dentro do Zonos Checkout. `string`
`domesticShippingCharge`	Este campo é usado para passar uma taxa de envio doméstico para o Zonos Checkout, e o valor será adicionado ao envio. Isso pode ser configurado para adicionar o total do envio ou ser separado como um item de linha separado. `ponto flutuante positivo, duas casas decimais`
`externalConfirmationPageURL`	Este campo é usado para passar uma URL da sua página de confirmação de pedido/agradecimento. Após o cliente concluir o pagamento dentro do Zonos Checkout, ele será redirecionado para esta URL para a confirmação do pedido. Esta URL é frequentemente usada para acionar uma chamada para o endpoint de serviço da API "orderDetail" da Zonos para recuperar os detalhes do pedido e importar o pedido para o sistema. `string`
`footerHTML`	Este campo é usado para passar uma string HTML codificada em URL. Esta string HTML será decodificada e colocada antes da tag de fechamento do corpo na página de checkout. Comumente usado para passar código para remarketing, análises, etc. `string codificada em URL`
`items` OBRIGATÓRIO	Este campo é uma lista de mapas de itens. `string JSON`
`items[index].countryOfOrigin`	Este campo é usado para passar o país de origem do item. O parâmetro deve ser o país código ISO de duas letras. `string`
`items[index].description` OBRIGATÓRIO	Este campo é usado para passar uma descrição completa do item da linha do carrinho, incluindo quaisquer opções de item, cores, etc. `string`
`items[index].height`	Este campo é usado para passar a altura do item e é altamente recomendado para cotações de envio precisas. As unidades de altura são OBRIGATÓRIAS em polegadas. `string - ponto flutuante positivo, duas casas decimais / inteiro (polegadas)`
`items[index].imageURL` OBRIGATÓRIO	Este campo é usado para passar a URL da imagem do produto do item. A URL deve ser HTTPS para ser exibida dentro do Zonos Checkout. `string / URL HTTPS`
`items[index]itemBrand`	Este campo é usado para passar a marca do item`string`
`items[index]itemCategory`	Este campo é usado para passar a categoria do item e pode ser passado delimitado por tubos se o item tiver mais de uma categoria. Valores de exemplo: “sapatos” ou “sapatos\|sapatos-esportivos\|sapatos-em-promoção”`string`
`items[index]itemCustomization`	Este campo é usado para passar detalhes adicionais sobre o item que não são mostrados no Zonos Checkout; no entanto, isso pode ser recuperado através do ponto de extremidade do serviço API “orderDetail”.
`items[index]itemHSCode`	Este campo é usado para passar o código HS do item e pode ser com ou sem pontos. Valores de exemplo: “3926901000” ou “3926.90.1000”`string`
`items[index].itemURL`	Este campo é usado para passar a URL para a página do produto do item. `string / URL`
`items[index].length`	Este campo é usado para passar o comprimento do item e é altamente recomendado para cotações de envio precisas. As unidades de comprimento são OBRIGATÓRIAS em polegadas. `string - ponto flutuante positivo, duas casas decimais / inteiro (polegadas)`
`items[index].nonShippable`	Este campo é usado para indicar se o item deve ser incluído nos cálculos de envio, taxas e impostos. Downloads digitais, códigos de desconto, taxas de manuseio, etc. devem ser passados com um valor de “true”. `boolean: true ou false`
`items[index].productId`	Este campo é usado para passar a quantidade do item da linha. `string`
`items[index].quantity` OBRIGATÓRIO	Este campo é usado para passar a quantidade do item da linha. `string`
`items[index].sku`	Este campo é usado para passar o SKU / UPC / etc. do item. `string`
`items[index].unitPrice` OBRIGATÓRIO	Este campo é usado para passar o preço unitário do item da linha. `ponto flutuante positivo, duas casas decimais / inteiro`
`items[index].weight`	Este campo é usado para passar o peso do item e é altamente recomendado para cotações de envio precisas. As unidades de peso são padrão para “LBS” a menos que outra unidade de peso seja passada em items[index].itemWeightUnits``string - ponto flutuante positivo, duas casas decimais / inteiro
`items[index].weightUnits`	Este campo é usado para substituir as unidades de peso padrão do item. As unidades de peso do item são padrão para “LBS” a menos que outra unidade de peso seja passada neste campo. `string - "LB", "OZ", "KG" ou "G”`
`items[index].width`	Este campo é usado para passar a largura do item e é altamente recomendado para cotações de envio precisas. As unidades de largura são OBRIGATÓRIAS em polegadas. `string - ponto flutuante positivo, duas casas decimais / inteiro (polegadas)`
`misc1 - misc6`	Este campo é usado para passar dados diversos associados ao pedido através da API Zonos para serem recuperados juntamente com os dados do pedido retornados do ponto de extremidade do serviço API “orderDetail” da Zonos. `string`
`referenceId`	Este campo é usado para passar um valor de identificação de referência único para o carrinho/sessão/etc. em seu sistema. Isso pode ser usado para procurar o ID do pedido da Zonos através do ponto de extremidade do serviço API “orderDetail” da Zonos. `string`
`storeId` OBRIGATÓRIO	ID da loja fornecido pela Zonos. `inteiro`

Tipos de dados de string adicionais

items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial

Descontos, cupons e códigos promocionais

Para enviar descontos, cupons e códigos promocionais para a Zonos através do servidor post, eles devem ser passados como um item separado com um valor negativo para os parâmetros: “unitPrice” e “nonShippable”:true.

MAPA DE EXEMPLO DE ITEM DE DESCONTO

{
  "description": "Discount (10OFF) - 10% OFF",
  "unitPrice": -15.5,
  "quantity": 1,
  "nonShippable": true
}

Resposta HTTPS

Resposta HTTP de sucesso

Formato da mensagem: JSON

EXEMPLO DE RESPOSTA DE SUCESSO

{
  "tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}

Definições de resposta JSON

campo	notas
`tempCartUUID`	Este parâmetro conterá um GUID atribuído ao carrinho internacional do seu cliente e criado no sistema da Zonos. Este campo será passado via um parâmetro de consulta de URL `string` ao redirecionar o navegador do usuário para o Zonos Checkout.

Respostas de erro HTTP

Código de erro	significado
400	Caractere inesperado no corpo da solicitação.
406	Não aceitável. O cabeçalho HTTP para "Accept" é inválido.
415	Tipo de mídia não suportado. O cabeçalho HTTP para "Content-Type" é inválido.
422	Entidade não processável.
500	"storeId" estava incorreto ou o corpo JSON não pôde ser analisado.

EXEMPLO DE RESPOSTA DE ERRO

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
    <title>Error 422 Unprocessable Entity</title>
  </head>
  <body>
    <h2>HTTP ERROR 422</h2>
    <p>
      Problem accessing /v2/createTempCart. Reason:
      <pre>Unprocessable Entity</pre>
    </p>
    <h2>The request entity had the following errors:</h2>
    <ul>
      <li>items may not be empty (was null)</li>
      <li>items may not be null (was null)</li>
    </ul>
  </body>
</html>

Redirecionando para o Zonos Checkout

Após receber uma resposta bem-sucedida contendo o tempCartUUID, o seu servidor enviará um redirecionamento do navegador do cliente para o Zonos Checkout com os parâmetros apropriados da string de consulta de URL cobertos abaixo.

Exemplo de URL de Redirecionamento: https://[seusubdomínioatribuído].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA

Nota: [seusubdomínioatribuído] - Entre em contato com o membro da equipe de implementação do Zonos para receber o seu subdomínio Zonos.com.

Parâmetros de solicitação de URL

campo	notas
`tempCartUUID` OBRIGATÓRIO	Este valor é obtido chamando o serviço de endpoint da API `createTempCart` da Zonos. `string / GUID`
`country`	Código ISO de duas letras do país de destino. Recomendamos fortemente passar este parâmetro para a experiência do usuário. O parâmetro `country` pré-selecionará o país de destino dentro do Zonos Checkout. Ao usar o JS (JavaScript) do Zonos Hello no site, você pode obter este valor chamando o método JavaScript: `zonos.country()`. `string` (Comprimento: 2)

Tipos de dados de string adicionais

customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip

Esta página foi útil?

Dúvidas?

Entre em contato conosco.

Ver Zonos

políticas e acordos