Object Reference
Address
Physical address.
Any
Blocker
A blocker determines if a parcel should be blocked. It can prevent actions such as the parcel from being ingested into the locker or given out to the end-customer.
| blocked 🔗 |
boolean
Indicates if a parcel is blocked. When set to false the reasons will only be informational and not block any actions. If no reason is provided and the flag is set to true then a generic prompt is showed to a customer |
| reasons 🔗 |
BlockReason
Description why a parcel is blocked. This information is exposed to a customer. It's a key value dictionary where keys are a text and a language complaint with ISO 639-1 standard. Supported languages are `en-GB`, `sv-SE`. If no description provided for a given language then a generic prompt is used.
| language 🔗 |
string
ISO 639-1 code (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| text 🔗 |
string
|
DeliveryRequirement
A parcel's delivery requirement.
| data 🔗 |
hash
|
| type 🔗 |
string
Description for each delivery requirement: - DELIVERY_REQUIREMENT_TYPE_CASH_ON_DELIVERY - requirement to make a payment upon delivery - DELIVERY_REQUIREMENT_TYPE_ID_CHECK: requirement to verify the recipient or a person authorized by the recipient with an identity card - DELIVERY_REQUIREMENT_TYPE_AGE_RESTRICTED - requirement to verify the end-customer age - DELIVERY_REQUIREMENT_TYPE_PERSONAL_PICKUP - requirement to hand over the parcel only to the recipient upon delivery - DELIVERY_REQUIREMENT_TYPE_DANGEROUS_GOODS - requirement for special treatment of substances and articles having explosive, flammable, toxic, infectious or corrosive properties - DELIVERY_REQUIREMENT_TYPE_ID_CHECK_ANY_RECIPIENT - requirement to verify the recipient with an identity card, however, without the need to match the recipient name - DELIVERY_REQUIREMENT_TYPE_NO_LOCKER_STORAGE - requirement that prevents the parcel from being placed in the locker |
Deviation
Dimensions
Dimensions of an item in millimeters.
| height 🔗 |
integer
Height of the item in millimeters |
| length 🔗 |
integer
Length of the item in millimeters |
| width 🔗 |
integer
Width of the item in millimeters |
Error
IdentityDocument
A person's ID document.
Parcel
| blocker 🔗 | |
| delivery_requirements 🔗 | |
| dimensions 🔗 |
Parcel dimensions in millimeters |
| is_identity_confirmed 🔗 |
boolean
A flag indicating whether the end-customer has been confirmed with an identity card |
| journey_stage 🔗 |
string
Indicates the stage of the parcel's journey |
| order_id 🔗 |
string
An identifier of the order containing the parcel in the merchant system |
| parcel_id 🔗 |
string
required
A parcel's global identifier. Used to explicitly identify the parcel |
| product_code 🔗 |
string
required
A parcel's shipping method |
| receive_code 🔗 |
string
A parcel's receive code when the parcel is handed over to the end-customer or parcel's drop off code when the parcel is returned by the end-customer |
| recipient 🔗 |
Party
required
|
| sender 🔗 |
Party
required
|
| should_be_returned 🔗 |
boolean
Used to communicate that the parcel is meant to be returned to the carrier |
| tracking_id 🔗 |
string
A parcel's tracking identifier. Used to get tracking information about the parcel |
| weight 🔗 |
integer
A parcel's weight in grams |
ParcelAcceptedRequest
ParcelAcceptedResponse
ParcelDeliveredRequest
| deviation 🔗 | |
| location_id 🔗 |
string
required
|
| parcel_id 🔗 |
string
required
|
| proxy_identity_document 🔗 | |
| receive_code 🔗 |
string
|
| recipient_identity_document 🔗 |
ParcelDeliveredResponse
ParcelDocument
ParcelIngestedRequest
| delivery_module 🔗 |
ModuleType
required
|
| location_id 🔗 |
string
required
|
| parcel_id 🔗 |
string
required
|
| relocated 🔗 |
boolean
required
|
ParcelIngestedResponse
| receive_code 🔗 |
string
|
ParcelRefusedRequest
ParcelRefusedResponse
| blocker 🔗 |
An optional blocker to either prevent the parcel from being refused or to provide additional information about the refusal |
| digital_receipt_sent 🔗 |
boolean
|
| label 🔗 |
A new label that should be printed for the refused parcel |
| receipt 🔗 |
ParcelReturnedRequest
| cause 🔗 |
string
The cause of the return |
| location_id 🔗 |
string
required
A location from which the parcel is returned |
| parcel_id 🔗 |
string
required
A parcel's global identifier. Used to explicitly identify the parcel |
ParcelReturnedResponse
| label 🔗 |
Party
Either sender or receiver.
QueryParcelResponse
Address
Physical address.
Any
Blocker
A blocker determines if a parcel should be blocked. It can prevent actions such as the parcel from being ingested into the locker or given out to the end-customer.
| blocked 🔗 |
boolean
Indicates if a parcel is blocked. When set to false the reasons will only be informational and not block any actions. If no reason is provided and the flag is set to true then a generic prompt is showed to a customer |
| reasons 🔗 |
BlockReason
Description why a parcel is blocked. This information is exposed to a customer. It's a key value dictionary where keys are a text and a language complaint with ISO 639-1 standard. Supported languages are `en-GB`, `sv-SE`. If no description provided for a given language then a generic prompt is used.
| language 🔗 |
string
ISO 639-1 code (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| text 🔗 |
string
|
Contact
Coordinates
Geolocation coordinates
DeliveryRequirement
A parcel's delivery requirement.
| data 🔗 |
hash
|
| type 🔗 |
string
Description for each delivery requirement: - DELIVERY_REQUIREMENT_TYPE_CASH_ON_DELIVERY - requirement to make a payment upon delivery - DELIVERY_REQUIREMENT_TYPE_ID_CHECK: requirement to verify the recipient or a person authorized by the recipient with an identity card - DELIVERY_REQUIREMENT_TYPE_AGE_RESTRICTED - requirement to verify the end-customer age - DELIVERY_REQUIREMENT_TYPE_PERSONAL_PICKUP - requirement to hand over the parcel only to the recipient upon delivery - DELIVERY_REQUIREMENT_TYPE_DANGEROUS_GOODS - requirement for special treatment of substances and articles having explosive, flammable, toxic, infectious or corrosive properties - DELIVERY_REQUIREMENT_TYPE_ID_CHECK_ANY_RECIPIENT - requirement to verify the recipient with an identity card, however, without the need to match the recipient name - DELIVERY_REQUIREMENT_TYPE_NO_LOCKER_STORAGE - requirement that prevents the parcel from being placed in the locker |
Dimensions
Dimensions of an item in millimeters.
| height 🔗 |
integer
Height of the item in millimeters |
| length 🔗 |
integer
Length of the item in millimeters |
| width 🔗 |
integer
Width of the item in millimeters |
Error
GetLocationsResponse
| locations 🔗 |
Location
| address 🔗 | |
| contact 🔗 |
Contact information of the store, such as email and phone number |
| coordinates 🔗 |
Geolocation coordinates of the address |
| hk_number 🔗 |
string
|
| location_id 🔗 |
string
A location identifier for the parcel |
| name 🔗 |
string
A name of the location |
| opening_hours 🔗 |
Operational hours defined for each day of the week |
OpeningHours
| fri 🔗 |
Operational hours defined for Friday |
| mon 🔗 |
Operational hours defined for Monday |
| sat 🔗 |
Operational hours defined for Saturday |
| sun 🔗 |
Operational hours defined for Sunday |
| thu 🔗 |
Operational hours defined for Thursday |
| tue 🔗 |
Operational hours defined for Tuesday |
| wed 🔗 |
Operational hours defined for Wednesday |
Party
Either sender or receiver.
TimeRange
Provides a time interval. Both start and end of the range need to be provided.
| end 🔗 |
string
End of the interval. Time should be provided in "HH:MM:SS" format. Example `15:04:05` |
| start 🔗 |
string
Start of the interval. Time should be provided in "HH:MM:SS" format. Example `15:04:05` |
UpsertParcelRequest
| blocker 🔗 | |
| delivery_requirements 🔗 | |
| dimensions 🔗 |
Parcel dimensions in millimeters |
| expires_at 🔗 |
string
UTC time in RFC 3339 format, see details here: https://utcc.utoronto.ca/~cks/space/blog/unix/GNUDateAndRFC3339 |
| is_identity_confirmed 🔗 |
boolean
|
| journey_stage 🔗 |
Indicates the stage of the parcel's journey |
| location_id 🔗 |
string
required
|
| order_id 🔗 |
string
required
|
| parcel_id 🔗 |
string
required
|
| product_code 🔗 |
string
required
|
| receive_code 🔗 |
string
A parcel's receive code when the parcel is handed over to the end-customer or parcel's drop off code when the parcel is returned by the end-customer |
| recipient 🔗 |
Party
required
|
| sender 🔗 |
Party
required
|
| should_be_returned 🔗 |
boolean
Used to communicate that the parcel is meant to be returned to the carrier |
| tracking_id 🔗 |
string
|
| weight 🔗 |
integer
|
UpsertParcelResponse
| message 🔗 |
string
|