Verificações do pedido (coleta e retorno)
Informa as verificações do pedido — coleta, entrega e retorno — cobrindo os dois modelos de pincode, e retorna o código quando ele deve ser exibido ao operador.
No guia
Os dois modelos de pincode de coleta: visão geral · motorista para filial (PIN reverso) · filial para motorista.
Header obrigatório. Toda chamada exige o header x-abbiamo-seller-group-key.
Preencha-o no canto superior direito desta página ou veja como obter a sua chave.
Rate limit: 300 requisições por minuto por chave. Acima disso a API retorna HTTP 429.
Use este endpoint para a operação da loja saber, a partir do order_id, quais verificações se aplicam ao pedido. O campo pickup.pincode_owner diz qual modelo está em uso:
pincode_owner | Modelo | O que a operação faz |
|---|---|---|
abbiamo | PIN reverso (motorista → filial) | O motorista informa o PIN de 4 dígitos no balcão e o operador o valida via Confirmar pincode de coleta. O valor do PIN não é retornado aqui. |
carrier | Nativo da transportadora (filial → motorista — Uber, Bee...) | O código vem em pickup.pincode: o operador o exibe/informa ao motorista, que o digita no aplicativo da transportadora (a validação acontece do lado dela). Pode ser null até a transportadora informá-lo. |
- Entrega (
delivery) — quandoverification_required: true, há pincode na entrega ao destinatário. Apenas o flag é retornado: o código pertence ao destinatário (é ele quem o informa ao motorista, como prova de entrega) — expô-lo à operação da loja quebraria essa prova. - Retorno (
return) — quandoverification_required: true, overification_codeé retornado: o operador o informa ao motorista na devolução do pacote, e o motorista o digita no aplicativo da transportadora. pickup.pendingindica que a entrega ainda não foi coletada.
No PIN reverso (pincode_owner = abbiamo) o valor do PIN nunca é retornado. Ele chega pelo motorista e é validado no endpoint de confirmação — retorná-lo quebraria a segurança do modelo em que a Abbiamo é a fonte da verdade do PIN.
Authorization
sellerGroupKey In: header
Path Parameters
Identificador único do pedido (order_id retornado na criação)
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/seller-group/v1/orders/string/verification"{
"order_id": "98e187a1-eaf9-4a88-b522-70464e1de20d",
"delivery_id": "851dc274-e090-4881-8f3c-5b660cecf059",
"pickup": {
"pincode_required": true,
"pincode_owner": "abbiamo",
"pincode": null,
"pending": true
},
"delivery": {
"verification_required": false
},
"return": {
"verification_required": false,
"verification_code": null
}
}{
"message": "Unauthorized"
}{
"code": "INVOICE_NOT_FOUND_OR_NOT_IN_SELLER_GROUP",
"message": "Invoice not found or not belongs to seller group",
"status": 404,
"params": {}
}Cancelar pedido PUT
Cancela um pedido por completo — agendamento, entrega e o próprio pedido. Se a entrega não puder ser cancelada, o pedido não é cancelado e a API retorna um erro claro.
Confirmar pincode de coleta POST
Valida o PIN reverso digitado pelo operador, solicita à transportadora a liberação do motorista e transita a entrega para COLLECTED.