DOCS
Checkout•
InícioReferência da API Checkout REST API Criar um checkout

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 Zonos.

Você receberá uma resposta JSON contendo tempCartUUID, um identificador exclusivo do carrinho no sistema de Zonos. Será utilizado para redirecionar o cliente para Zonos Checkout e finalizar o pedido.

Atributos 

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

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

campo↕notas↕
boxCountValor de exemplo: 22x15x15(1),8x8x4(2),32x22x14(1)
Formato: lista separada por vírgulas de dimensões e quantidade da caixa. No exemplo acima, há um total de 4 caixas. A primeira caixa listada terá 22 polegadas de comprimento, 15 polegadas de largura e 15 polegadas de altura. Será utilizada apenas uma caixa desse tamanho. Serão duas caixas de tamanho 8x8x4 polegadas. É aceitável passar várias vezes a mesma dimensão da caixa se for mais fácil para você, como: "22x15x15(1),22x15x15(1)", o que significa 2 caixas de tamanho 22x15x15 polegadas. Este campo descreve as caixas que serão utilizadas para enviar o pedido. Não se espera que um comerciante saiba disso no momento do pedido; entretanto, se conhecido, pode ser transmitido no formato string.
contShoppingURLEste campo é usado para passar uma URL que substitui o HREF do botão "Continuar comprando" em Zonos Checkout. string
domesticShippingChargeEste campo é utilizado para passar uma taxa de frete nacional para Zonos Checkout, e o valor será adicionado ao frete. Ele pode ser configurado para adicionar o total do frete ou discriminado como uma linha separada. positive floating point, two decimal places
externalConfirmationPageURLEste campo é usado para passar a URL da sua página de confirmação/agradecimento do pedido. Depois que um cliente concluir o pagamento em Zonos Checkout, ele será redirecionado para este URL para confirmação do pedido. Essa URL é frequentemente usada para acionar uma chamada para o endpoint de serviço da API Zonos "orderDetail" para recuperar os detalhes do pedido e importá-los para o sistema. string
footerHTMLEste campo é usado para passar uma string HTML codificada por URL. Esta string HTML será decodificada e colocada antes da tag body de fechamento na página de checkout. É comumente usado para passar código de remarketing, análises, etc. URL encoded string
items

OBRIGATÓRIO

Este campo é uma lista de mapas de itens. JSON string
items[index].countryOfOriginEste campo é utilizado para passar o país de origem do item. O parâmetro deve ser o código ISO de duas letras do país. string
items[index].description

OBRIGATÓRIO

Este campo é utilizado para passar uma descrição completa do item de linha do carrinho, incluindo opções, cores, etc. string
items[index].heightEste campo é utilizado para passar a altura do item e é altamente recomendado para cotações de envio precisas. As unidades de altura são

REQUIRED

em polegadas. string - positive floating point, two decimal places / integer (inches)
items[index].imageURL

OBRIGATÓRIO

Este campo é utilizado para passar a URL da imagem do produto. O URL deve ser HTTPS para ser exibido em Zonos Checkout. string / HTTPS URL
items[index]itemBrandEste campo é utilizado para passar o item marcastring
items[index]itemCategoryEste campo é utilizado para passar a categoria do item e pode ser passado delimitado por barras verticais caso o item possua mais de uma categoria.
Valores de exemplo: "sapatos" ou "sapatos|sapatos esportivos|sapatos com desconto"string
items[index]itemCustomizationEste campo é utilizado para passar detalhes adicionais sobre o item que não são mostrados em Zonos Checkout; no entanto, eles podem ser recuperados por meio do terminal de serviço da API "orderDetail".
items[index]itemHSCodeEste campo é utilizado para passar o código HS do item, com ou sem pontos.
Valores de exemplo: "3926901000" ou "3926.90.1000"string
items[index].itemURLEste campo é usado para passar a URL da página do produto. string / URL
items[index].lengthEste campo é usado para informar o comprimento do item e é altamente recomendado para cotações de envio precisas. As unidades de comprimento são

REQUIRED

em polegadas. string - positive floating point, two decimal places / integer (inches)
items[index].nonShippableEste campo é usado para indicar se o item deve ser incluído nos cálculos de frete, taxas e impostos. Downloads digitais, códigos de desconto, taxas de manuseio, etc. Devem ser repassados com valor "verdadeiro". boolean: true or false
items[index].productIdEste campo é utilizado para passar a quantidade do item de linha. string
items[index].quantity

OBRIGATÓRIO

Este campo é utilizado para passar a quantidade do item de linha. string
items[index].skuEste campo é usado para passar o SKU/UPC/etc. do artigo. string
items[index].unitPrice

OBRIGATÓRIO

Este campo é usado para passar o preço unitário do item de linha. positive floating point, two decimal places / integer
items[index].weightEste campo é usado para passar o peso do item e é altamente recomendado para cotações de envio precisas. As unidades de peso são padronizadas como "LBS", a menos que outra unidade de peso seja passada em items[index].itemWeightUnits``string - positive floating point, two decimal places / integer
items[index].weightUnitsEste campo é usado para substituir as unidades de peso padrão do item. As unidades de peso do item são padronizadas como "LBS", a menos que outra unidade de peso seja passada neste campo. string - "LB", "OZ", "KG", or "G”
items[index].widthEste campo é usado para passar a largura do item e é altamente recomendado para cotações de envio precisas. As unidades de largura são

REQUIRED

em polegadas. string - positive floating point, two decimal places / integer (inches)
misc1 - misc6Este campo é usado para passar dados diversos associados ao pedido por meio da API Zonos para serem recuperados junto com os dados do pedido retornados pelo endpoint de serviço da API Zonos "orderDetail". string
referenceIdEste campo é usado para passar um valor de ID de referência exclusivo para o carrinho/sessão/etc. em seu sistema. Ele pode ser usado para consultar o ID do pedido Zonos por meio do endpoint de serviço da API Zonos "orderDetail". string
storeId

OBRIGATÓRIO

ID da loja fornecido por Zonos. integer

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 Zonos usando envio do lado do servidor, eles devem ser passados como um item separado com valor negativo nos parâmetros: "unitPrice" e "nonShippable":true.

1{
2 "description": "Discount (10OFF) - 10% OFF",
3 "unitPrice": -15.5,
4 "quantity": 1,
5 "nonShippable": true
6}

Resposta HTTPS

Resposta HTTP bem-sucedida

Formato da mensagem: JSON

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

Definições de resposta JSON

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

Respostas de erro HTTP

Código de erro↕significado↕
400Caráter inesperado no corpo da solicitação.
406Não é aceitável. O cabeçalho HTTP "Aceitar" não é válido.
415Tipo de mídia não suportado. O cabeçalho HTTP "Content-Type" é inválido.
422Entidade não processável.
500"storeId" estava incorreto ou o corpo JSON não pôde ser analisado.
1
2 
3
4 
5
6 
7Error 422 Unprocessable Entity
8 
9
10 
11
12 
13

HTTP ERROR 422

14 
15

16 Problem accessing /v2/createTempCart. Reason:
17 
Unprocessable Entity
18 
19

20 
21

The request entity had the following errors:

22 
23
24 
25
  • items may not be empty (was null)
    • 26 
    27
  • items may not be null (was null)
    • 28 
    29
    30 
    31
    32 
    33

    Redirecionar para Zonos Checkout 

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

    Exemplo de URL de redirecionamento: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA

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

    Parâmetros de solicitação de URL

    campo↕notas↕
    tempCartUUID

    OBRIGATÓRIO

    		Esse valor é obtido chamando o terminal de serviço da API createTempCart de Zonos. string / GUID
    countryCódigo ISO de duas letras do país de destino. Recomendamos fortemente passar este parâmetro para experiência do usuário. O parâmetro country pré-selecionará o país de destino em Zonos Checkout. Ao usar Zonos Hello JS (JavaScript) em seu site, você pode obter esse 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?

    Obter suporte·Documentos legais·© 2026 Zonos
    Nesta página:
  • Criar um checkout
  • Atributos
  • Descontos, cupons e códigos promocionais
  • Redirecionar para Zonos Checkout