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
    • Alterar estágio de OP
      PUT
    • Retorna estágios de produção
      GET
    • Criar uma OP
      POST
    • Listar estágios do kanban de OPs
      GET
  • Sales
    • Listar pedidos
      GET
    • Retorna todas as vendas
      GET
    • Retorna um pedido específico
      GET
    • Retorna um pedido específico, buscando pelo código
      GET
    • Cadastrar um novo pedido
      POST
    • Cancelar um pedido
      PUT
    • Faturar um pedido
      PUT
    • Editar estágio de um pedido
      PUT
    • Listar estágios do kanban de pedidos
      GET
  • NFes
    • Lista as NFes
    • Retorna uma NFe específica
    • Retorna XML da NFe
    • Retorna DANFE da NFe
  • NFSes
    • Lista Notas Fiscais de Serviço
    • Retorna uma NFSe por id
    • Retorna XML da NFSe
    • Retorna PDF da NFSe
  • Transactions
    • Quitar lançamento financeiro
    • 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
    • Configurar webhook
  • Services
    • Retorna serviços cadastrados
  • Accounting
    • Retorna contas contábeis
  • CTes
    • Retorna CTes
    • Retorna CTe pelo id
  • Cargos
    • Editar o status de uma carga
    • Criar uma carga
    • Listar cargas
    • Retorna uma carga por id
  • Inventory
    • Movimentar estoque
  • Tags
    • Listar Tags
  1. Items

Cadastrar um novo item

POST
/items
Cadastro de item

Requisição

Parâmetros Bodyapplication/json

Exemplo
{
    "item": {
        "_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",
        "vols": 0,
        "indInventory": "string",
        "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"
            }
        ]
    },
    "composition": [
        {
            "itemId": "string",
            "variationId": "string",
            "composition": [
                {
                    "name": "string",
                    "itemId": "string",
                    "qty": 0,
                    "price": 0,
                    "variationId": "string",
                    "otherCosts": 0,
                    "details": "string",
                    "unitaryCost": 0,
                    "dimension": "UN",
                    "cost": 0,
                    "code": "string"
                }
            ]
        }
    ]
}

Códigos de solicitaçã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 '{
    "item": {
        "_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",
        "vols": 0,
        "indInventory": "string",
        "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"
            }
        ]
    },
    "composition": [
        {
            "itemId": "string",
            "variationId": "string",
            "composition": [
                {
                    "name": "string",
                    "itemId": "string",
                    "qty": 0,
                    "price": 0,
                    "variationId": "string",
                    "otherCosts": 0,
                    "details": "string",
                    "unitaryCost": 0,
                    "dimension": "UN",
                    "cost": 0,
                    "code": "string"
                }
            ]
        }
    ]
}'

Respostas

🟢200OK
application/json
Sucesso
Body

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",
        "vols": 0,
        "indInventory": "string",
        "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
Modificado em 2025-01-18 14:46:41
Página anterior
Encontrar pessoa pelo Id
Próxima página
Retorna uma lista de itens
Built with