Get order

GET

/oort/orders/v1/:order_id_or_short_id

GET

/oort/orders/v1/:order_id_or_short_id

1 curl https://localhost:8000/oort/orders/v1/order_id_or_short_id \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "order": {
3     "schema_version": 1,
4     "_id": "string",
5     "short_id": "string",
6     "order_created_by_type": "chrt",
7     "order_dispatch_type": "dtc",
8     "transport_type": "ground_only",
9     "created_by_org_id": "string",
10     "created_by_user_id": "string",
11     "draft_started_at": "2024-01-15T09:30:00Z",
12     "task_group_ids": [
13       "string"
14     ],
15     "shipper_org_id": "string",
16     "shipper_user_id": "string",
17     "off_chrt_shipper_org_info_id": "string",
18     "order_level_expenses_ids": [
19       "string"
20     ],
21     "order_level_receivables_line_items": [
22       {
23         "schema_version": 1,
24         "item": "base_rate",
25         "quantity": 1.1,
26         "rate": 1.1,
27         "comment": "string",
28         "created_at": "2024-01-15T09:30:00Z",
29         "uuid_str": "string"
30       }
31     ],
32     "status": "not_started",
33     "order_cancelled": false
34   }
35 }

Retrieves an order by its full ID or short ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

order_id_or_short_idstringRequired

Response

Successful Response

orderobject

Authentication

Path Parameters

Response

Errors