Criar item

POST https://.account-name.krzlabs.io/api/v1/orders/:id/items

Realiza a criação de um item.

---

Path Params

id string required

ID do pedido.

---

Body Params

Field	Type	Description	Optional	Searchable
order_id	string	ID do pedido	required	false
order_code	string	Código do pedido	required	false
branch	string	Filial associada	required	false
discount	number	Valor de desconto	not required	false
image	string	URL da imagem do item	not required	false
name	string	Nome do item	not required	false
code	string	Código do item	not required	false
price	number	Preço unitário	not required	false
list_price	number	Preço de tabela	not required	false
cost_price	number	Preço de custo	not required	false
selling_price	number	Preço de venda	not required	false
shipping_price	number	Preço do frete	not required	false
quantity	number	Quantidade do item	not required	false
ref_item_code	string	Código do item de referência	not required	false
ref_item_branch	string	Filial do item de referência	not required	false
ref_item_operation	OrderRefItemOperationEnum	Operação do item de referência	not required	false
conditions	OrderItemConditionType[]	Condições aplicadas ao item	not required	false
metadata	Record<string, string>	Metadados adicionais	not required	false

Enum OrderItemConditionType

Value	Description
ADD	Adiciona o item de referência
REMOVE	Remove o item de referência

Exemplo em JSON

{
  "_id": "66b8f4f9d9f4ab1234567890",
  "order_id": "66b8f4a0d9f4ab1234567890",
  "order_code": "ORD-20250813-001",
  "code": "ITEM-001",
  "branch": "SP01",
  "name": "Produto Exemplo",
  "image": "https://exemplo.com/produto.jpg",
  "quantity": 2,
  "price": 150.5,
  "list_price": 180.0,
  "cost_price": 100.0,
  "selling_price": 160.0,
  "shipping_price": 20.0,
  "discount": 10.0,
  "ref_item_code": "REF-ITEM-123",
  "ref_item_branch": "SP02",
  "ref_item_operation": "ADD",
  "conditions": [
    {
      "kind": "PROMO",
      "code": "DESC10",
      "label": "Desconto de 10%",
      "caption": "Campanha de desconto",
      "description": "Aplicado desconto promocional de 10% no item",
      "value": 10,
      "factor": -1
    },
    {
      "kind": "TAX",
      "code": "ICMS",
      "label": "Imposto ICMS",
      "caption": "Imposto estadual",
      "description": "Cobrança de ICMS sobre o item",
      "value": 18,
      "factor": 1
    }
  ],
  "metadata": {
    "color": "vermelho",
    "size": "M"
  }
}

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
_id	string	Identificador único do item do pedido	not required	false
order_id	string	Identificador do pedido	not required	false
order_code	string	Código do pedido	required	false
code	string	Código do item	required	false
branch	string	Filial do item	required	false
name	string	Nome do item	required	false
image	string	URL da imagem do item	required	false
quantity	number	Quantidade do item	required	false
price	number	Preço unitário do item	required	false
list_price	number	Preço de tabela do item	required	false
cost_price	number	Preço de custo do item	required	false
selling_price	number	Preço de venda do item	required	false
shipping_price	number	Preço do frete do item	required	false
discount	number	Valor de desconto do item	required	false
ref_item_code	string	Código de referência do item	required	false
ref_item_branch	string	Filial do item de referência	required	false
ref_item_operation	OrderRefItemOperationEnum	Operação de referência do item	required	false
conditions +	Array(OrderItemConditionType)	Condições aplicadas ao item	required	false
metadata	Record<string, string>	Metadados adicionais do item	required	false

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema