REFERÊNCIA DA API

Produtos

Catálogo de produtos e perfil fiscal.

GET/products#

Listar products

Permissão necessária products:read

Parâmetros

pagequery · integer

per_pagequery · integer

searchquery · string

skuquery · string

integration_codequery · integer

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataarrayobrigatório

data[].namestring

data[].skunullable

data[].descriptionnullable

data[].sale_pricenullable

data[].unitnullable

data[].is_activeboolean

data[].fiscalnullable

data[].idintegerobrigatório

data[].revisionstringobrigatório

data[].codestring

data[].integration_codeinteger

metaobjectobrigatório

meta.pageintegerobrigatório

meta.per_pageintegerobrigatório

meta.totalintegerobrigatório

meta.last_pageintegerobrigatório

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/products' \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

POST/products#

Criar products

Permissão necessária products:write

Parâmetros

Idempotency-Keyheader · stringobrigatório

UUID obrigatório em POST/PATCH. Mesmo owner/ambiente/chave com operação ou conteúdo diferente retorna 409.

Corpo da requisição application/json · 9 campos

namestringobrigatório

skunullable

descriptionnullable

sale_pricestringobrigatório

unitintegerobrigatório

ID da unidade previamente cadastrada na mesma empresa.

is_activebooleanobrigatório

fiscalobjectobrigatório

fiscal.ncmstringobrigatório

fiscal.gtinnullable

Respostas HTTP

201

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.namestring

data.skunullable

data.descriptionnullable

data.sale_pricenullable

data.unitnullable

data.is_activeboolean

data.fiscalnullable

data.idintegerobrigatório

data.revisionstringobrigatório

data.codestring

data.integration_codeinteger

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/products' \
  -X POST \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: AQUI_VAI_O_UUID' \
  --data '{
  "name": "AQUI_VAI_O_VALOR",
  "sale_price": "AQUI_VAI_O_VALOR",
  "unit": 1,
  "is_active": false,
  "fiscal": {
    "ncm": "AQUI_VAI_O_VALOR"
  }
}'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

Exemplo de estrutura: substitua IDs, valores e UUIDs pelos dados conferidos da sua operação. O portal não executa este código.

GET/products/{id}#

Consultar products

Permissão necessária products:read

Parâmetros

idpath · integerobrigatório

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.namestring

data.skunullable

data.descriptionnullable

data.sale_pricenullable

data.unitnullable

data.is_activeboolean

data.fiscalnullable

data.idintegerobrigatório

data.revisionstringobrigatório

data.codestring

data.integration_codeinteger

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/products/{id}' \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

PATCH/products/{id}#

Atualizar products

Permissão necessária products:write

Parâmetros

idpath · integerobrigatório

Idempotency-Keyheader · stringobrigatório

UUID obrigatório em POST/PATCH. Mesmo owner/ambiente/chave com operação ou conteúdo diferente retorna 409.

Corpo da requisição application/json · 10 campos

namestring

skunullable

descriptionnullable

sale_pricestring

unitinteger

ID da unidade previamente cadastrada na mesma empresa.

is_activeboolean

fiscalobject

fiscal.ncmstringobrigatório

fiscal.gtinnullable

revisionstringobrigatório

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.namestring

data.skunullable

data.descriptionnullable

data.sale_pricenullable

data.unitnullable

data.is_activeboolean

data.fiscalnullable

data.idintegerobrigatório

data.revisionstringobrigatório

data.codestring

data.integration_codeinteger

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/products/{id}' \
  -X PATCH \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: AQUI_VAI_O_UUID' \
  --data '{
  "revision": "AQUI_VAI_O_VALOR"
}'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

Exemplo de estrutura: substitua IDs, valores e UUIDs pelos dados conferidos da sua operação. O portal não executa este código.