Fetch Order

Retrieve the details of an existing order, including all parcels and their current status, tracking links, and delivery information.

Environments: Production https://api.integration.instabee.com · Sandbox https://sandbox-api.integration.instabee.com (same paths; use sandbox credentials for the sandbox host).

Fetch Order

Production: GET https://api.integration.instabee.com/orders/{orderId}
Sandbox: GET https://sandbox-api.integration.instabee.com/orders/{orderId}

Headers:

1Authorization: Bearer {token}
1Authorization: Bearer {token}

Path Parameters

Param	Type	Required	Description	Constraints
orderId	string	required	The unique order ID	Minimum 1 character

1curl -X GET "https://api.integration.instabee.com/orders/ORDER-12345" \
2  -H "Authorization: Bearer {token}"
1curl -X GET "https://api.integration.instabee.com/orders/ORDER-12345" \
2  -H "Authorization: Bearer {token}"

1curl -X GET "https://sandbox-api.integration.instabee.com/orders/ORDER-12345" \
2  -H "Authorization: Bearer {token}"
1curl -X GET "https://sandbox-api.integration.instabee.com/orders/ORDER-12345" \
2  -H "Authorization: Bearer {token}"

Response Parameters

Param	Type	Description
orderId	string	The unique order identifier
parcels	array	List of parcels associated with this order

parcels

Param	Type	Description
orderId	string	The order ID this parcel belongs to
parcelId	string	The unique parcel identifier
state	string	Current state of the parcel
product	string	Product type: `LOCKER_ALLOCATION`, `LOCKER_AREA`, `LOCKER_CAPACITY_SURPLUS`, `LOCKER_EXPRESS`, `LOCKER_RETURN`, `LOCKER_TO_LOCKER`, `HOME_DELIVERY`
brand	string	Brand: `BUDBEE`, `INSTABOX`, `PORTERBUDDY`
countryCode	string	Country code: `BE`, `DE`, `DK`, `FI`, `NL`, `NO`, `PL`, `SE`
links	object	Tracking and label URLs
attributes	object	Additional parcel attributes
recipient	object	Recipient address details
sender	object	Sender address details
deliveryOption	object	Selected delivery option details

parcels.links

Param	Type	Description
label	string (URI)	URL to the shipping label
tracking	string (URI)	General tracking URL. Returned for all products except `LOCKER_TO_LOCKER`
recipientTracking	string (URI)	Tracking URL for the recipient. `LOCKER_TO_LOCKER` only
senderTracking	string (URI)	Tracking URL for the sender. `LOCKER_TO_LOCKER` only

The links object comes in two variants depending on the product:

Product	Tracking links in `links`
`LOCKER_TO_LOCKER` (Consumer to Consumer)	`recipientTracking` and `senderTracking`
All other products	`tracking`

Create order, Post Purchase, and Post Packing always return the preliminary tracking link. For LOCKER_TO_LOCKER, that link is replaced by recipientTracking and senderTracking here once they are ready — which is after the full order has been sent with parcelPackingConfirmed: true. Both response variants are shown below, and the same rule applies to Fetch Parcel. See Get Tracking.

label URL parameters

The label URL supports optional query parameters to customize the output:

Param	Type	Default	Options	Description
fileFormat	string	`pdf`	`png`, `zpl`, `pdf`	Output file format
encoding	string		`base64`	Return label as base64-encoded string
template	string	`a6`	`a6`, `a7`	Label paper size
dpi	integer	`96`		Resolution in dots per inch
debug	boolean	`false`	`true`, `false`	Enable debug mode

parcels.attributes

Param	Type	Description
labelCode	string	The label code for the parcel

parcels.deliveryOption

Param	Type	Description
sortCode	string	Sorting code for the delivery option
etaInterval	object	Estimated delivery time interval

parcels.deliveryOption.etaInterval

Param	Type	Description
from	string (date-time)	Start of ETA interval (ISO-8601)
to	string (date-time)	End of ETA interval (ISO-8601)

Response Example — Standard Order

All products except LOCKER_TO_LOCKER. The links object carries a single tracking link.

1{
2  "orderId": "ORDER-12345",
3  "parcels": [
4    {
5      "orderId": "ORDER-12345",
6      "parcelId": "SHOP000000123456",
7      "state": "CREATED",
8      "product": "LOCKER_EXPRESS",
9      "brand": "INSTABOX",
10      "countryCode": "SE",
11      "links": {
12        "label": "https://api.integration.instabee.com/orders/ORDER-12345/labels",
13        "tracking": "https://track.instabee.com/SHOP000000123456"
14      },
15      "attributes": {
16        "labelCode": "IN123"
17      },
18      "deliveryOption": {
19        "sortCode": "IN123",
20        "etaInterval": {
21          "from": "2025-06-29T08:00:00.000Z",
22          "to": "2025-06-29T16:00:00.000Z"
23        }
24      }
25    }
26  ]
27}
1{
2  "orderId": "ORDER-12345",
3  "parcels": [
4    {
5      "orderId": "ORDER-12345",
6      "parcelId": "SHOP000000123456",
7      "state": "CREATED",
8      "product": "LOCKER_EXPRESS",
9      "brand": "INSTABOX",
10      "countryCode": "SE",
11      "links": {
12        "label": "https://api.integration.instabee.com/orders/ORDER-12345/labels",
13        "tracking": "https://track.instabee.com/SHOP000000123456"
14      },
15      "attributes": {
16        "labelCode": "IN123"
17      },
18      "deliveryOption": {
19        "sortCode": "IN123",
20        "etaInterval": {
21          "from": "2025-06-29T08:00:00.000Z",
22          "to": "2025-06-29T16:00:00.000Z"
23        }
24      }
25    }
26  ]
27}

Response Example — Locker to Locker Order

Consumer-to-consumer orders. tracking is replaced by one link for the recipient and one for the sender.

1{
2  "orderId": "ORDER-C2C-2025-0001",
3  "parcels": [
4    {
5      "orderId": "ORDER-C2C-2025-0001",
6      "parcelId": "C2C000000123456",
7      "state": "FINALIZED",
8      "product": "LOCKER_TO_LOCKER",
9      "brand": "INSTABOX",
10      "countryCode": "SE",
11      "links": {
12        "recipientTracking": "https://track.instabee.com/recipient/C2C000000123456",
13        "senderTracking": "https://track.instabee.com/sender/C2C000000123456"
14      },
15      "deliveryOption": {
16        "sortCode": "IN456wOx9dJ"
17      }
18    }
19  ]
20}
1{
2  "orderId": "ORDER-C2C-2025-0001",
3  "parcels": [
4    {
5      "orderId": "ORDER-C2C-2025-0001",
6      "parcelId": "C2C000000123456",
7      "state": "FINALIZED",
8      "product": "LOCKER_TO_LOCKER",
9      "brand": "INSTABOX",
10      "countryCode": "SE",
11      "links": {
12        "recipientTracking": "https://track.instabee.com/recipient/C2C000000123456",
13        "senderTracking": "https://track.instabee.com/sender/C2C000000123456"
14      },
15      "deliveryOption": {
16        "sortCode": "IN456wOx9dJ"
17      }
18    }
19  ]
20}

A parcel that is not in a trackable state — a cancelled parcel, or one where the links are not ready yet — has an empty links object. See Fetch Tracking Links for the full Consumer to Consumer flow.

Fetch Parcel

Retrieve the details of a specific parcel by parcel ID.

Production: GET https://api.integration.instabee.com/orders?parcelId={parcelId}
Sandbox: GET https://sandbox-api.integration.instabee.com/orders?parcelId={parcelId}

Headers:

1Authorization: Bearer {token}
1Authorization: Bearer {token}

Query Parameters

Param	Type	Required	Description	Constraints
parcelId	string	required	The unique parcel ID	Minimum 1 character

1curl -X GET "https://api.integration.instabee.com/orders?parcelId=SHOP000000123456" \
2  -H "Authorization: Bearer {token}"
1curl -X GET "https://api.integration.instabee.com/orders?parcelId=SHOP000000123456" \
2  -H "Authorization: Bearer {token}"

1curl -X GET "https://sandbox-api.integration.instabee.com/orders?parcelId=SHOP000000123456" \
2  -H "Authorization: Bearer {token}"
1curl -X GET "https://sandbox-api.integration.instabee.com/orders?parcelId=SHOP000000123456" \
2  -H "Authorization: Bearer {token}"

1{
2  "orderId": "ORDER-12345",
3  "parcelId": "SHOP000000123456",
4  "state": "CREATED",
5  "product": "LOCKER_EXPRESS",
6  "brand": "INSTABOX",
7  "countryCode": "SE",
8  "links": {
9    "label": "https://api.integration.instabee.com/orders/ORDER-12345/labels",
10    "tracking": "https://track.instabee.com/SHOP000000123456"
11  },
12  "attributes": {
13    "labelCode": "IN123"
14  },
15  "recipient": {
16    "name": "John Doe",
17    "email": "john@example.com",
18    "phone": "0701234567",
19    "street": "Hälsingegatan 40",
20    "postalCode": "11353",
21    "city": "Stockholm",
22    "countryCode": "SE"
23  },
24  "deliveryOption": {
25    "sortCode": "IN123",
26    "etaInterval": {
27      "from": "2025-06-29T08:00:00.000Z",
28      "to": "2025-06-29T16:00:00.000Z"
29    }
30  }
31}
1{
2  "orderId": "ORDER-12345",
3  "parcelId": "SHOP000000123456",
4  "state": "CREATED",
5  "product": "LOCKER_EXPRESS",
6  "brand": "INSTABOX",
7  "countryCode": "SE",
8  "links": {
9    "label": "https://api.integration.instabee.com/orders/ORDER-12345/labels",
10    "tracking": "https://track.instabee.com/SHOP000000123456"
11  },
12  "attributes": {
13    "labelCode": "IN123"
14  },
15  "recipient": {
16    "name": "John Doe",
17    "email": "john@example.com",
18    "phone": "0701234567",
19    "street": "Hälsingegatan 40",
20    "postalCode": "11353",
21    "city": "Stockholm",
22    "countryCode": "SE"
23  },
24  "deliveryOption": {
25    "sortCode": "IN123",
26    "etaInterval": {
27      "from": "2025-06-29T08:00:00.000Z",
28      "to": "2025-06-29T16:00:00.000Z"
29    }
30  }
31}

Error Handling

Status Code	Description	Solution
`401`	Unauthorised	Verify your Bearer token
`404`	Order or parcel not found	Check the orderId (fetch order) or parcelId (fetch parcel) is correct
`429`	Rate limit exceeded	Reduce request frequency

Fetch Order

Fetch Order

Path Parameters

Response Parameters

parcels

parcels.links

label URL parameters

parcels.attributes

parcels.deliveryOption

parcels.deliveryOption.etaInterval

Response Example — Standard Order

Response Example — Locker to Locker Order

Fetch Parcel

Query Parameters

Error Handling

Command Palette