Pedido

1. O que é um pedido?

Pedido (Pré-envio) pode ser entendido como um envio que vai acontecer fisicamente mas ainda está em seu estágio digital.
Ele geralmente espelha o pedido que ira ser faturado.
Esta etapa geralmente compreende as fases do pedido que atecedem o envio, como por exemplo Pedido confirmado, Pedido Faturado, Picking, etc...

2. Inserir um pedido

NOTE

Utiliza-se para inserir um pedido o endpoint:
POST /v2/pre-envio
Este método retorna um rastreadorTms que é o identificador único na BOXLINK

TIP

Existem três identificadores que podem ser usados na API para identificar pedido e envios:
rastreadorTms fornecido pelo retorno do método de inserir pedido
identificadorPedido infomado na chamada do método de inserir pedido
chaveNotaFiscal pode ser infomado na chamada do método de inserir pedido ou no atualizar pedido

3. Atualizar um pedido

NOTE

É sempre possivela atualizar os dados do pedido, mas para isso é necesario informar o rastreadorTms:
PUT /v2/pre-envio/atualizar/{rastreadorTms}

3. Consultar um pedido

NOTE

Para consultar um pedido, deve-se utilizar o identificadorPedido:
GET /v2/pre-envio/consultar/{identificadorPedido}

*caso não tenha salvo o rastradorTms pode-se fazer a consulta por este método

4. Cancelar um pedido

NOTE

Para concelar um pedido, deve-se utilizar o rastreadorTms e também infomar o motivo no payload:
PUT /v2/pre-envio/cancelar-com-rastreador

Fluxo do Pedido

Pedido#

1. O que é um pedido?#

2. Inserir um pedido#

3. Atualizar um pedido#

3. Consultar um pedido#

4. Cancelar um pedido#

Pedido

1. O que é um pedido?

2. Inserir um pedido

3. Atualizar um pedido

3. Consultar um pedido

4. Cancelar um pedido