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

Eventos do pedido por order_id

Lista os eventos de status de um pedido a partir do `order_id`.

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 os detalhes do pedido (a maior parte deles é o que você enviou na criação) e os eventos que aconteceram ao longo do ciclo de vida. Use pra reconstruir a timeline do pedido — equivale a um histórico do webhook ORDER_STATUS_CHANGE.

GET
/seller-group/v1/orders/{order_id}/events

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/seller-group/v1/orders/string/events"
{
  "id": "3d7672a6-0790-4151-9568-5d950ceea3f5",
  "order_number": "1234",
  "external_id": "xpto9876",
  "tracking": "EKC3TI467Q4B",
  "status_name": "CREATED",
  "sub_status": null,
  "invoice_number": null,
  "access_key": null,
  "invoice_created_timestamp": "2023-01-09T13:52:48.480Z",
  "amount": 1000,
  "type": "DELIVERY",
  "created_at": "2023-01-09T14:52:48.480Z",
  "last_delivery_type": "TRANSPORTADORA-B",
  "last_delivery_method_name": "MOTO",
  "last_delivery_shipping_method_type": "EXPRESS",
  "deliveries": [
    {
      "id": "1fa4d871-2ad6-4914-b16f-4814b75c08c7",
      "external_id": null,
      "support_id": null,
      "type": "TRANSPORTADORA-B",
      "method_name": "MOTO",
      "shipping_method_type": "EXPRESS",
      "status_name": "ORDER_FAILED",
      "sub_status": "CARRIER_ERROR",
      "driver_name": null,
      "driver_document": null,
      "driver_phone": null,
      "driver_vehicle_type": null,
      "driver_vehicle_color": null,
      "driver_vehicle_plate": null,
      "driver_image_url": null,
      "expected_delivery_date": "2023-01-10T02:59:00.000Z",
      "expected_delivery_price": 1240,
      "created_at": "2023-01-09T14:53:01.200Z",
      "collect_eta": "2023-01-09T16:12:19.000Z",
      "collect_verification_code": "9999",
      "delivery_eta": "2023-01-09T17:28:54.000Z",
      "delivery_verification_code": "9999",
      "return_eta": "2023-01-09T17:28:54.000Z",
      "return_verification_code": "9999",
      "manual_delivery": false,
      "scheduled_at": null,
      "events": [
        {
          "id": "bc5613f6-c715-4cea-a588-396303050144",
          "status": "PENDING",
          "sub_status": "WAITING_FOR_CARRIER",
          "failure_code": null,
          "failure_message": null,
          "failure_driver_message": null,
          "observation": null,
          "driver_name": null,
          "driver_document": null,
          "driver_phone": null,
          "driver_vehicle_type": null,
          "driver_vehicle_color": null,
          "driver_vehicle_plate": null,
          "driver_image_url": null,
          "latitude": null,
          "longitude": null,
          "manual_event": false,
          "event_at": "2023-01-09T14:53:01.200Z",
          "created_at": "2023-01-09T14:53:01.293Z"
        },
        {
          "id": "a54caeaa-7896-48a3-b658-ce096003b2ff",
          "status": "ORDER_FAILED",
          "sub_status": "CARRIER_ERROR",
          "failure_code": null,
          "failure_message": null,
          "failure_driver_message": null,
          "observation": "Server error",
          "driver_name": null,
          "driver_document": null,
          "driver_phone": null,
          "driver_vehicle_type": null,
          "driver_vehicle_color": null,
          "driver_vehicle_plate": null,
          "driver_image_url": null,
          "latitude": null,
          "longitude": null,
          "manual_event": false,
          "event_at": "2023-01-09T14:53:03.740Z",
          "created_at": "2023-01-09T14:53:03.760Z"
        }
      ]
    },
    {
      "id": "a0b60e4c-1f01-4063-8cbd-e2f2cb26ca46",
      "external_id": null,
      "support_id": null,
      "type": "TRANSPORTADORA-A",
      "method_name": "CARRO",
      "shipping_method_type": "SAME_DAY",
      "status_name": "SUCCESSFUL",
      "sub_status": "DELIVERED",
      "driver_name": "John Day",
      "driver_document": "01234567899",
      "driver_phone": "21991112233",
      "driver_vehicle_type": null,
      "driver_vehicle_color": null,
      "driver_vehicle_plate": null,
      "driver_image_url": null,
      "expected_delivery_date": "2023-01-12T02:59:00.000Z",
      "expected_delivery_price": 910,
      "created_at": "2023-01-11T09:38:41.200Z",
      "collect_eta": "2023-01-11T10:08:26.580Z",
      "delivery_eta": "2023-01-11T18:31:53.550Z",
      "manual_delivery": false,
      "scheduled_at": null,
      "events": [
        {
          "id": "7abb720b-03c5-4307-b67c-faec86904f47",
          "status": "PENDING",
          "sub_status": "WAITING_FOR_CARRIER",
          "failure_code": null,
          "failure_message": null,
          "failure_driver_message": null,
          "observation": null,
          "driver_name": null,
          "driver_document": null,
          "driver_phone": null,
          "driver_vehicle_type": null,
          "driver_vehicle_color": null,
          "driver_vehicle_plate": null,
          "driver_image_url": null,
          "latitude": null,
          "longitude": null,
          "manual_event": false,
          "event_at": "2023-01-11T09:38:41.200Z",
          "created_at": "2023-01-11T09:38:41.279Z"
        },
        {
          "id": "cfcaf389-f4f7-44c7-9a1b-b9b08df83355",
          "status": "DISPATCHED",
          "sub_status": "CARRIER_CONFIRMED",
          "failure_code": null,
          "failure_message": null,
          "failure_driver_message": null,
          "observation": null,
          "driver_name": null,
          "driver_document": null,
          "driver_phone": null,
          "driver_vehicle_type": null,
          "driver_vehicle_color": null,
          "driver_vehicle_plate": null,
          "driver_image_url": null,
          "latitude": null,
          "longitude": null,
          "manual_event": false,
          "event_at": "2023-01-11T09:39:05.900Z",
          "created_at": "2023-01-11T09:39:05.900Z"
        },
        {
          "id": "61291076-bc02-4d08-94fb-4f884bf32cc7",
          "status": "START_DELIVERY",
          "sub_status": null,
          "failure_code": null,
          "failure_message": null,
          "failure_driver_message": null,
          "observation": null,
          "driver_name": "John Day",
          "driver_document": "01234567899",
          "driver_phone": "21991112233",
          "driver_vehicle_type": null,
          "driver_vehicle_color": null,
          "driver_vehicle_plate": null,
          "driver_image_url": null,
          "latitude": null,
          "longitude": null,
          "manual_event": false,
          "event_at": "2023-01-11T10:08:26.580Z",
          "created_at": "2023-01-11T10:08:26.800Z"
        },
        {
          "id": "ee616ebd-0932-4904-84be-988b66947b66",
          "status": "SUCCESSFUL",
          "sub_status": "DELIVERED",
          "failure_code": null,
          "failure_message": null,
          "failure_driver_message": null,
          "observation": null,
          "driver_name": "John Day",
          "driver_document": "01234567899",
          "driver_phone": "21991112233",
          "driver_vehicle_type": null,
          "driver_vehicle_color": null,
          "driver_vehicle_plate": null,
          "driver_image_url": null,
          "latitude": null,
          "longitude": null,
          "manual_event": false,
          "event_at": "2023-01-11T18:31:53.550Z",
          "created_at": "2023-01-11T18:31:53.692Z"
        }
      ]
    }
  ]
}
{
  "message": "Unauthorized"
}
"{\n  \"message\": \"Tracking for order 86a4e958-c249-4ebe-8fe4-3369a9ece70b not found\",\n  \"code\": \"ORDER_NOT_FOUND\",\n  \"status\": \"NOT_FOUND\",\n}"

Consultar pedido por chave de acesso GET

Retorna os dados de um pedido a partir da chave de acesso da nota fiscal.

Eventos do pedido por order_number GET

Próxima