Skip to content
API/
/v1

Retornar os produtos por filtro

Request

Permite listar os produtos cadastrados, com suporte a filtros como página, tamanho, busca por nome, sku ou ean, status ("ativo", "inativo") e ordenação.

Security
BearerAuth
Query
paginainteger

Página

Default:1
tamanho_paginainteger

Tamanho da página

Default:10
Enum:1020501002005001000
campo_ordenacaostring

Campos de ordenação

Default:"NOME"
Enum:"NOME""CODIGO""VALOR_VENDA"
direcao_ordenacaostring

Direção de ordenação

Default:"ASC"
Enum:"ASC""DESC"
buscastring

Busca textual pelo nome, ean ou sku do produto

statusstring

Status do produto

Default:"ATIVO"
Enum:"ATIVO""INATIVO"
integracao_ecommerce_ativoboolean

Produtos com integração ativa

Default:false
produtos_kit_ativoboolean

Filtrar com kits de produto

Default:false
valor_venda_inicialnumber, (float64)

Intervalo inicial do valor de venda

valor_venda_finalnumber, (float64)

Intervalo final do valor de venda

skustring

SKU do produto para filtro exato

data_alteracao_destring

Data de alteração de (ISO 8601, São Paulo/GMT-3)

data_alteracao_atestring

Data de alteração até (ISO 8601, São Paulo/GMT-3)

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/produtos?pagina=1&tamanho_pagina=10&campo_ordenacao=NOME&direcao_ordenacao=ASC&busca=string&status=ATIVO&integracao_ecommerce_ativo=false&produtos_kit_ativo=false&valor_venda_inicial=0&valor_venda_final=0&sku=string&data_alteracao_de=string&data_alteracao_ate=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itemsArray of objects(ItemResumoDeProdutos)

Lista de itens do resumo de produtos

totalItemsinteger

Total de itens encontrados

Example:10
Response
{
  "items": [
    { … }
  ],
  "totalItems": 10
}