VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Carrinhos

Obter um carrinho

Retorna os detalhes completos do carrinho de compras de um usuário: dados do dono, totais e os produtos do carrinho.

Este endpoint retorna os detalhes completos de um carrinho de compras específico, a partir do id do usuário. Use-o depois de listar os carrinhos, quando precisar dos dados do cliente e dos produtos de um carrinho, por exemplo para montar uma mensagem de recuperação.

Quando o carrinho existe, você recebe HTTP/1.1 200 OK e um corpo JSON com os detalhes do carrinho. Quando ele não existe, você recebe HTTP/1.1 404 Not Found.

GET/api/carts/{user_id}Admin

Obter um carrinho específico pelo id do usuário

Parâmetros de caminho

user_idintegerobrigatório
O id de usuário do dono do carrinho.

Exemplo de requisição

A requisição GET /api/carts/3 retorna o carrinho do usuário de id 3.

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/carts/3"

Resposta

200Carrinho encontrado
json
{
  "user_id": "3",
  "firstname": "John",
  "lastname": "Doe",
  "date": "1466521318",
  "ip_address": "127.0.0.1",
  "company_id": "1",
  "cart_products": "1",
  "total": "30.00",
  "order_id": null,
  "user_data": {
    "user_id": "3",
    "status": "A",
    "user_type": "C",
    "user_login": "customer",
    "referer": "",
    "is_root": "N",
    "company_id": "1",
    "last_login": "1466521090",
    "timestamp": "1466408289",
    "firstname": "John",
    "lastname": "Doe",
    "company": "Simtech",
    "email": "customer@example.com",
    "phone": "77 77 777 7777",
    "fax": "",
    "url": "",
    "tax_exempt": "N",
    "lang_code": "en",
    "usergroups": [],
    "profile_id": "2",
    "profile_type": "P",
    "b_firstname": "John",
    "b_lastname": "Doe",
    "b_address": "44 Main street",
    "b_city": "Boston",
    "b_state": "MA",
    "b_country": "US",
    "b_zipcode": "02134",
    "s_firstname": "John",
    "s_lastname": "Doe",
    "s_address": "44 Main street",
    "s_city": "Boston",
    "s_state": "MA",
    "s_country": "US",
    "s_zipcode": "02134",
    "b_country_descr": "United States",
    "s_country_descr": "United States",
    "b_state_descr": "Massachusetts",
    "s_state_descr": "Massachusetts",
    "points": 0
  },
  "products": [
    {
      "item_id": "822274303",
      "item_type": "P",
      "product_id": "12",
      "amount": "1",
      "price": "30.00",
      "extra": {
        "product": "100g Pants",
        "product_options": {
          "3": "12",
          "4": "17"
        }
      },
      "product": "100g Pants"
    }
  ]
}

Campos da resposta

Campos principais do carrinho

Campos da resposta

user_idstring
O identificador único do usuário dono do carrinho.
firstnamestring
Nome do cliente.
lastnamestring
Sobrenome do cliente.
datestring
Timestamp UNIX de quando o carrinho foi criado.
ip_addressstring
Endereço IP do cliente.
company_idstring
O id da empresa/vendedor.
cart_productsstring
Quantidade de produtos no carrinho.
totalstring
Preço total de todos os produtos do carrinho.
order_idstring
Id do pedido, se o carrinho foi convertido em pedido; caso contrário, null.
user_dataobject
Informações detalhadas sobre o usuário.
productsarray
Array com os produtos do carrinho.

Campos do objeto de produto

Campos da resposta

item_idstring
Identificador único do item do carrinho.
item_typestring
Tipo do item (P = produto).
product_idstring
Id do produto.
amountstring
Quantidade do produto no carrinho.
pricestring
Preço unitário do produto.
extraobject
Informações adicionais sobre o produto, incluindo as opções selecionadas.
productstring
Nome do produto.

Erros

StatusQuando
200 OKO carrinho existe e os detalhes dele estão no corpo.
404 Not FoundO carrinho não existe.
Dica

Os dados do carrinho incluem muitas informações do usuário, que podem ser úteis para personalização e análises. O carrinho continua acessível mesmo depois de ser convertido em pedido, até ser explicitamente limpo.

Veja também

  • Detalhes do carrinho
  • Listar carrinhos
  • Excluir um carrinho
Anterior
Paginação, ordenação e filtros
Próxima
Detalhes do carrinho
Nesta página
  • Exemplo de requisição
  • Resposta
  • Campos da resposta
  • Campos principais do carrinho
  • Campos do objeto de produto
  • Erros
  • Veja também