Retorna 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
      }
    ]
  }
]

GET

produtos

Retorna 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"

Response

200 - application/json

Sucesso

number

Identificador único do produto

Example:

1

nomePersonalizado

string

Nome personalizado do produto

Example:

"Produto Personalizado"

descricao

string

Descrição do produto

Example:

"Descrição do produto"

nomeAbreviado

string

Nome abreviado do produto

Example:

"Prod. Abreviado"

referencia

string

Referência do produto

Example:

"REF123"

nome

string

Nome do produto

Example:

"Nome do Produto"

sexo

string

Sexo do produto (M, F, U)

Example:

"M"

marca

string

Marca do produto

Example:

"Marca do Produto"

altura

number<float>

Altura do produto em centímetros

Example:

10.5

largura

number<float>

Largura do produto em centímetros

Example:

20

comprimento

number<float>

Comprimento do produto em centímetros

Example:

30

peso

number<float>

Peso do produto em kg

Example:

0.57

unidadeMedidaSigla

string

Sigla da unidade de medida do produto

Example:

"UN"

ativo

boolean

Indica se o produto está ativo

Example:

true

precoMinimo

number<float>

Preço mínimo do produto

Example:

10

precoMaximo

number<float>

Preço máximo do produto

Example:

100

ultimaAlteracao

string<date-time>

Data da última atualização do produto

Example:

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

cores

object[]

Show child attributes

cores.id

number

Identificador único da cor

Example:

1

cores.nome

string

Nome da cor

Example:

"Azul"

cores.hexadecimal

string

Código hexadecimal da cor

Example:

"#0000FF"

cores.url

string

URL da imagem da cor

Example:

"https://example.com/cor-azul.png"

marcadores

object[]

Show child attributes

marcadores.id

number

Identificador único do marcador

Example:

1

marcadores.nome

string

Nome do marcador

Example:

"Marcador 1"

imagens

object[]

Show child attributes

imagens.id

number

Identificador único da imagem

Example:

1

imagens.url

string

URL da imagem do produto

Example:

"https://example.com/imagem-produto.png"

imagens.ordem

number

Ordem de exibição da imagem

Example:

1

imagens.idCor

number

Identificador da cor associada à imagem (se aplicável)

Example:

1

grades

object[]

Show child attributes

grades.numero

string

Número da grade do produto

Example:

"M"

grades.id

number

Identificador único da grade do produto

Example:

1

grades.ean

string

EAN (código de barras) da grade do produto

Example:

"1234567890123"

grades.idCor

number

Identificador da cor associada à grade do produto (se aplicável)

Example:

1

grades.preco

number<float>

Preço da grade do produto

Example:

50

grades.precoPromocional

number<float>

Preço promocional da grade do produto (se aplicável)

Example:

45

grades.estoque

number<integer>

Quantidade em estoque da grade do produto

Example:

100

Retorna estoque de um produto Retorna pedido

⌘I

produtos-bt

pedidos-bt

pessoas-bt

tipos-lancamento-bt

filiais-bt

Retorna produtos

Authorizations

Query Parameters

Response