Pedido (Order / Invoice)
Pedido é a entidade central que representa uma solicitação de entrega (ou coleta/retorno) vinculada a um cliente e a uma filial. No sistema, a mesma entidade é chamada de order na API e, em parte do contexto de negócio, de invoice quando se fala da nota fiscal ou do documento do pedido.
O que compõe um pedido
Seção intitulada “O que compõe um pedido”Identificação
Seção intitulada “Identificação”id— identificador interno Abbiamonumber— número do pedidoexternal_id— ID do embarcadortracking— código de rastreio
Nota fiscal / Invoice
Seção intitulada “Nota fiscal / Invoice”invoice_number— número da NFaccess_keys— chave de acesso da NFcontent_declaration— dados da DC-e quando o pedido foi criado com declaração de conteúdo informada pelo embarcador (key,serie,number)- Dados de emissão
Valores
Seção intitulada “Valores”amount— valor total do pedido- Preço e prazo prometido ao cliente — valor do frete e data de entrega que foram prometidos ao cliente final (ex.: no checkout ou na criação do pedido). Podem vir da cotação de frete ou da solicitação de coleta.
status/sub_status— refletem o estado atual do pedido (ex.: criado, com solicitação de coleta feita, em rota, entregue). Para a lista completa de códigos e traduções, veja Status de pedido.
type— Entrega (DELIVERY), Retirada em loja (TAKEOUT) ou Reversa (RETURN)
Relacionamentos
Seção intitulada “Relacionamentos”| Relação | Descrição |
|---|---|
Filial (seller) | A qual filial o pedido pertence |
Cliente (customer) | Destinatário e dados de contato |
| Endereços | Origem (source_address, endereço da filial associada) e destino (destination_address) |
| Volumes e itens | volumes e itens associados |
Envios (deliveries) | Um pedido pode ter um ou mais envios (ex.: reenvio) |
Janela de entrega e tempo de serviço
Seção intitulada “Janela de entrega e tempo de serviço”| Campo | Tipo | Descrição |
|---|---|---|
delivery_window_start | string (ISO 8601) | Início da janela de entrega acordada com o destinatário |
delivery_window_end | string (ISO 8601) | Fim da janela de entrega |
delivery_service_time | integer (minutos) | Tempo de permanência estimado no destino durante a entrega |
Os três campos são opcionais e independentes entre si. Quando presentes, podem ser usados por automações de envio para agendar a solicitação de coleta próxima ao início da janela — evitando que o pedido seja coletado e despachado muito antes da janela abrir.
Outros dados
Seção intitulada “Outros dados”- Entrega: dados da última entrega — transportadora, motorista, data de entrega, janela de entrega etc.
- Marcadores:
invoice_tags— tags/labels associadas ao pedido - Datas: criação, atualização de status, data prevista de entrega, data de processamento pelo embarcador
Como um pedido é criado
Seção intitulada “Como um pedido é criado”- Pelo dashboard — formulário, upload de CSV ou XLSX na página de Pedidos. Veja Criação de Pedido.
- Via API pública — endpoint Create order V2
- Via integração de pedido — VTEX e outras integrações conectadas
Após a criação, a solicitação de coleta é feita para uma integração de transportadora — manualmente pelo operador ou via automação de envio —, que gera um ou mais envios.