Pular para o conteúdo

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.


  • id — identificador interno Abbiamo
  • number — número do pedido
  • external_id — ID do embarcador
  • tracking — código de rastreio
  • invoice_number — número da NF
  • access_keys — chave de acesso da NF
  • Dados de emissão
  • 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)
RelaçãoDescrição
Filial (seller)A qual filial o pedido pertence
Cliente (customer)Destinatário e dados de contato
EndereçosOrigem (source_address, endereço da filial associada) e destino (destination_address)
Volumes e itensvolumes e itens associados
Envios (deliveries)Um pedido pode ter um ou mais envios (ex.: reenvio)
  • 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

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.