Events method

GET /v1/Event/ByShipmentNo/{shipmentNo}

Get events using a shipment number and time period

Uri parameters

Name	Description	Type	Additional description
shipmentNo	The shipment number		Required
from	Time period start. Default 100 days ago.	date-time
to	Time period end. Default now	date-time
page	Page number to retrieve. Zero based	int32	Default = 0
pageSize	Number of events to retrieve. Inclusive between 1-100	int32	Default = 50

Body parameters

None

Request sample:

None

Response sample:

200

{
  "pageNo": 0,
  "pageSize": 10,
  "hasPrevious": false,
  "hasNext": true,
  "page": [],
  "nextUrl": "/v1/event/ByShipmentNo/370726545000000179?from=2023-06-10 10:40:11Z&to=2023-09-18 10:40:11Z&page=1&pageSize=10",
  "previousUrl": null
}

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