Pular para o conteúdo
Olist Ecommerce

Busca os produtos

GET
/api/v2/products/search

Busca os produtos de acordo com os parâmetros definidos

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Query Parameters

Seção intitulada “Query Parameters ”
page
integer

Número da página

per_page
integer

Quantidade de produtos por página

ids[]
Array<integer>

Filtra pelo ID dos produtos

term
string

Filtra produtos que contenham o termo

wildcard
boolean

Permite que o filtro ‘term’ realize filtragem de produtos por termo parcial

type_tags

Filtra pelo nome da tag dentro de um tipo de tag. Ex: [nome_da_tag][]=valor_da_tag

Obs. Para conseguir testar com filtro de type_tags, copie o curl gerado, substitua 'nome_da_tag' pelo type desejado e execute no seu terminal ou em alguma plataforma que permita enviar solicitações HTTP

object
key
additional properties
Array<string>
type_tags_operator
string
Allowed values: and or

Operador lógico para o filtro de tag

property1_values
Array<string>

Filtra pelo valor da propriedade 1

property1_operator
string
Allowed values: and or

Operador lógico para o filtro de valor da propriedade 1

property2_values
Array<string>

Filtra pelo valor da propriedade 2

property2_operator
string
Allowed values: and or

Operador lógico para o filtro de valor da propriedade 2

property3_values
Array<string>

Filtra pelo valor da propriedade 3

property3_operator
string
Allowed values: and or

Operador lógico para o filtro de valor da propriedade 3

min_price
number

Filtra pelo preço de venda mínimo do produto

max_price
number

Filtra pelo preço de venda máximo do produto

tags
Array<string>

Filtra pelo nome das tags, independente do tipo

parent_tags
Array<string>

Filtra pelo nome das tags, independente do tipo

show_only_available
boolean

Filtra por produtos disponíveis

sort
string
Allowed values: az za newest oldest lowest_price highest_price

Ordena o resultado da busca de produtos conforme a opção escolhida

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Quando os produtos são encontrados

object
results
Array<object>
ProductSearch

Modelo que representa um produto retornado via busca no Elasticsearch

object
id
required
integer
active
required
boolean
available
required
boolean
subscription
required
boolean
slug
required
string
reference
required
string
reference_lowercase
required
string
name
required
string
description
required
string
nullable
image_url
required
string
nullable
url
required
string
tags
required
Array<object>
object
name
required
string
/[a-z0-9\-_]+/
title
required
string
subtitle
required
string
nullable
description
required
string
nullable
importance
required
number
nullable
type
required
string
image_url
required
string
nullable
price
required
number
on_sale
required
boolean
sale_price
required
number
intl_price
required
number
discount_id
required
integer
discount_rule
required
object
type
required
string
Allowed values: fixed percentage
amount
required
number
discount
required
object
name
required
string
description
required
string
facebook
required

Em desuso

boolean
valid_to
required
string
images
required
Array<object>
object
sku
required
string
url
required
string
nullable
variants
required
Array<object>
VariantProductSearch

Modelo que representa uma variante retornada via busca no Elasticsearch

object
id
required
integer
>= 1
sku
required
string
>= 1 characters
sku_lowercase
required
string
>= 1 characters
name
required
string
nullable
full_name
required
string
>= 1 characters
main
required
boolean
available
required
boolean
image_url
required
string
nullable
price
required
number
sale_price
required
number
intl_price
required
number
installments
required
Array<object>
ProductInstallment

Modelo que representa uma parcela

object
number
required
integer
price
required
number
interest
required
boolean
interest_rate
required
number
total
required
number
stock
required
integer
quantity
required
integer
quantity_sold
required
integer
min_quantity
required
integer
available_quantity
required
integer
custom_attributes
required
object
properties
required
object
property1
VariantPropertyProductSearch

Modelo que representa uma propriedade de uma variante quando retornada via Elasticsearch

object
name
required
string
value
required
string
defining
required
boolean
property2
VariantPropertyProductSearch

Modelo que representa uma propriedade de uma variante quando retornada via Elasticsearch

object
name
required
string
value
required
string
defining
required
boolean
property3
VariantPropertyProductSearch

Modelo que representa uma propriedade de uma variante quando retornada via Elasticsearch

object
name
required
string
value
required
string
defining
required
boolean
inventories
required
Array<object>
object
name
required
string
nullable
slug
required
string
>= 1 characters
available
required
boolean
price
required
number
sale_price
required
number
quantity
required
number
nullable
quantity_sold
required
number
place
required
object
id
required
number
name
required
string
handling_days
required
integer
barcode
required
string
nullable
weight
required
number
width
required
number
height
required
number
length
required
number
installments
required
Array<object>
ProductInstallment

Modelo que representa uma parcela

object
number
required
integer
price
required
number
interest
required
boolean
interest_rate
required
number
total
required
number
created_at
required
string format: date-time
updated_at
required
string format: date-time
aggregations
object
min_price
number
max_price
number
types
object
properties
object
property1
Array<object>
object
value
string
count
number
property2
Array<object>
object
value
string
count
number
property3
Array<object>
object
value
string
count
number
Examples
{
  "results": [
    {
      "id": 0,
      "active": true,
      "available": true,
      "subscription": true,
      "slug": "string",
      "reference": "string",
      "reference_lowercase": "string",
      "name": "string",
      "description": "string",
      "image_url": "string",
      "url": "string",
      "tags": [
        {
          "name": "string",
          "title": "string",
          "subtitle": "string",
          "description": "string",
          "importance": 0,
          "type": "string",
          "image_url": "string"
        }
      ],
      "price": 0,
      "on_sale": true,
      "sale_price": 0,
      "intl_price": 0,
      "discount_id": 0,
      "discount_rule": {
        "type": "fixed",
        "amount": 0
      },
      "discount": {
        "name": "string",
        "description": "string",
        "facebook": true,
        "valid_to": "string"
      },
      "images": [
        {
          "sku": "string",
          "url": "string"
        }
      ],
      "variants": [
        {
          "id": 1,
          "sku": "string",
          "sku_lowercase": "string",
          "name": "string",
          "full_name": "string",
          "main": true,
          "available": true,
          "image_url": "string",
          "price": 0,
          "sale_price": 0,
          "intl_price": 0,
          "installments": [
            {
              "number": 1,
              "price": 10,
              "interest": false,
              "interest_rate": 0,
              "total": 10
            }
          ],
          "stock": 0,
          "quantity": 0,
          "quantity_sold": 0,
          "min_quantity": 0,
          "available_quantity": 0,
          "custom_attributes": {},
          "properties": {
            "property1": {
              "defining": true,
              "name": "string",
              "value": "string"
            },
            "property2": {
              "defining": true,
              "name": "string",
              "value": "string"
            },
            "property3": {
              "defining": true,
              "name": "string",
              "value": "string"
            }
          },
          "inventories": [
            {
              "name": null,
              "slug": "string",
              "available": true,
              "price": 0,
              "sale_price": 0,
              "quantity": 0,
              "quantity_sold": 0,
              "place": {
                "id": 0,
                "name": "string"
              }
            }
          ],
          "handling_days": 0,
          "barcode": "string",
          "weight": 0,
          "width": 0,
          "height": 0,
          "length": 0
        }
      ],
      "installments": [
        {
          "number": 1,
          "price": 10,
          "interest": false,
          "interest_rate": 0,
          "total": 10
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "aggregations": {
    "min_price": 0,
    "max_price": 0,
    "types": {
      "tag_0": [
        {
          "name": "string",
          "title": "string",
          "count": 0
        },
        {
          "name": "string",
          "title": "string",
          "count": 0
        }
      ],
      "tag_1": [
        {
          "name": "string",
          "title": "string",
          "count": 0
        }
      ]
    },
    "properties": {
      "property1": [
        {
          "value": "string",
          "count": 0
        }
      ],
      "property2": [
        {
          "value": "string",
          "count": 0
        }
      ],
      "property3": [
        {
          "value": "string",
          "count": 0
        }
      ]
    }
  }
}