Ler todos os pedidos
GET https://.account-name.krzlabs.io/api/v1/orders
Realiza a leitura de todos os pedidos.
Request
Entenda como aplicar paginação e ordenação na sua listagem
Entenda como aplicar filtros na sua listagem
Entenda como expandir entidades relacionadas nos documentos da listagem
Response
Resposta de sucesso
200
| Field | Type | Description | optional | Searchable |
|---|---|---|---|---|
| code (unique) | string | Código do pedido. | required | true |
| external_code | string | Identificador externo do pedido. | required | true |
| invoice_number | string | Número da nota fiscal. | not required | true |
| placed_at | date | Data do pedido. | not required | false |
| store_source | Object | Fonte do pedido. requer duas keys: code: string - not required name: string - not required | not required | false |
| store_target | Object | Destino do pedido. requer duas keys: code: string - not required name: string - not required | not required | false |
| channel | Object | Canal do pedido. requer quatro keys: id: ObjectId - not required code: string - required name: string - not required image: string - not required | required | false |
| final_status_type | enum | Status do pedido. Duas possíveis opções: "CANCELED" "COMPLETED" | not required | false |
| final_status_at | date | Data do status final do pedido. | not required | false |
| elapsed_time | number | Tempo decorrido do pedido. | not required | false |
| status_code | string | Código do status do pedido. | not required | false |
| status_updated_at | date | Data do status atualizado do pedido. | not required | false |
| step_code | string | Código do status atualizado do pedido. | not required | false |
| status | Object | Status do pedido. | not required | false |
| customer | Object | Dados do cliente. | required | false |
| identifiers | Object | Identificadores do pedido. | not required | false |
| metadata | Object | Metadados do pedido. | not required | false |
| totals | Object | Total do pedido. | not required | false |
| conditions | array | Condições do pedido. | not required | false |
| workflow | object | Workflow do pedido. | required | false |
| items_count | number | Quantidade de itens no pedido. | required | false |
| sort_date | date | Data de ordenação do pedido. | not required | false |
| sla | number | Tempo de SLA do pedido. | not required | false |
| sla_overdue_date | date | Data de SLA do pedido. | not required | false |
| status_overdue_date | date | Data de status do pedido. | not required | false |
| logistic_id | ObjectId | Identificador global do logístico. | not required | false |
| last_interaction | object | Última interação do pedido. user_id: ObjectId - required user_name: string - required interacted_at: date - required | not required | false |
| order_items | array | Itens do pedido. | not required | false |
| order_trackings | array | Itens do pedido. | not required | false |
| order_payments | array | Pagamentos do pedido. | not required | false |
| order_comments | array | Comentários do pedido. | not required | false |
| order_logistics | object | Logísticas do pedido. | not required | false |
| invoices | array | Notas do pedido. | not required | false |
Exemplo em JSON
{
"page": 1,
"skip": 0,
"limit": 10,
"sort": {
"campo": "asc"
},
"pages": 5,
"total": 50,
"next": true,
"previous": "2",
"nextUrl": "https://api.exemplo.com?page=2",
"previousUrl": false,
"filters": {
"status": "ativo"
},
"data": [{
{
"code": "ORD12345",
"external_code": "EXT-001",
"invoice_number": "INV-2025-001",
"placed_at": "2025-08-13T14:30:00Z",
"store_source": {
"code": "SRC01",
"name": "Loja Origem"
},
"store_target": {
"code": "TGT01",
"name": "Loja Destino"
},
"channel": {
"_id": "64b7f2c7a2f7d8e9f1a12345",
"code": "ONLINE",
"name": "E-commerce",
"image": "https://example.com/image.png"
},
"final_status_type": "delivered",
"final_status_at": "2025-08-13T15:00:00Z",
"elapsed_time": 3600,
"status_code": "DELIVERED",
"status_updated_at": "2025-08-13T15:10:00Z",
"step_code": "STEP05",
"status": {
"_id": "64b7f2c7a2f7d8e9f1a54321",
"code": "ST01",
"name": "Finalizado",
"color": "#00FF00",
"tracking_id": "64b7f2c7a2f7d8e9f1a67890",
"tags": ["final", "entregue"]
},
"customer": {
"_id": "64b7f2c7a2f7d8e9f1a11111",
"code": "CUST001",
"name": "João Silva",
"email": "joao@example.com",
"phone": "+55 11 99999-9999",
"document": "12345678900",
"document_type": "CPF",
"address": {
"zipcode": "01000-000",
"street": "Rua Exemplo",
"city": "São Paulo",
"state": "SP",
"number": "123",
"complement": "Apto 45",
"neighborhood": "Centro",
"country": "BR",
"coordinates": [-46.6333, -23.5505],
"contact_name": "Maria Souza",
"contact_phone": "+55 11 98888-8888"
}
},
"identifiers": {},
"metadata": {},
"totals": {
"balance": 0,
"discount": 10.5,
"shipping": 20,
"subtotal": 200,
"total": 209.5,
"virtual_balance": 0,
"virtual_discount": 0,
"virtual_shipping": 0,
"virtual_subtotal": 0,
"virtual_total": 0
},
"conditions": [
{
"kind": "promo",
"code": "PROMO10",
"label": "Desconto 10%",
"caption": "Promoção especial",
"description": "Desconto aplicado por campanha",
"value": 10,
"factor": 0.1
}
],
"workflow": {
"filters": {},
"steps": [
{
"name": "Example Step",
"code": "STEP001",
"description": "This is a step",
"allocation_time": 10,
"users_groups": [
{
"source_id": "SRC123",
"name": "Group A",
"description": "Main group",
"has_full_product_access": true,
"users": [
{
"id": "64bfc2f21a7b8e001f9d1234",
"name": "John Doe",
"roles": ["admin", "editor"]
}
]
}
],
"users": [
{
"id": "64bfc2f21a7b8e001f9d5678",
"name": "Jane Smith"
}
],
"status": [
{
"_id": "64bfc2f21a7b8e001f9d9999",
"code": "ST001",
"name": "Approved",
"color": "#00FF00",
"tags": ["done", "success"],
"notify": true,
"enabled": true,
"outcome": "success"
}
],
"scopes": ["scope1", "scope2"],
"locker": false,
"editable": true
}
],
"code": "WF001",
"name": "Example Workflow",
"description": "Workflow description",
"tags": ["tag1", "tag2"],
"enabled": true,
"default": false
},
"items_count": 3,
"sort_date": "2025-08-13T14:00:00Z",
"sla": 48,
"sla_overdue_date": "2025-08-15T14:00:00Z",
"status_overdue_date": "2025-08-15T14:00:00Z",
"logistic_id": "64b7f2c7a2f7d8e9f1a22222",
"last_interaction": {
"user_id": "64b7f2c7a2f7d8e9f1a33333",
"user_name": "Carlos Almeida",
"interacted_at": "2025-08-13T15:30:00Z"
},
"order_items": [],
"order_trackings": [],
"order_payments": [],
"order_comments": [],
"order_logistics": {},
"invoices": []
}
}]
}
Resposta de erro
400
| 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 |
Copyright © 2025 kruzer | All Rights Reserved