Events method
POST /v1/Event
Adds an event regarding shipments or parcels
Uri parameters
None
Body parameters
Name | Description | Type | Additional description |
---|---|---|---|
eventType | The type of event. See Event Types | Integer | Required |
timestamp | The timestamp of the event | String | Required |
parcelNo | Parcel number | String | Required |
shipmentNo | Shipment number | String | Required |
referenceNo | Reference number | String |
Request sample:
{ "eventType": 1, "timestamp": "2024-11-01T04:35:54.4442075+01:00", "parcelNo": "370726545000000170", "shipmentNo": "70726540000000360", "referenceNo": "This is a reference" }
Response sample:
200
Event added
400
{ "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occured", "state": 400, "traceId": null, "errors": { "request": [ "The parcel number cannot be empty" ] } }
401
Access denied
403
Forbidden