API legada/Referência completa/Carrinhos

Detalhes do carrinho

Referência dos campos de um objeto de carrinho e do array de produtos, com um exemplo de resposta completa.

Os detalhes do carrinho descrevem todos os campos e valores que você acessa pela API para um carrinho de compras de cliente. Use esta página como a referência dos campos do objeto de carrinho devolvido por Obter um carrinho.

Campos do objeto de carrinho

Estes campos são as propriedades principais de um objeto de carrinho.

Campo	Valores	Descrição
`user_id`	integer	Um identificador único do dono do carrinho.
`firstname`	string	Nome do dono do carrinho.
`lastname`	string	Sobrenome do dono do carrinho.
`date`	integer	O timestamp UNIX de quando o carrinho foi criado.
`ip_address`	string	O endereço IP do dono do carrinho.
`company_id`	integer	O id do vendedor associado ao carrinho.
`cart_products`	integer	A quantidade de itens no carrinho. Várias ocorrências do mesmo produto contam como itens separados.
`total`	float	O preço total dos produtos do carrinho.
`order_id`	integer	O id do pedido associado ao carrinho (se o carrinho já passou pelo checkout).
`user_data`	object	Informações detalhadas sobre o dono do carrinho. Só está disponível se o carrinho pertence a um usuário cadastrado.
`products`	array	Um array com as informações dos produtos do carrinho.

Array de produtos

O array products traz informações detalhadas de cada produto do carrinho.

Campo	Valores	Descrição
`product_id`	integer	Id do produto.
`amount`	integer	A quantidade deste produto no carrinho.
`price`	float	O preço unitário do produto.
`product`	string	O nome do produto.
`options`	array	Opções do produto selecionadas (cor, tamanho etc.).
`subtotal`	float	O preço total deste produto (quantidade x preço).

Exemplo de resposta

Veja abaixo um exemplo de resposta completa dos detalhes de um carrinho.

200Detalhes do carrinho

json

{
  "user_id": "42",
  "firstname": "John",
  "lastname": "Doe",
  "date": "1681556400",
  "ip_address": "192.168.1.1",
  "company_id": "1",
  "cart_products": "3",
  "total": "199.97",
  "order_id": "0",
  "user_data": {
    "email": "john.doe@example.com",
    "phone": "+1 (555) 123-4567"
  },
  "products": [
    {
      "product_id": "123",
      "amount": "2",
      "price": "49.99",
      "product": "Premium T-Shirt",
      "options": [
        {
          "option_id": "12",
          "option_name": "Size",
          "value": "Large"
        },
        {
          "option_id": "15",
          "option_name": "Color",
          "value": "Blue"
        }
      ],
      "subtotal": "99.98"
    },
    {
      "product_id": "456",
      "amount": "1",
      "price": "99.99",
      "product": "Designer Jeans",
      "options": [
        {
          "option_id": "18",
          "option_name": "Size",
          "value": "32"
        }
      ],
      "subtotal": "99.99"
    }
  ]
}

Veja também