35.156.240.70
35.157.215.87
35.157.195.174
| Event | Description |
|---|---|
| onInternalDelay | The consignment was not shipped in time. This event describes a breach of the specified send_date on record creation, if not specified differently in the retailer’s logic. |
| onCreated | A new record has been created through data transfer from the retailer. |
| onUpdated | A record has been updated through data transfer from the retailer. This does not include the updated fields. |
| onDispatch | The consignment was scanned for the first time (that is: network inbound scan) and is now on its way. This event is only triggered once. |
| onScheduled | The carrier has announced the delivery day, optionally including a time window. This event is triggered for every change in scheduled delivery date (for example: if the delivery is scheduled for an earlier or later day or to a different time window). |
| onDelay | Any delay or delivery issue event. This event includes an additional key that specifies the reason code for the delay. |
| onOutForDelivery | The consignment is out for delivery. Depending on the carrier, a delivery time window may be provided. |
| onFailedAttempt | The carrier attempted a delivery to the recipient but did not meet someone or could not access the delivery location. This event can include additional keys that specify details about the expected next action that will be performed by the carrier. |
| onPickupReady | The consignment is ready for collection by the recipient at a courier location (for example: an access point or parcel locker). A further event for delivery or no collection can be expected. This event can include additional keys that specify the pickup location. |
| onDelivered | Final event: The consignment has been delivered. This event can include an additional key that provides unstructured information about the delivery (for example: signature name). |
| onReturn | Final event: The delivery failed and the consignment will be returned to the sender. This event can include an additional key that specifies the reason code for the return. |
| Field | Description |
|---|---|
| event | The event type as specified in the Events section (for example: onCreated). |
| eventid | A unique ID for this specific event that can be used for deduplication. Event IDs are strings consisting of a-f, 0-9 and dash -. |
| timestamp | The timestamp of when the event happened (not when the webhook was triggered) in ISO 8601 format: Date and time in UTC YYYY-MM-DDTHH:mm:ssZ. |
| references | The reference numbers for the consignment as described in the Structure of references section. Can optionally be submitted as URL search query parameters as well. |
| reporting | Logistics lead times of the consignment as described in the Structure of reporting section. |
| data | The event data as described in the Structure of data section. The data key contains mandatory fields that are transferred for every event and optional fields that are only transferred for specific events. |
| Field | Description |
|---|---|
| courier | The parcelLab carrier code. |
| tracking_number | The tracking number. |
| orderNo | The customer-facing order number. |
| client | The shop identifier. |
| warehouse | The warehouse identifier. |
| destination_country_iso3 | The country code (for example: USA, GBR, DEU). |
| language | The language code (for example: en, es, de). |
| Field | Description |
|---|---|
| lead_time_door_to_door | The carrier network lead time starting from the inbound scan (onDispatch) until the first qualified delivery attempt (the first occurrence of onFailedAttempt, onPickupReady, or onDelivered). |
| lead_time_qualified_attempt | The recipient-perceived lead time starting from the EDI label confirmation by the carrier (typically coincides with onCreated) until the first qualified delivery attempt. |
| lead_time_end_to_end | The complete delivery time from EDI label confirmation until final delivery to the recipient (onDelivered). |
| Field | Description |
|---|---|
| tracking_link | The URL to the carrier’s tracking page. |
| reroute_link | The URL to the carrier’s tracking page with delivery services such as rerouting, change of delivery date, and so on. This field will be empty if the link is not defined yet or no longer available. |
| raw_scan | The raw event data as provided by the carrier. There is no common data pattern as the data provided depends on the carrier interface. |
| raw_scan_location | The location as provided by the carrier as a string. This does not include coordinates or any structured address or location data. |
| delivery_status | The parcelLab status code as specified in our status code documentation. |
| delivery_status_locale_short | A short localized string representing the delivery status limited to a few words (based on language as per references.language). |
| delivery_status_locale_long | A full localized string representing the delivery status including all details such as delivery date, delivery location, and delivery information (based on language as per references.language). |
| expected_delivery_date_raw | JSON Object or an empty object if no reliable estimated delivery date is available, according to this format. |
| expected_delivery_date_formatted | A localized representation of the delivery date (based on language as per references.language) or an empty string if no reliable estimated delivery date is available. |
| delivery_location | The planned or actual delivery location according to parcelLab’s delivery location codes. This field will be non-empty as soon as the carrier scan indicates a planned delivery location and is not only set on successful delivery. |
| exception_code Only for onDelay | The reason for the delay according to parcelLab's delivery problem codes. This key is also used for delivery_status_locale_long. |
| next_action Only for onFailedAttempt | The planned next action for this delivery after a failed attempt. This can be one of the following: NewAttemptToday, NewAttemptNextDay or PickUpReady. |
| next_action_is_specified Only for onFailedAttempt | If the next_action is explicitly specified in the scan event for the failed attempt (then true) or is set by the default value for the carrier (then false). |
| pickup_location_address Only for onPickupReady | The plain address of pickup location without any HTML formatting. This typically includes location name, street, zip code and city, country (all comma separated). |
| pickup_location_opening_hours Only for onPickupReady | The opening hours of the pickup location. Note: This is not available for all pickup locations. |
| pickup_location_coordinates Only for onPickupReady | The geo-coordinates of the pickup location in the format { lat: Float, long: Float }.Note: This is not available for all pickup locations. |
| delivery_information Only for onDelivered | This specifies any details about the delivery (for example: name of recipient, name of neighbor, description of deposit location for signature release). |
| return_reason Only for onReturn | The return reason according to parcelLab’s code reasons for failed deliveries. |