Pedidos de Venda

Listagem de pedidos de venda com filtros específicos

GET {url_base}/orders

São permitidos apenas filtros com até 30 dias no período informado nos parâmetros from e to.

A quantidade de itens por página é de no máximo 50 no parâmetro per_page.

Query Parameters

Name	Type	Description
from*	DateString	Data de início da criação dos pedidos de venda para filtro Formato: YYYY-MM-DD
to*	DateString	Data de fim da criação dos pedidos de venda para filtro Formato: YYYY-MM-DD
page*	Int	Página que está consultando Página inicia com 1
per_page*	Int	Quantidade de itens por página limitado a no máximo 50 itens
updated	DateString	Data de última atualização dos pedidos de venda para filtro Formato: YYYY-MM-DD
ids	Array	Lista de ids (UUID único da Estoca) de pedidos que serão filtrados Repetir o parâmetro: ?ids=eaf8f1a2-f3ae-4629-beea-e951d0069962&ids=6a74efd6-8a5e-45cb-856a-771d6f35ebdf&ids...
session	String	Sessão da consulta (necessário para fazer pooling) Usaremos essa sessão para fazer o controle de pedidos que já foram marcados e remover da lista`
status	String	Filtro de status do pedido Filtros Disponíveis: invoice_pending

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1.1" como default

200: OK

{
	"status": "OK",
	"data": [
		{
			"id": "fe46dec7-549a-49c6-912f-4851b5e20feb",
			"external_id": "1234",
			"created_at": "2024-08-01 00:10:53",
			"date": "2024-07-31 00:00:00",
			"items": [
				{
					"id": "deb61f41-5d10-4b92-9a63-a577855db23c",
					"amount": 2.0,
					"product_id": "f825d5bb-6d90-4fb3-a6ee-eddfeb69c855",
					"product_name": "Produto",
					"product_sku": "SKUCODE",
					"external_id": "4321",
					"product_height": "10",
					"product_width": "4",
					"product_depth": "4",
					"product_weight": "0.09",
					"batchs": [
						{
							"batch": "3214123",
							"expiration_date": "2026-05-30 00:00:00",
							"fabrication_date": null,
							"amount": 3,
							"entries": [
								"ef14ead5-b593-49f5-9561-fe9a3335835d",
								"d41b364d-c752-40ab-b5b3-1182480795bd",
								"c953c3f2-c3fb-436c-bce2-e2abed03e562"
							],
						},
						{
							"batch": "23123123",
							"expiration_date": "2026-05-30 00:00:00",
							"fabrication_date": null,
							"amount": 1,
							"entries": ["6d0aeca4-aab0-4f51-a304-1ae8449d7447"],
						}
					]
				}
			]
		},
	],
	"page": 1,
	"per_page": 50,
	"total": 200
}

400: Bad Request

{
	"status": "Required filters are missing: start_date,end_date,page,size",
	"data": null,
	"page": null,
	"per_page": null
}

401: Unauthorized Acesso não autorizado

{
	"status": "Invalid API KEY",
	"data": null
}

Descrição das informações retornadas pela listagem dos pedidos de venda:

Nome	Descrição	Tipo	Formato
status	Status da requisição	String
page	Página consultada	String
per_page	Quantidade de itens por página consultada	String
total	Total de itens para os filtros informado	String
data	Lista de pedidos para os filtros informado	Array
data.id	ID único da Estoca para o pedido de venda	UUID
data.external_id	ID único externo de referência para o pedido de venda	String
data.created_at	Data de sincronização do pedido de venda	Timestamp	YYYY-MM-DD HH:MM:SS
data.date	Data de criação do pedido de venda	Timestamp	YYYY-MM-DD HH:MM:SS
data.items	Itens do pedido de venda	Array
data.items.id	ID único da Estoca para o item do pedido de venda	UUID
data.items.amount	Quantidade do item do pedido de venda	Decimal
data.items.product_id	ID único da Estoca para o produto do pedido de venda	UUID
data.items.product_sku	SKU do produto do pedido de venda	UUID
data.items.external_id	ID único externo de referência do produto do pedido de venda	String
data.items.product_height	Altura referente ao produto do pedido de venda	Decimal
data.items.product_width	Largura referente ao produto do pedido de venda	Decimal
data.items.product_depth	Profundidade referente ao produto do pedido de venda	Decimal
data.items.product_weight	Peso referente ao produto do pedido de venda	Decimal
data.items.batchs	Lista de lotes para o produto do pedido de venda	Array
data.items.batchs.batch	Código do lote	String
data.items.batchs.expiration_date	Data de validade do lote	Timestamp	YYYY-MM-DD HH:MM:SS
data.items.batchs.fabrication_date	Data de fabricação do lote	Timestamp	YYYY-MM-DD HH:MM:SS
data.items.batchs.amount	Quantidade de itens nesse lote/validade	Int
data.items.batchs.entries	Array de ID único da Estoca para a entrada do item do pedido	Array

Marcar Pedido como processado

PUT {url_base}/orders/{id}/processed

O campo session é obrigatório para marcar um pedido como processado.

Request Body

Name	Type	Description
session	String	Sessão da consulta Usaremos essa sessão para fazer o controle de pedidos que já foram marcados e remover da lista`

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1.1" como default

200: OK

{
	"status": "OK",
	"data": {
		"order_id": "f37b7f4d-cbb1-4c27-8eac-9619b279a66f"
	}
}

400: Bad Request

{
	"status": "Required filters are missing: session",
	"data": null
}

401: Unauthorized Acesso não autorizado

{
	"status": "Invalid API KEY",
	"data": null
}

Descrição das informações retornadas pela listagem dos pedidos de venda:

Nome	Descrição	Tipo	Formato
order_id	ID único da Estoca para o pedido de venda	UUID