Identifiers
A booking returns several identifiers. This page explains what each one is, where it comes from, and which endpoints accept it.
Shipment and parcel identifiers
| Identifier | Example | Identifies | Where you get it |
|---|---|---|---|
shipmentId |
(401)70724762337121945 |
The whole shipment (one booking, one or more parcels). | Booking response. You can also set your own value in the booking request. |
trackingReference |
(00)370724762337121953 |
One parcel (item) in the shipment. | Booking response, items[].trackingReference. |
returnCode |
T-UPRXP |
A labelless parcel. The sender writes it on the parcel instead of a label. | Booking response, items[].returnCode, for labelless C2C and return products. |
orderId |
89828037 |
Helthjem's internal order number. | Booking response. Useful when you contact support. |
shortItemIdentifier |
...1953 |
The last digits of the tracking reference, for display on labels. | Booking response, items[].properties.shortItemIdentifier. |
A shipment with one parcel has one shipmentId and one trackingReference. A shipment with several parcels has one shipmentId and one trackingReference per parcel.
GS1 prefixes
shipmentId and trackingReference are GS1 numbers. The booking response includes the GS1 application identifier in brackets:
(401)in front of ashipmentId(00)in front of atrackingReference
Remove the prefix when you use an identifier in a URL path. Brackets in a URL path must otherwise be URL-encoded, and some endpoints don't accept them.
| Booking response value | Use in URLs as |
|---|---|
(401)70724762337121945 |
70724762337121945 |
(00)370724762337121953 |
370724762337121953 |
Which identifier to use where
| Endpoint | shipmentId |
trackingReference |
returnCode |
|---|---|---|---|
| Generate a label | ✅ One label page per parcel in the shipment | ✅ One label page for that parcel | – |
| Tracking | ✅ | ✅ | ✅ |
| Cancel a booking | ✅ | ✅ | – |
Your own shipment ID
You can set shipmentId in the booking request, for example to your own order number. If you leave it empty or null, Helthjem assigns one.
Each shipmentId can only be used once. A second booking with the same value is rejected with 400 and errorKey: shipment.id.already.exists. See Idempotency & retries for how to use this as a safeguard against duplicate bookings.
Other IDs
| Identifier | Description |
|---|---|
shopId |
Your shop. Every request that creates or checks a booking needs it. Use 16 in pre-prod. |
transportSolutionId |
The delivery option you book. See Delivery methods. |
freightProductId |
The delivery method that was actually used. Returned in the booking response. |
servicePointExternalId |
A service point or parcel locker. Use it as the id of a servicePoint party when booking. |
