API legada/Referência completa/Pedidos de ligação

Produtos do carrinho

Estrutura do array de produtos que descreve os itens de um carrinho e como adicionar um produto ao carrinho.

Quando você trabalha com carrinhos pela API, o array products guarda os detalhes de cada item do carrinho. A mesma estrutura é usada pelo campo cart_products de um pedido de ligação. Esta página explica as propriedades de um objeto de produto.

Definição dos campos

Cada produto do array tem estes campos.

Campo	Descrição	Disponível nos métodos	Valores aceitos
`product_id`	Um identificador único do produto. Esse ID corresponde ao produto no seu catálogo.	GET	integer
`amount`	A quantidade deste produto no carrinho. O valor pode ser atualizado pela API.	GET	string
`price`	O preço unitário do produto. Pode ser diferente do preço do catálogo se houver promoções ou preços específicos do cliente.	GET	integer/float
`product`	O nome ou título do produto, como aparece para os clientes.	GET	string
`options`	Variações ou personalizações do produto escolhidas pelo cliente (por exemplo, tamanho ou cor).	GET	array
`subtotal`	O preço total deste produto (`price` x `amount`).	GET	integer/float

Exemplo de item de produto

json

{
  "product_id": "123",
  "amount": "2",
  "price": 49.99,
  "product": "Premium T-Shirt",
  "options": [
    {
      "option_id": "12",
      "option_name": "Size",
      "value": "Large"
    },
    {
      "option_id": "14",
      "option_name": "Color",
      "value": "Blue"
    }
  ],
  "subtotal": 99.98
}

Trabalhando com produtos do carrinho

Consultar os produtos de um carrinho

Para consultar os produtos de um carrinho, busque os detalhes do carrinho com uma requisição GET. O array products vem na resposta.

GET/api/carts/{cart_id}Admin

Retorna os detalhes de um carrinho específico, incluindo todos os produtos

Parâmetros de caminho

cart_idstringobrigatório

O ID do carrinho.

Adicionar um produto a um carrinho

Para adicionar um produto a um carrinho, envie uma requisição POST com os dados do produto.

POST/api/carts/{cart_id}/productsAdmin

Adiciona um novo produto ao carrinho informado

Parâmetros de caminho

cart_idstringobrigatório

O ID do carrinho.

bash

curl -X POST "$BASE_URL/api/carts/1/products" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "456",
  "amount": "1",
  "options": [
    {
      "option_id": "23",
      "value": "Medium"
    }
  ]
}'

Produtos do carrinho

Estrutura do array de produtos que descreve os itens de um carrinho e como adicionar um produto ao carrinho.

Definição dos campos

Cada produto do array tem estes campos.

Campo	Descrição	Disponível nos métodos	Valores aceitos
`product_id`	Um identificador único do produto. Esse ID corresponde ao produto no seu catálogo.	GET	integer
`amount`	A quantidade deste produto no carrinho. O valor pode ser atualizado pela API.	GET	string
`price`	O preço unitário do produto. Pode ser diferente do preço do catálogo se houver promoções ou preços específicos do cliente.	GET	integer/float
`product`	O nome ou título do produto, como aparece para os clientes.	GET	string
`options`	Variações ou personalizações do produto escolhidas pelo cliente (por exemplo, tamanho ou cor).	GET	array
`subtotal`	O preço total deste produto (`price` x `amount`).	GET	integer/float

Exemplo de item de produto

json

{
  "product_id": "123",
  "amount": "2",
  "price": 49.99,
  "product": "Premium T-Shirt",
  "options": [
    {
      "option_id": "12",
      "option_name": "Size",
      "value": "Large"
    },
    {
      "option_id": "14",
      "option_name": "Color",
      "value": "Blue"
    }
  ],
  "subtotal": 99.98
}

Trabalhando com produtos do carrinho

Consultar os produtos de um carrinho

Para consultar os produtos de um carrinho, busque os detalhes do carrinho com uma requisição GET. O array products vem na resposta.

GET/api/carts/{cart_id}Admin

Retorna os detalhes de um carrinho específico, incluindo todos os produtos

Parâmetros de caminho

cart_idstringobrigatório

O ID do carrinho.

Adicionar um produto a um carrinho

Para adicionar um produto a um carrinho, envie uma requisição POST com os dados do produto.

POST/api/carts/{cart_id}/productsAdmin

Adiciona um novo produto ao carrinho informado

Parâmetros de caminho

cart_idstringobrigatório

O ID do carrinho.

bash

curl -X POST "$BASE_URL/api/carts/1/products" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "456",
  "amount": "1",
  "options": [
    {
      "option_id": "23",
      "value": "Medium"
    }
  ]
}'