Embarcador (LOG)Frota Própria (GO)TransportadoraTMSTrackingAPI ReferenceChangelog
Pedidos (Orders)

Obter token de retirada

Gera um token único que o cliente apresenta na loja para retirar o pedido (modalidade Pick&Go).

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.

Este endpoint retorna o token de retirada ativo de um pedido. Em resposta 200, devolve o takeout_token, o order_number e o tracking.

A requisição falha se o pedido não for do tipo TAKEOUT ou ainda não estiver pronto pra retirada (status DISPATCHED).

GET
/v1/orders/{order_id}/takeout-token

Authorization

sellerGroupKey
x-abbiamo-seller-group-key<token>

In: header

Path Parameters

order_id*string

ID do pedido enviado nos eventos de webhook

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orders/string/takeout-token"
{
  "takeout_token": "688405",
  "order_number": "teste_carlos_takeout_0",
  "tracking": "PDvLFnx"
}
{
  "message": "Unauthorized"
}
"{\n\t\"message\": \"Invoice not found\",\n\t\"code\": \"INVOICE_NOT_FOUND\",\n\t\"status\": \"NOT_FOUND\",\n}"

Marcar pedido como retirado POST

Atualiza o pedido para o status `SUCCESSFUL.WITHDRAWN`, indicando que o cliente retirou o pacote presencialmente.

Tratar pedido manualmente POST

Atualiza o status do pedido para `MANUAL_HANDLE`. Útil quando a entrega precisa ser finalizada por algum motivo fora do fluxo padrão.