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

Criar um checkout

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

Este endpoint da API é utilizado para enviar as informações do carrinho e os artigos do carrinho do cliente para a API da Zonos.

Receberá uma resposta JSON que contém um tempCartUUID, um identificador único do carrinho no sistema da Zonos. Este será utilizado para redirecionar o cliente para o Zonos Checkout, onde concluirá a encomenda.

Atributos 

Pares chave/valor JSON no corpo do pedido

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

campo↕notas↕
boxCountValor de exemplo: 22x15x15(1),8x8x4(2),32x22x14(1)
Formato: lista, separada por vírgulas, das dimensões e da quantidade de caixas. No exemplo acima, há um total de 4 caixas. A primeira caixa da lista terá 22 polegadas de comprimento, 15 polegadas de largura e 15 polegadas de altura. Será utilizada apenas uma caixa desse tamanho. Haverá duas caixas com o tamanho 8x8x4 polegadas. É aceitável indicar a mesma dimensão de caixa várias vezes, se isso lhe for mais fácil, por exemplo: “22x15x15(1),22x15x15(1)”, o que significa 2 caixas com o tamanho 22x15x15 polegadas. Este campo descreve as caixas que serão utilizadas para enviar a encomenda. Não se espera que o comerciante saiba isto no momento da encomenda; no entanto, se for conhecido, pode ser indicado no formato string.
contShoppingURLEste campo é utilizado para indicar um URL que substitui o HREF do botão “Continuar a comprar” no Zonos Checkout. string
domesticShippingChargeEste campo é utilizado para enviar ao Zonos Checkout um custo de envio nacional, cujo montante será adicionado ao envio. Pode ser configurado para ser somado ao total do envio ou apresentado como uma linha separada. positive floating point, two decimal places
externalConfirmationPageURLEste campo é utilizado para indicar o URL da sua página de confirmação da encomenda / agradecimento. Depois de o cliente concluir o pagamento no Zonos Checkout, será redirecionado para este URL para a confirmação da encomenda. Este URL é frequentemente utilizado para acionar uma chamada ao endpoint de serviço “orderDetail” da API da Zonos, de forma a obter os detalhes da encomenda e importá-la para o sistema. string
footerHTMLEste campo é utilizado para enviar uma string HTML codificada em URL. Esta string HTML será descodificada e colocada antes da tag de fecho do body na página de checkout. É habitualmente utilizado para enviar código de remarketing, análise, etc. URL encoded string
items

OBRIGATÓRIO

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

OBRIGATÓRIO

Este campo é utilizado para indicar a descrição completa da linha de artigo do carrinho, incluindo quaisquer opções, cores, etc. do artigo. string
items[index].heightEste campo é utilizado para indicar a altura do artigo e é altamente recomendado para obter cotações de envio precisas. A altura em polegadas é

OBRIGATÓRIO

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

OBRIGATÓRIO

Este campo é utilizado para indicar o URL da imagem do produto. O URL tem de ser HTTPS para ser apresentado no Zonos Checkout. string / HTTPS URL
items[index]itemBrandEste campo é utilizado para indicar a marca do artigostring
items[index]itemCategoryEste campo é utilizado para indicar a categoria do artigo e pode ser delimitado por barras verticais se o artigo tiver mais do que uma categoria.
Valores de exemplo: “shoes” ou “shoes|sport-shoes|discount-shoes”string
items[index]itemCustomizationEste campo é utilizado para indicar detalhes adicionais sobre o artigo que não são apresentados no Zonos Checkout; no entanto, podem ser obtidos através do endpoint de serviço “orderDetail” da API.
items[index]itemHSCodeEste campo é utilizado para indicar o código SH do artigo, com ou sem pontos.
Valores de exemplo: “3926901000” ou “3926.90.1000”string
items[index].itemURLEste campo é utilizado para indicar o URL da página do produto. string / URL
items[index].lengthEste campo é utilizado para indicar o comprimento do artigo e é altamente recomendado para obter cotações de envio precisas. O comprimento em polegadas é

OBRIGATÓRIO

. string - positive floating point, two decimal places / integer (inches)
items[index].nonShippableEste campo é utilizado para indicar se o artigo deve ser incluído nos cálculos de envio, direitos aduaneiros e impostos. Transferências digitais, códigos de desconto, taxas de manuseamento, etc. devem ser enviados com o valor “true”. boolean: true or false
items[index].productIdEste campo é utilizado para indicar a quantidade da linha de artigo. string
items[index].quantity

OBRIGATÓRIO

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

OBRIGATÓRIO

Este campo é utilizado para indicar o preço unitário da linha de artigo. positive floating point, two decimal places / integer
items[index].weightEste campo é utilizado para indicar o peso do artigo e é altamente recomendado para obter cotações de envio precisas. A unidade de peso predefinida é “LBS”, a menos que seja indicada outra unidade de peso em items[index].itemWeightUnits``string - positive floating point, two decimal places / integer
items[index].weightUnitsEste campo é utilizado para substituir a unidade de peso predefinida do artigo. A unidade de peso do artigo predefinida é “LBS”, a menos que seja indicada outra unidade de peso neste campo. string - "LB", "OZ", "KG", or "G”
items[index].widthEste campo é utilizado para indicar a largura do artigo e é altamente recomendado para obter cotações de envio precisas. A largura em polegadas é

OBRIGATÓRIO

. string - positive floating point, two decimal places / integer (inches)
misc1 - misc6Este campo é utilizado para enviar dados diversos associados à encomenda através da API da Zonos, que poderão ser obtidos juntamente com os dados da encomenda devolvidos pelo endpoint de serviço “orderDetail” da API da Zonos. string
referenceIdEste campo é utilizado para indicar um valor de identificação de referência único do carrinho/sessão/etc. no seu sistema. Pode ser utilizado para consultar o ID da encomenda da Zonos através do endpoint de serviço “orderDetail” da API da Zonos. string
storeId

OBRIGATÓRIO

ID da loja fornecido pela Zonos. integer

Tipos de dados string adicionais

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

Descontos, cupões e códigos promocionais 

Para enviar descontos, cupões e códigos promocionais para a Zonos através do pedido do servidor, estes têm de ser indicados como um artigo separado, com um 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 de sucesso

Formato da mensagem: JSON

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

Definições do JSON da resposta

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

Respostas HTTP de erro

Código de erro↕significado↕
400Carácter inesperado no corpo do pedido.
406Não aceitável. O cabeçalho HTTP “Accept” é inválido.
415Tipo de media não suportado. O cabeçalho HTTP “Content-Type” é inválido.
422Entidade não processável.
500O “storeId” estava incorreto ou não foi possível analisar o corpo JSON.
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 o Zonos Checkout 

    Depois de receber uma resposta de sucesso que contenha o tempCartUUID, o seu servidor enviará um redirecionamento do navegador do cliente para o Zonos Checkout, com os parâmetros de string de consulta do URL adequados descritos abaixo.

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

    Nota: [yourassignedsubdomain] - Contacte o membro da equipa de implementação da Zonos que lhe foi atribuído para receber o seu subdomínio Zonos.com.

    Parâmetros do pedido no URL

    campo↕notas↕
    tempCartUUID

    OBRIGATÓRIO

    		Este valor é obtido ao chamar o endpoint de serviço createTempCart da API da Zonos. string / GUID
    countryCódigo ISO de duas letras do país de destino. Recomendamos vivamente que indique este parâmetro para melhorar a experiência do utilizador. O parâmetro country pré-seleciona o país de destino no Zonos Checkout. Se utilizar o Zonos Hello JS (JavaScript) no site, pode obter este valor chamando o método JavaScript: zonos.country(). string (Comprimento: 2)

    Tipos de dados string adicionais

    • customerName
    • customerCompany
    • customerEmail
    • customerPhone
    • customerAltPhone
    • customerAddress1
    • customerAddress2
    • customerCity
    • customerState
    • customerZip

    Esta página foi útil?

    Obter apoio·Documentos legais·© 2026 Zonos
    Nesta página:
  • Criar um checkout
  • Atributos
  • Descontos, cupões e códigos promocionais
  • Redirecionar para o Zonos Checkout