YAyampi
Público - Busca

Listar Produtos da loja

Changed on

Retorna as informações públicas de produtos de uma loja

get/{alias}/public/search/products/

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/public/search/products/
  • Auth
    none required

Path parameters

aliasstring required

Alias da loja

Request body

context'search' | 'category' | 'collection' | 'promotion' required

Contexto da listagem: 'search' para busca por palavra-chave, 'category' para filtrar por categoria, 'collection' para coleção, 'promotion' para promoções.

qstring nullable

Palavra-chave para busca. Obrigatório quando 'context' = 'search'.

slugstring nullable

Identificador slug de categoria, coleção ou promoção. Obrigatório quando 'context' != 'search'.

minnumber float nullable

Preço mínimo para filtro.

maxnumber float nullable

Preço máximo para filtro.

brand_idinteger[] nullable

IDs das marcas dos produtos.

category_idinteger[] nullable

IDs das categorias dos produtos.

filter_idinteger[] nullable

IDs dos filtros dos produtos. Valores negativos identificam variações.

Example request

{
  "context": "search",
  "q": "smartphone",
  "slug": "eletronicos",
  "min": 100,
  "max": 500,
  "brand_id": [
    1,
    2,
    3
  ],
  "category_id": [
    10,
    12
  ],
  "filter_id": [
    5,
    6
  ]
}

Response

Informações públicas dos produtos da Loja

metaobject[]

Metadados adicionais sobre a listagem (normalmente vazio).

Example response

{
  "data": [
    {
      "id": 30405927,
      "sku_id": 205264039,
      "simple": true,
      "name": "Camisa JAO",
      "slug": "camisa-jao",
      "sku": "TPHNCWXYW",
      "url": "https://www.yampiwoocommerce.com/camisa-jao/p",
      "url_path": "/camisa-jao/p",
      "brand": {
        "id": 14542735,
        "name": "aefaefaefaef"
      },
      "images": {
        "url": "https://images.yampi.me/assets/stores/minhalojateste/uploads/images/camisa-jao-6618280300ca4-large.jpg"
      },
      "prices": {
        "currency": "R$",
        "price_cost_formated": "R$ 0,00",
        "price_formated": "R$ 0,00",
        "base_amount": "0",
        "fraction_amount": "00",
        "price_sale_formated": "R$ 0,00",
        "price_discount_formated": "R$ 0,00",
        "billet": {
          "price_formated": "R$ 0,00",
          "base_amount": "0",
          "fraction_amount": "00",
          "discount_percent": "0.00",
          "discount_text": "R$ 0,00 à vista com 0.00% de desconto"
        },
        "pix": {
          "price_formatted": "R$ 0,00",
          "base_amount": "0",
          "fraction_amount": "00",
          "discount_percent": "0.00",
          "discount_text": "R$ 0,00 à vista com 0.00% de desconto"
        },
        "installments": {
          "max_installment": 6,
          "text": "6x de R$ 0,00 com juros",
          "text_with_tax": "6x de R$ 0,00"
        }
      }
    }
  ]
}

Changes