Talk to an Expert
Retrieve order - Grasshopper Labs API
DocsOrdersRetrieve order
Orders

Retrieve order

Fetch a single order by ID with full details including line items, tracking, assets, and notes.

GET /api/orders/{order_id}/

Path parameters

order_id
string Required
The Grasshopper order ID. Returned by Create order or List orders.

Example

curl https://{licensee-url}/api/orders/22200041771/ \
  -H "Authorization: Bearer $TOKEN"
const res = await fetch(`https://{licensee-url}/api/orders/${orderId}/`, {
  headers: { Authorization: `Bearer ${token}` }
});
const order = await res.json();
order = requests.get(
    f'https://{licensee-url}/api/orders/{order_id}/',
    headers={'Authorization': f'Bearer {token}'}
).json()
Try it out
Response will appear here

Lookup by reference number

You can also fetch an order using your reference number by adding the query parameter ?by=ref:

GET /api/orders/{ref_order_number}/?by=ref

Errors

StatusCause
404Order ID does not exist or is not in your shipper scope
← Previous
Create order