API legada/Referência completa/Lista de desejos

GETListar lista de desejos

Devolve os produtos da lista de desejos de um cliente, em três formatos escolhidos por scope.

Use esta rota para mostrar a lista de desejos de um cliente em outro sistema, ou para saber quais produtos ele guardou. O parâmetro scope escolhe o formato da resposta, herdado da API 1.0: sem scope você recebe uma lista simples; com get_wishlist, a lista no formato da aba; com get_tabs, só as abas.

GET/api/v1.0/wishlistsAutenticada

Listar a lista de desejos

Parâmetros de consulta

user_iduuidobrigatório

Id do cliente (UUID). Obrigatório em todos os formatos.

scopestring

get_tabsget_wishlist

Formato da resposta. Omitido (ou qualquer outro valor), devolve a lista simples. get_tabs devolve só as abas; get_wishlist devolve os produtos no formato de aba.

pageintegerpadrão: 1

Página, a partir de 1. Não se aplica a get_tabs.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Valor inválido ou acima de 250 volta ao padrão de 10. Não se aplica a get_tabs.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/wishlists?user_id=3dc023ca-3746-4b6e-8afd-686a4a9af99f&items_per_page=10"

Resposta

200Lista simples (sem scope)

json

{
  "wishlists": [
    { "product_id": "9f1c2a7e-5b34-4c1d-8a62-0d7e4b5c1a10", "product": "Camiseta Básica", "price": "49.90" }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

200Formato de aba (scope=get_wishlist)

json

{
  "products_data": [
    {
      "cart_id": "c1a2b3d4-1111-4a5b-9c6d-7e8f90a1b2c3",
      "product_id": "9f1c2a7e-5b34-4c1d-8a62-0d7e4b5c1a10",
      "tab_id": "default",
      "display_amount": 1,
      "display_subtotal": "49.90",
      "price": "49.90",
      "product": "Camiseta Básica",
      "main_pair": null
    }
  ],
  "tab_data": [ { "tab_id": "default", "name": "Wishlist" } ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

200Abas (scope=get_tabs)

json

{
  "tabs": [ { "tab_id": "default", "name": "Wishlist" } ]
}

Campos da resposta

product_iduuid

Id do produto.

productstring

Nome do produto.

pricestring

Preço atual do produto, texto decimal em reais ("49.90").

cart_iduuid

Id do registro na lista (só em get_wishlist).

tab_idstring

Sempre default.

display_amountinteger

Sempre 1.

display_subtotalstring

Igual a price, texto decimal.

main_pairnull

Sempre null: a imagem não vem nesta rota.

paramsobject

Paginação: page, items_per_page, total_items.

Erros

Status	Quando	Corpo de exemplo
400	`user_id` ausente.	`{"message":"user_id is required","status":400}`
401	Sem credencial.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
401	E-mail ou chave inválidos.	`{"message":"Invalid credentials","status":401}`
500	`user_id` que não é um UUID.	`{"message":"...","status":500}`

Veja também

GETListar lista de desejos

Devolve os produtos da lista de desejos de um cliente, em três formatos escolhidos por scope.

GET/api/v1.0/wishlistsAutenticada

Listar a lista de desejos

Parâmetros de consulta

user_iduuidobrigatório

Id do cliente (UUID). Obrigatório em todos os formatos.

scopestring

get_tabsget_wishlist

Formato da resposta. Omitido (ou qualquer outro valor), devolve a lista simples. get_tabs devolve só as abas; get_wishlist devolve os produtos no formato de aba.

pageintegerpadrão: 1

Página, a partir de 1. Não se aplica a get_tabs.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Valor inválido ou acima de 250 volta ao padrão de 10. Não se aplica a get_tabs.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/wishlists?user_id=3dc023ca-3746-4b6e-8afd-686a4a9af99f&items_per_page=10"

Resposta

200Lista simples (sem scope)

json

{
  "wishlists": [
    { "product_id": "9f1c2a7e-5b34-4c1d-8a62-0d7e4b5c1a10", "product": "Camiseta Básica", "price": "49.90" }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

200Formato de aba (scope=get_wishlist)

json

{
  "products_data": [
    {
      "cart_id": "c1a2b3d4-1111-4a5b-9c6d-7e8f90a1b2c3",
      "product_id": "9f1c2a7e-5b34-4c1d-8a62-0d7e4b5c1a10",
      "tab_id": "default",
      "display_amount": 1,
      "display_subtotal": "49.90",
      "price": "49.90",
      "product": "Camiseta Básica",
      "main_pair": null
    }
  ],
  "tab_data": [ { "tab_id": "default", "name": "Wishlist" } ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 1 }
}

200Abas (scope=get_tabs)

json

{
  "tabs": [ { "tab_id": "default", "name": "Wishlist" } ]
}

Campos da resposta

product_iduuid

Id do produto.

productstring

Nome do produto.

pricestring

Preço atual do produto, texto decimal em reais ("49.90").

cart_iduuid

Id do registro na lista (só em get_wishlist).

tab_idstring

Sempre default.

display_amountinteger

Sempre 1.

display_subtotalstring

Igual a price, texto decimal.

main_pairnull

Sempre null: a imagem não vem nesta rota.

paramsobject

Paginação: page, items_per_page, total_items.

Erros

Status	Quando	Corpo de exemplo
400	`user_id` ausente.	`{"message":"user_id is required","status":400}`
401	Sem credencial.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
401	E-mail ou chave inválidos.	`{"message":"Invalid credentials","status":401}`
500	`user_id` que não é um UUID.	`{"message":"...","status":500}`