Skip to main content
GET
/
produtos
Buscar produtos
curl --request GET \
  --url https://api-integracoes.agulhao.com.br/produtos \
  --header 'x-api-key: <api-key>'
[
  {
    "id": 1,
    "nomePersonalizado": "Produto Personalizado",
    "descricao": "Descrição do produto",
    "nomeAbreviado": "Prod. Abreviado",
    "referencia": "REF123",
    "nome": "Nome do Produto",
    "sexo": "M",
    "marca": "Marca do Produto",
    "altura": 10.5,
    "largura": 20,
    "comprimento": 30,
    "peso": 0.57,
    "unidadeMedidaSigla": "UN",
    "ativo": true,
    "precoMinimo": 10,
    "precoMaximo": 100,
    "ultimaAlteracao": "2025-01-01T00:00:00Z",
    "cores": [
      {
        "id": 1,
        "nome": "Azul",
        "hexadecimal": "#0000FF",
        "url": "https://example.com/cor-azul.png"
      }
    ],
    "marcadores": [
      {
        "id": 1,
        "nome": "Marcador 1"
      }
    ],
    "imagens": [
      {
        "id": 1,
        "url": "https://example.com/imagem-produto.png",
        "ordem": 1,
        "idCor": 1
      }
    ],
    "grades": [
      {
        "numero": "M",
        "id": 1,
        "ean": "1234567890123",
        "idCor": 1,
        "preco": 50,
        "precoPromocional": 45,
        "estoque": 100
      }
    ]
  }
]

Authorizations

x-api-key
string
header
required

Chave da API gerada no agulhão

Query Parameters

pagina
integer
default:1

Número da página para paginação dos resultados

Example:

1

qtdePorPagina
integer
default:100

Quantidade de produtos por página

Example:

10

ultimaAtualizacao
string<date-time>

Data da última atualização dos produtos (formato ISO 8601)

Example:

"2025-01-01T00:00:00Z"

marcas
string

Filtra produtos por marcas (IDs separados por vírgula)

Example:

"1,2,3"

grupos
string

Filtra produtos por departamentos (IDs separados por vírgula)

Example:

"1,2,3"

subGrupos
string

Filtra produtos por grupos (IDs separados por vírgula)

Example:

"1,2,3"

fornecedorCod
enum<string>

Filtra produtos por código do fornecedor

Available options:
1,
0
Example:

"1"

comEstoque
enum<string>

Filtra produtos que possuem estoque

Available options:
1,
0
Example:

"1"

semEstoque
enum<string>

Filtra produtos que não possuem estoque

Available options:
1,
0
Example:

"1"

precoMin
string

Filtra produtos com preço mínimo

Example:

"10.00"

precoMax
string

Filtra produtos com preço máximo

Example:

"100.00"

filialCod
string

Filtra produtos por código da filial

Example:

"1"

radioStatus
enum<string>

Filtra produtos pelo status (A - Ativo, I - Inativo)

Available options:
A,
I
Example:

"A"

pesquisa
string

Pesquisa pela descrição do produto

Example:

"Produto"

codigoOriginal
string

Filtra produtos pelo código original

Example:

"REF123"

codigoInterno
string

Filtra produtos pelo código interno

Example:

"1"

Response

200 - application/json

Sucesso

id
integer

Identificador único do produto

nomePersonalizado
string

Nome personalizado do produto

descricao
string

Descrição do produto

nomeAbreviado
string

Prod. Abreviado

referencia
string

Referência do produto

nome
string

Nome do Produto

sexo
enum<string>

Sexo do produto (M, F, U)

Available options:
M,
F,
U
Example:

"M"

marca
string

Marca do Produto

altura
number

Altura do produto em centímetros

largura
integer

Largura do produto em centímetros

comprimento
integer

Comprimento do produto em centímetros

peso
number

Peso do produto em kg

unidadeMedidaSigla
string

Sigla da unidade de medida do produto

ativo
boolean

Indica se o produto está ativo

precoMinimo
integer

Preço mínimo do produto

precoMaximo
integer

Preço máximo do produto

ultimaAlteracao
string

Data da última atualização do produto

Example:

"2025-01-01T00:00:00Z"

cores
object[]
marcadores
object[]
imagens
object[]
grades
object[]