Criar logística

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

Realiza a criação de uma logística.

---

Path Params

id string required

ID do pedido.

---

Body Params

Field	Type	Description	Optional	Searchable
_id	string	Identificador da logística do pedido	required	false
order_id	string	ID do pedido	required	false
order_code	string	Código do pedido	required	false
status	LogisticsStatusEnum	Status da logística	required	false
delivery_type +	OrderLogisticsDeliveryType	Tipo de entrega	required	false
delivery_method +	OrderLogisticsDeliveryMethod	Método de entrega	required	false
external_code	string	Código externo da logística	required	false
carrier +	OrderLogisticsCarrier	Transportadora	not required	false
strategy +	OrderLogisticsStrategy	Estratégia de entrega	not required	false
pickup_address +	AddressType	Endereço de coleta	required	false
delivery_address +	AddressType	Endereço de entrega	required	false
metadata	Record<string, string>	Metadados adicionais	required	false
packing +	Array(OrderLogisticsPacking)	Lista de volumes da logística	required	false
delivery_forecast_date	Date	Data prevista para entrega	required	false
sla	number	Prazo de entrega (SLA)	required	false

Enum Status

Value	Label
PENDING	'PENDING'
CANCELED	'CANCELED'
CONFIRMED	'CONFIRMED'

Exemplo em JSON

{
  "_id": "64c9f3e2b12a4f0012345678",
  "order_id": "64c9f3e2b12a4f0098765432",
  "order_code": "ORD123456",
  "status": "PENDING",
  "delivery_type": {
    "_id": "64c9f3e2b12a4f0011111111",
    "code": "EXPRESS",
    "name": "Entrega Expressa",
    "color": "#FF0000"
  },
  "delivery_method": {
    "_id": "64c9f3e2b12a4f0022222222",
    "code": "MOTOBOY",
    "name": "Motoboy",
    "color": "#0000FF"
  },
  "external_code": "EXT987654",
  "carrier": {
    "_id": "64c9f3e2b12a4f0033333333",
    "code": "CORREIOS",
    "name": "Correios",
    "image": "https://example.com/image.png"
  },
  "strategy": {
    "_id": "64c9f3e2b12a4f0044444444",
    "code": "DEFAULT",
    "name": "Padrão"
  },
  "pickup_address": {
    "zipcode": "01001-000",
    "street": "Praça da Sé",
    "city": "São Paulo",
    "state": "SP",
    "number": "100",
    "country": "Brasil",
    "complement": "Ao lado da catedral",
    "neighborhood": "Sé",
    "coordinates": [-23.55052, -46.633308],
    "contact_name": "João Silva",
    "contact_phone": "+55 11 99999-9999"
  },
  "delivery_address": {
    "zipcode": "20040-020",
    "street": "Rua da Assembleia",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "number": "200",
    "country": "Brasil",
    "complement": "Sala 101",
    "neighborhood": "Centro",
    "coordinates": [-22.9035, -43.1747],
    "contact_name": "Maria Souza",
    "contact_phone": "+55 21 98888-8888"
  },
  "metadata": {
    "observacao": "Entregar antes das 18h"
  },
  "packing": [
    {
      "label": "Caixa 1",
      "code": "PKG001",
      "height": 30,
      "width": 20,
      "depth": 15,
      "max_weight": 10,
      "cubic_weight": 5,
      "cubic_size": 9000,
      "real_weight": 8,
      "items": [
        {
          "code": "ITM001",
          "name": "Produto A",
          "price": 50,
          "quantity": 2
        }
      ]
    }
  ],
  "delivery_forecast_date": "2025-08-15T12:00:00Z",
  "sla": 48
}

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
_id	string	Identificador da logística do pedido	required	false
order_id	string	ID do pedido	required	false
order_code	string	Código do pedido	required	false
status	LogisticsStatusEnum	Status da logística	required	false
delivery_type +	OrderLogisticsDeliveryType	Tipo de entrega	required	false
delivery_method +	OrderLogisticsDeliveryMethod	Método de entrega	required	false
external_code	string	Código externo da logística	required	false
carrier +	OrderLogisticsCarrier	Transportadora	not required	false
strategy +	OrderLogisticsStrategy	Estratégia de entrega	not required	false
pickup_address +	AddressType	Endereço de coleta	required	false
delivery_address +	AddressType	Endereço de entrega	required	false
metadata	Record<string, string>	Metadados adicionais	required	false
packing +	Array(OrderLogisticsPacking)	Lista de volumes da logística	required	false
delivery_forecast_date	Date	Data prevista para entrega	required	false
sla	number	Prazo de entrega (SLA)	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