Webhook for parcel updates

wbhk

ParcelUpdates

Webhook to push parcel updates to any URL provided by the carrier. This endpoint allows carriers to receive
real-time updates about parcels.

Payload

Information about parcel updates

shipmentUid

string

The unique identifier of the parcel shipment in the GLS/NXT Platform

lockerUid

string

The unique identifier of the locker in the GLS/NXT Platform

carrierParcelId

string

The identifier of the parcel in the carrier's system

carrierLockerId

string | null

The identifier of the locker in the carrier's system

shipmentType

string

enum

The type of shipment.

Allowed:

dimensionsStatus

string

enum

The status of the parcel dimensions.

Allowed:

shipmentStatus

string

enum

The status of the shipment.

isFinal

boolean

accessCodes

object | null

Access codes for the parcel

consignee

object | null

The details of the consignee.

events

array of objects

events

allocationType

string

enum

The allocation type of the shipment.

Allowed:

shipmentSignature

object

A Base64-encoded image representing the consignee's signature, captured upon parcel collection

eventTimestamp

date-time

The timestamp of the parcel update

Responses

200

Return a 200 status to indicate that the data was received successfully.

401

Return a 401 status to indicate that the POST was unauthorized.

500

Return a 500 status to indicate that the POST was unsuccessfully processed.

Loading…