Abbiamo DocsPedido (Order / Invoice)
Entidade central do sistema: solicitação de entrega vinculada a uma filial, com nota fiscal, status, envios e integrações
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
Identificação
id— identificador interno Abbiamonumber— número do pedidoexternal_id— ID do embarcadortracking— código de rastreio
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
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
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.
Tipo
type— Entrega (DELIVERY), Retirada em loja (TAKEOUT) ou Reversa (RETURN)
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
Existem duas formas de informar uma janela de entrega, que não se combinam entre si — use uma ou outra conforme o caso:
| Campo | Tipo | Descrição |
|---|---|---|
delivery_window_start | string (ISO 8601) | Início da janela de entrega — data e hora completas, para um dia específico |
delivery_window_end | string (ISO 8601) | Fim da janela de entrega — data e hora completas |
delivery_start_window_hour | string (HH:mm) | Início da janela de entrega — apenas o horário, sem data associada (ex.: sempre entre 9h e 12h, em qualquer dia) |
delivery_end_window_hour | string (HH:mm) | Fim da janela de entrega — apenas o horário. Precisa ser depois de delivery_start_window_hour |
delivery_service_time | integer (minutos) | Tempo de permanência estimado no destino durante a entrega |
Todos os 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.
Fuso horário — timestamp vs. horário
delivery_window_start/delivery_window_end: use sempre strings ISO 8601 com fuso horário explícito (ex.: 2024-12-15T09:00:00-03:00) para evitar ambiguidade.
delivery_start_window_hour/delivery_end_window_hour: informe o horário no fuso da filial de origem do pedido. A Abbiamo converte e armazena o valor em UTC — ao consultar o pedido depois pela API, o horário retornado vem em UTC, não no fuso da filial.
Tipo de moradia do destinatário
| Campo | Tipo | Descrição |
|---|---|---|
residence_type | string (commercial ou residential) | Tipo do endereço de entrega — comercial ou residencial |
Campo opcional. Não afeta cotação, seleção de transportadora ou despacho — é armazenado no pedido e repassado a integrações e transportadoras que usam essa informação a jusante (ex.: para orientar o entregador sobre o tipo de local).
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
- 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.
Pedido vs. Invoice
Na Abbiamo, são a mesma coisa
Na Abbiamo, pedido e invoice representam a mesma entidade. Um pedido carrega as informações de uma nota fiscal (número, chave de acesso, dados de emissão), mas não são entidades separadas — é tudo o mesmo registro.