Order/Warehouse Events

Our API provides you with great flexibility and scope to retrieve and send data as you need. In this case, sending a custom event/checkpoint to be displayed in the order status history for a tracking.

Create Event

You can create a new event in the parcelLab system using the v4/track/events endpoint.

Create Event

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
or
or
Responses
post
/v4/track/events/
204

No response body

No content

Allowed API Payload Structures

This API accepts request bodies (payloads) to update via multiple reference numbers. The provided payload always must contain:

  • The event_yimestamp of the event in ISO 8601 format YYYY-MM-DD[T]HH:mm:ss.SSSZ.

  • The event_status can be any internal code describing a status that will be mapped by the parcelLab team.

  • Optional location of the event as any clear text string.

Via Courier and Tracking Number

To update a specific tracking via providing the original courier code and tracking number, your payload must include the following:

  • The courier in the parcelLab format.

  • The tracking_number as listed in the parcelLab system.

Courier and Tracking Number Example

In this example, you would send a request similar to the below.

Via Account and Reference Number

If no tracking number is available, the reference number must be used. The payload can be changed to include the following:

  • The account ID as listed in the parcelLab system.

  • The reference_number of the shipment.

Account and Referemce Number Example

In this example, you would send a request similar to the below.

Via Account and Order Number

Events can also be attached to any order. For this, the identification key is order_number. The payload can be changed to include the following:

  • The account ID as listed in the parcelLab system.

  • The order_number as listed in the parcelLab system.

Account and Order Number Example

In this example, you would send a request similar to the below.

Last updated

Was this helpful?