Pedidos de Envio

Consulta de um pedido de envio específico

GET {url_base}/inbounds/{id}

Status disponíveis para os pedidos de envio:

sent, received, checking, checkedin, storing e storaged

Descrição dos Status

Status	Descrição
sent	Pedido de envio foi enviado pelo fornecedor
received	Pedido de envio foi recebido no armazém
checking	Pedido de envio está sendo verificado
checkedin	Verificação do pedido de envio foi concluída
storing	Pedido de envio está sendo armazenado
storaged	Pedido de envio foi completamente armazenado

Path Parameters

Name	Type	Description
id*	String	ID único da Estoca para o pedido de envio

Headers

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

200: OK Pedido de envio encontrado com sucesso

{
    "status": "Order found",
    "data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "human_id": "0B7.CB9",
        "arrival_date": "2022-01-01 00:00:00",
        "status": "storaged",
        "received_at": "2022-01-01 00:00:00",
        "checkin_started_at": "2022-01-01 00:00:00",
        "checkin_finished_at": "2022-01-01 00:00:00",
        "storage_started_at": "2022-01-01 00:00:00",
        "storage_finished_at": "2022-01-01 00:00:00",
    }
}

401: Unauthorized Acesso não autorizado

Criação de novo pedido de envio

POST {url_base}/inbounds

Headers

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

Request Body

Name	Type	Description
nfe.number*	String	Número da nota fiscal
nfe.access_key*	String	Chave de acesso da nota fiscal
nfe.status	String	Status da nota fiscal
nfe.issue_date	String	Data de emissão da nota fiscal
nfe.xml	String	Conteúdo literal do XML da nota fiscal
nfe.value	String	Valor total da nota fiscal Formato: 0.00
nfe.serie*	String	Série da nota fiscal
nfe*	Object	Objeto da nota fiscal de entrada
products.price*	String	Preço unitário do produto, de acordo com a nota fiscal Formato: 0.00
products.quantity*	String	Quantidade do produto, de acordo com a nota fiscal
products.sku*	String	SKU do produto, de acordo com a nota fiscal e catálogo da plataforma
products*	Array	Lista de objetos dos produtos
external_id	String	ID único externo de referência para o pedido de envio
warehouse_id*	String	ID único da Estoca para o armazém
arrival_date*	DateString	Data de chegada do pedido de envio Formato: YYYY-MM-DD HH:mm:ss
nfe.link	String	Link público sem autenticação para download do XML da nota fiscal

200: OK Pedido de envio criado com sucesso

{
    "status": "Inbound Created: 00000000-0000-0000-0000-000000000000"
}

401: Unauthorized Acesso não autorizado

Exclusão de um pedido de envio específico

DELETE {url_base}/inbounds/{id}

Não é permitido excluir pedidos de envio que já tenham um ou mais entradas realizadas dentro do inventário.

Path Parameters

Name	Type	Description
id*	String	ID único da Estoca para o pedido de envio

Headers

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

Request Body

Name	Type	Description
warehouse_id*	String	ID único da Estoca para o armazém
external_id*	String	ID único externo de referência para o pedido de envio
cancelled*	String	Flag (Boolean) indicadora do cancelamento em formato de texto Enviar "true" como default

200: OK Pedido de envio excluído com sucesso

{
    "status": "deleted",
    "id": "00000000-0000-0000-0000-000000000000"
}

401: Unauthorized Acesso não autorizado