POST api/{siteCode}/Courier/CourierStatusUpdate

Status update for a Courier Job.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteCode	The site code.	integer	Required

Body Parameters

The courier status event.

JobStatusEvent

Name	Type	Additional information
SiteCode	integer	None.
ConsignmentRef	string	None.
EventCode	string	None.
EventName	string	None.
EventDate	date	None.
EventTime	date	None.
EventLocation	string	None.
isException	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteCode": 1,
  "ConsignmentRef": "12345678",
  "EventCode": "DEL",
  "EventName": "Delivered",
  "EventDate": "2025-12-06T11:24:59.5590227+00:00",
  "EventTime": "2025-12-06T11:24:59.5590227+00:00",
  "EventLocation": "GBWSR",
  "isException": false
}

application/xml, text/xml

Sample:

<JobStatusEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SiteCode>1</SiteCode>
  <ConsignmentRef>12345678</ConsignmentRef>
  <EventCode>DEL</EventCode>
  <EventName>Delivered</EventName>
  <EventDate>2025-12-06T11:24:59.5590227+00:00</EventDate>
  <EventTime>2025-12-06T11:24:59.5590227+00:00</EventTime>
  <EventLocation>GBWSR</EventLocation>
  <isException>false</isException>
</JobStatusEvent>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.