Object Reference
Address
Physicall address.
Blocker
A blocker determines if a parcel should be blocked. It prevents a parcel from being ingested into the locker or given out to the end-customer.
| blocked 🔗 |
boolean
Indicates if a parcel is blocked. Set to false equals to Blocker object set to null. It's recommonded to set it true along with the reason field. If no reason is provided and the flag is set to true then a generic prompt is showed to a customer |
| reasons 🔗 |
object[]
|
DeliveryRequirement
A parcel's delivery requirement.
| data 🔗 |
hash
|
| type 🔗 |
string
A delivery requirement's type. `DELIVERY_REQUIREMENT_TYPE_CASH_ON_DELIVERY` - requirement to make a payment upon delivery with the amount and currency set accordingly as as the `data[amount]` and `data[currency]` parameters `DELIVERY_REQUIREMENT_TYPE_ID_CHECK` - requirement to verify the end-customer with an identity card `DELIVERY_REQUIREMENT_TYPE_AGE_RESTRICTED` - requirement to verify the end-customer's age provided by the `data[age]` property |
Deviation
A deviation object. Contains additional information related to any parcel's deviation.
| comment 🔗 |
string
Additional information to an occurred deviation |
| type 🔗 |
string
Deviation's type. Supported values are: `DEVIATION_TYPE_NO_REASON` - means that a parcel is refused by a customer and the customer doesn't want to share a reason why. `DEVIATION_TYPE_NOT_ORDERED` - means that a customer didn't order a parcel that is about to be delivered. `DEVIATION_TYPE_GOODS_DAMAGED` - means that goods inside the parcel are damaged and a customer can refuse to pick it up. `DEVIATION_TYPE_PACKAGING_DAMAGED` - means that the parcel's package is damaged and a customer can refuse to pick it up |
Dimensions
Parcel's dimension in millimeters.
Error
| message 🔗 |
string
string |
IdentityDocument
A person's ID document.
Parcel
| blocker 🔗 | |
| delivery_requirements 🔗 | |
| dimensions 🔗 | |
| 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. `JOURNEY_STAGE_FIRST_MILE` - return from end-customer. `JOURNEY_STAGE_LAST_MILE` - delivery to end-customer |
| 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 |
| recipient 🔗 |
Party
required
|
| sender 🔗 |
Party
required
|
| 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
| location_id 🔗 |
string
required
A location parcel where a parcel is accepted |
| parcel_id 🔗 |
string
required
A parcel's global identifier. Used to explicitly identify the parcel |
ParcelDeliveredRequest
| deviation 🔗 | |
| parcel_id 🔗 |
string
required
A parcel's global identifier. Used to explicitly identify the parcel |
| proxy_identity_document 🔗 | |
| recipient_identity_document 🔗 |
ParcelDocument
A parcel's document.
| content_type 🔗 |
string
Parcel document's content type. Allowed formats are PDF and ZPL |
| url 🔗 |
string
Parcel document's url |
ParcelIngestedRequest
| delivery_module 🔗 |
string
required
A delivery module type. Supported values are `MODULE_TYPE_RACK` and `MODULE_TYPE_LOCKER` |
| location_id 🔗 |
string
required
A location parcel is ingested to |
| parcel_id 🔗 |
string
required
A parcel's global identifier. Used to explicitly identify the parcel |
| relocated 🔗 |
boolean
required
A flag indicating if a parcel is relocated so was previously ejected and now is ingested again |
ParcelRefusedRequest
| deviation 🔗 |
Deviation
required
|
| parcel_id 🔗 |
string
required
A parcel's global identifier. Used to explicitly identify the parcel |
ParcelReturnedRequest
| parcel_id 🔗 |
string
required
A parcel's global identifier. Used to explicitly identify the parcel |
Party
Either sender or receiver.
Address
Any
Blocker
BlockReason
| language 🔗 |
string
ISO 639-1 code (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| text 🔗 |
string
|
Contact
Coordinates
Geolocation coordinates
DeliveryRequirement
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 🔗 | |
| coordinates 🔗 | |
| hk_number 🔗 |
string
|
| location_id 🔗 |
string
|
| name 🔗 |
string
|
| opening_hours 🔗 |
OpeningHours
| fri 🔗 |
Fri represents operational hours defined for Friday |
| mon 🔗 |
Mon represents operational hours defined for Monday |
| sat 🔗 |
Sat represents operational hours defined for Saturday |
| sun 🔗 |
Sun represents operational hours defined for Sunday |
| thu 🔗 |
Thu represents operational hours defined for Thursday |
| tue 🔗 |
Tue represents operational hours defined for Tuesday |
| wed 🔗 |
Wed represents operational hours defined for Wednesday |
Party
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 🔗 | |
| is_identity_confirmed 🔗 |
boolean
|
| location_id 🔗 |
string
required
|
| order_id 🔗 |
string
required
|
| parcel_id 🔗 |
string
required
|
| product_code 🔗 |
string
required
|
| receive_code 🔗 |
string
|
| recipient 🔗 |
Party
required
|
| sender 🔗 |
Party
required
|
| tracking_id 🔗 |
string
|
| weight 🔗 |
integer
|
UpsertParcelResponse
| message 🔗 |
string
|