The purpose of this API is to get details for a shipment.
⚠️ Fields marked with (WIP) are not available in production yet.
Content
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
Name | Type | Example | Mandatory | Description |
|---|---|---|---|---|
shipmentId | String | 70724760322123456 | yes | The id-number of the shipment |
ediStatus | String | EXPORT_OK | yes | The current EDI-status of the shipment |
shopid (WIP) | Integer | 1 | yes | The id of the shop for the shipment |
shopName (WIP) | String | TestShop | yes | The name of the shop for the shipment |
pickupDetails (WIP) | Object | no | This object will be populated if the shipment is a pickup shipment | |
pickupDetails-returnCode (WIP) | String | R-12345 | no | The return code of the shipment |
pickupDetails-placement (WIP) | String | mailbox, door, common-box, newspaper | no | Where the consumer should place the shipment |
pickupDetails-pickupDate (WIP) | Date | 2023-08-31 | no | The date the shipment will be picked up by the distribution. If null, no date has been set. The customer should place the shipment at the assigned spot the day before. |
pickupDetails-possiblePickupDates (WIP) | List<Date> | [2023-08-31, 2023-09-01, … ] | no | A list of future possible pickup dates |
items | Array | yes | List of one or more items in the shipment | |
items-trackingReference | String | 370724760322123456 | yes | Tracking number for the given item |
items-labellessCode | String | TESTCODE | no | Submission code received from PostNord in case this is a myPackGo item |
...
ediStatus | Comment |
|---|---|
ATTEMPTING_EXPORT | We are attempting to forward the bookingdata/edi to the carrier/company responsible to perform the delivery. For the majority this will take seconds, but can take up to 2 hours (depending on carrier, availability and so on) Action: None, everything is normal with this status. |
EXPORT_OK | The bookingdata/edi is registered with the carrier/company responsible to perform the delivery, and the registration was successful. Action: None, everything is normal with this status. |
EXPORT_FAILED_WILL_RETRY | We have attempted to forward the bookingdata/edi to the carrier/company responsible to perform the delivery, but the carrier was not able to receive it at the time. The bookingdata/edi will receive this status when the service the carrier have is unavailable. Most likely the unavailability is short, and the bookingdata/edi will be registered shortly. Action: No action needed yet. The system will automatically retry registration of the bookingdata/edi. This can take up to 5 hours. |
EXPORT_FAILED_PERMANENTLY | We have attempted to forward the bookingdata/edi to the carrier/company responsible to perform the delivery, but the carrier was not able to receive it. The bookingdata/edi will receive this status when the service the carrier have is unavailable over a long periode of time or the request in invalid (missing mandatory data, invalid values and so on) Action: With no action this bookingdata/edi will not be registered with the carrier. Based on the type of booking we suggest the following actions
|
CANCELLED (WIP) | The shipment has been cancelled and will not be picked up |
PASSIVE_RETURN (WIP) | The shipment has been registered, but not yet activated. Use the Parcel Activate Order API to set a date for the pickup. |
...