Sensio API
  1. Items
Sensio API
  • Introdução
  • People
    • Buscar pessoas cadastradas
      GET
    • Cadastrar uma nova pessoa
      POST
    • Encontrar pessoa pelo Id
      GET
  • Items
    • Cadastrar um novo item
      POST
    • Retorna uma lista de itens
      GET
    • Retorna um item específico
      GET
    • Editar item
      POST
    • Retorna as composições do item e/ou das variações
      GET
  • POs
    • Retorna todas as ordens de produção
      GET
    • Retorna uma ordem de produção específica
      GET
    • Retorna uma ordem de produção específica buscando pelo código
      GET
  • Sales
    • Retorna listagem de pedidos
      GET
    • Retorna todos as vendas (apenas vendas)
      GET
    • Cadastrar um novo pedido
      POST
    • Retorna um pedido específico
      GET
    • Retorna um pedido específico, buscando pelo código
      GET
  • NFes
    • Lista as NFes
      GET
    • Retorna uma NFe específica
      GET
    • Retorna XML da NFe
      GET
    • Retorna DANFE da NFe
      GET
  • NFSes
    • Lista Notas Fiscais de Serviço
      GET
    • Retorna uma NFSe por id
      GET
    • Retorna XML da NFSe
      GET
    • Retorna PDF da NFSe
      GET
  • Transactions
    • Cadastrar um novo lançamento financeiro
    • Retorna lançamentos paginados
    • Retorna um lançamento específico
  • Item Categories
    • Listar categorias de itens
  • Warehouses
    • Lista os depósitos
  • Custom Fields
    • Listar Campos Personalizados
  • Batches
    • Retorna lotes de um item
    • Listar lotes
  • Webhooks
    • Atualiza a URL chamada ao criar uma NFe
    • Formato de chamada do webhook ao importar uma NFe
  • Services
    • Retorna serviços cadastrados
  • Accounting
    • Retorna contas contábeis
  • CTes
    • Retorna CTes
    • Retorna CTe pelo id
  1. Items

Cadastrar um novo item

POST
/items
Items
Cadastro de item

Requisição

Parâmetros Bodyapplication/json
item
object (item) 
opcional
_id
string 
requerido
Somente na edição do item
type
enum<string> 
requerido
tipo do item.
Valores permitidos:
ProdutoPeçaMatéria-primaMaterial de costumoAtivo imobilizadoVeículoOutros
name
string 
requerido
Nome do item.
price
number <float>
requerido
Valor do item.
category
string 
opcional
Id que referência a categoria.
status
enum<string> 
opcional
status do item.
Valores permitidos:
Ativoremoved
cost
number <float>
opcional
Custo do item.
child
string 
opcional
margin
number <float>
opcional
Valor que define junto com o custo o preço final do produto, a margin é trabalhada em %.
code
string 
requerido
Código do item.
warehouse
string 
opcional
Id do depósito padrão em que a quantidade do item será adicionado ou removido.
variations
array[object (variation) {15}] 
opcional
Variações que um item pode ter, caso adicionados , são desprezados o preço e quantidade do item.
veic
array[object (veic) {9}] 
opcional
Em caso de selecionado o tipo como Veículo.
color
string 
opcional
tags
array[object (item_tags) {1}] 
opcional
Array de Ids, onde cada tag obrigatóriamente tem que fazer parte do escopo de itens.
currentQty
integer 
opcional
Quantidade atual contida nos depósitos.
minQty
integer 
opcional
criticalQty
integer 
opcional
Valor informado de quantidade crítica, quando a quantidade em estoque chega a quantidade crítica é informado via frontend que este item está na quantidade crítica.
warehouses
array[object (item_warehouses) {2}] 
requerido
Array de depósitos onde contém a quantidade de item em cada um deles.
dimension
enum<string> 
requerido
Valores permitidos:
UNKGGTTONMTM2M3CMCM2CM3PTBBCXCTCJPCTBMILFRDLMLRLPercentualUND
brand
string 
opcional
Marca do item.
supplierCode
string 
opcional
ipi
integer 
opcional
Valor do ipi (Imposto sobre produtos industrializados) em %.
cest
string 
opcional
Código especificador da substituição tributária.
pMVAST
string 
opcional
Percentual da margem de valor adicionado do ICMS ST da NF-e.
ncm
string 
opcional
Nomenclatura comum do Mercosul.
orig
enum<string> 
opcional
Origem do item.
Valores permitidos:
0 - Nacional1 - Estrangeira - Importação direta2 - Estrangeira - Adquirida no mercado interno3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%
ean
string 
opcional
European Article Number, código barras único do item. Caso ele não tenha , é possível adicionar um código interno.
kit
boolean 
opcional
netWeight
integer 
opcional
Peso líquido do item em Kg.
grossWeight
integer 
opcional
Peso bruto do item em Kg.
height
integer 
opcional
Altura do item em cm.
width
integer 
opcional
Largura do item em cm.
itemLength
number <float>
opcional
Comprimento do item em cm.
comission
number <float>
opcional
comissionValue
number <float>
opcional
dateCreate
string 
opcional
Data da criação do item, já existe de forma padrão a criação dela.
adjustItem
string 
opcional
Nome de item de ajuste.
parentAdjustItem
string 
opcional
vols
integer 
opcional
Volumes do item.
genero
string 
opcional
description
string 
opcional
Descrição do item.
company
string 
opcional
Empresa em que o item será cadastrado, já existe a busca da empresa por meio do token informado.
user
string 
opcional
Usuário que cadastrou o item , já existe a busca do usuário por meio do token informado.
purchaseAccount
string 
opcional
Conta contábil de compra.
config
object (item_config) 
opcional
ecommerces
array[object (item_ecommerces) {2}] 
opcional
Integrações de ecommerces disponibilizados pela Sensio para importação do produto (Tray, HubSpot, RD Station CRM, Irroba, Loja integrada, NuvemShop).
ativo
object (item_ativo) 
opcional
images
array[object (image) {4}] 
opcional
Images do item feitas via upload.
customFields
array[object (item_customFields) {2}] 
opcional
Campos personalizáveis para adição de novas informações no item.
updates
array[object (item_updates) {3}] 
opcional
As atualizações são adicionadas automaticamente quando é feito alguma mudança no item.
composition
array[object (composition) {3}] 
opcional
itemId
string 
opcional
Não precisa ser informado na criação do item
variationId
string 
opcional
Informar o código da variação quando ela é uma nova variação
composition
array[object (compositionChild) {11}] 
requerido
Exemplo

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/items' \
--header 'Content-Type: application/json' \
--data-raw ''

Respostas

🟢200OK
application/json
Sucesso
Body
success
boolean 
opcional
Padrão:
true
message
string 
opcional
Padrão:
New Item registered
response
object (item) 
opcional
_id
string 
requerido
Somente na edição do item
type
enum<string> 
requerido
tipo do item.
Valores permitidos:
ProdutoPeçaMatéria-primaMaterial de costumoAtivo imobilizadoVeículoOutros
name
string 
requerido
Nome do item.
price
number <float>
requerido
Valor do item.
category
string 
opcional
Id que referência a categoria.
status
enum<string> 
opcional
status do item.
Valores permitidos:
Ativoremoved
cost
number <float>
opcional
Custo do item.
child
string 
opcional
margin
number <float>
opcional
Valor que define junto com o custo o preço final do produto, a margin é trabalhada em %.
code
string 
requerido
Código do item.
warehouse
string 
opcional
Id do depósito padrão em que a quantidade do item será adicionado ou removido.
variations
array[object (variation) {15}] 
opcional
Variações que um item pode ter, caso adicionados , são desprezados o preço e quantidade do item.
veic
array[object (veic) {9}] 
opcional
Em caso de selecionado o tipo como Veículo.
color
string 
opcional
tags
array[object (item_tags) {1}] 
opcional
Array de Ids, onde cada tag obrigatóriamente tem que fazer parte do escopo de itens.
currentQty
integer 
opcional
Quantidade atual contida nos depósitos.
minQty
integer 
opcional
criticalQty
integer 
opcional
Valor informado de quantidade crítica, quando a quantidade em estoque chega a quantidade crítica é informado via frontend que este item está na quantidade crítica.
warehouses
array[object (item_warehouses) {2}] 
requerido
Array de depósitos onde contém a quantidade de item em cada um deles.
dimension
enum<string> 
requerido
Valores permitidos:
UNKGGTTONMTM2M3CMCM2CM3PTBBCXCTCJPCTBMILFRDLMLRLPercentualUND
brand
string 
opcional
Marca do item.
supplierCode
string 
opcional
ipi
integer 
opcional
Valor do ipi (Imposto sobre produtos industrializados) em %.
cest
string 
opcional
Código especificador da substituição tributária.
pMVAST
string 
opcional
Percentual da margem de valor adicionado do ICMS ST da NF-e.
ncm
string 
opcional
Nomenclatura comum do Mercosul.
orig
enum<string> 
opcional
Origem do item.
Valores permitidos:
0 - Nacional1 - Estrangeira - Importação direta2 - Estrangeira - Adquirida no mercado interno3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%
ean
string 
opcional
European Article Number, código barras único do item. Caso ele não tenha , é possível adicionar um código interno.
kit
boolean 
opcional
netWeight
integer 
opcional
Peso líquido do item em Kg.
grossWeight
integer 
opcional
Peso bruto do item em Kg.
height
integer 
opcional
Altura do item em cm.
width
integer 
opcional
Largura do item em cm.
itemLength
number <float>
opcional
Comprimento do item em cm.
comission
number <float>
opcional
comissionValue
number <float>
opcional
dateCreate
string 
opcional
Data da criação do item, já existe de forma padrão a criação dela.
adjustItem
string 
opcional
Nome de item de ajuste.
parentAdjustItem
string 
opcional
vols
integer 
opcional
Volumes do item.
genero
string 
opcional
description
string 
opcional
Descrição do item.
company
string 
opcional
Empresa em que o item será cadastrado, já existe a busca da empresa por meio do token informado.
user
string 
opcional
Usuário que cadastrou o item , já existe a busca do usuário por meio do token informado.
purchaseAccount
string 
opcional
Conta contábil de compra.
config
object (item_config) 
opcional
ecommerces
array[object (item_ecommerces) {2}] 
opcional
Integrações de ecommerces disponibilizados pela Sensio para importação do produto (Tray, HubSpot, RD Station CRM, Irroba, Loja integrada, NuvemShop).
ativo
object (item_ativo) 
opcional
images
array[object (image) {4}] 
opcional
Images do item feitas via upload.
customFields
array[object (item_customFields) {2}] 
opcional
Campos personalizáveis para adição de novas informações no item.
updates
array[object (item_updates) {3}] 
opcional
As atualizações são adicionadas automaticamente quando é feito alguma mudança no item.
Exemplo
{
  "success": true,
  "message": "New Item registered",
  "response": {
    "_id": "string",
    "type": "Produto",
    "name": "string",
    "price": 0,
    "category": "string",
    "status": "Ativo",
    "cost": 0,
    "child": "string",
    "margin": 0,
    "code": "string",
    "warehouse": "string",
    "variations": [
      {
        "code": "string",
        "name": "string",
        "ean": "string",
        "price": 0,
        "netWeight": 0,
        "grossWeight": 0,
        "height": 0,
        "width": 0,
        "itemLength": 0,
        "status": "Ativo",
        "currentQty": 0,
        "criticalQty": 0,
        "images": [
          {
            "name": "string",
            "size": 0,
            "key": "string",
            "url": "string"
          }
        ],
        "ecommerces": [
          {
            "name": "string",
            "sku": "string"
          }
        ],
        "warehouse": [
          {
            "warehouse": "string",
            "currentQty": 0
          }
        ]
      }
    ],
    "veic": [
      {
        "companyProperty": true,
        "ativoImobilizado": false,
        "plate": "string",
        "uf": "string",
        "renavam": "string",
        "RNTRC": "string",
        "year": "string",
        "chassi": "string",
        "condutor": "string"
      }
    ],
    "color": "string",
    "tags": [
      {
        "tagId": "string"
      }
    ],
    "currentQty": 0,
    "minQty": 0,
    "criticalQty": 0,
    "warehouses": [
      {
        "warehouse": "string",
        "currentQty": 0
      }
    ],
    "dimension": "UN",
    "brand": "string",
    "supplierCode": "string",
    "ipi": 0,
    "cest": "string",
    "pMVAST": "string",
    "ncm": "string",
    "orig": "0 - Nacional",
    "ean": "string",
    "kit": true,
    "netWeight": 0,
    "grossWeight": 0,
    "height": 0,
    "width": 0,
    "itemLength": 0,
    "comission": 0,
    "comissionValue": 0,
    "dateCreate": "string",
    "adjustItem": "string",
    "parentAdjustItem": "string",
    "vols": 0,
    "genero": "string",
    "description": "string",
    "company": "string",
    "user": "string",
    "purchaseAccount": "string",
    "config": {
      "cstICMS": "00 - Tributada integralmente,",
      "cstIPI": "00 - Entrada com recuperação de crédito",
      "cstPIS": "01 - Operação tributável com alíquota normal",
      "cstCOFINS": "01 - Operação tributável com alíquota normal",
      "pPIS": 0,
      "pCONFIS": 0
    },
    "ecommerces": [
      {
        "name": "string",
        "sku": "string"
      }
    ],
    "ativo": {
      "ident": "string",
      "descr": "string",
      "vida_util": "string"
    },
    "images": [
      {
        "name": "string",
        "size": 0,
        "key": "string",
        "url": "string"
      }
    ],
    "customFields": [
      {
        "fieldId": "string",
        "value": "string"
      }
    ],
    "updates": [
      {
        "user": "string",
        "timestamp": "YYYY-MM-DD HH:mm:ss",
        "description": "string"
      }
    ]
  }
}
🟠400Bad Request
🔴500Server Error
Modified at 2025-01-18 14:46:41
Página anterior
Encontrar pessoa pelo Id
Próxima página
Retorna uma lista de itens
Built with