POST api/{siteCode}/Courier/CourierStatusUpdateBatch
Status update for multiple Courier Jobs.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteCode |
The site code. |
integer |
Required |
Body Parameters
The list courier status event.
Collection of JobStatusEvent| Name | Description | 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": "sample string 2",
"EventCode": "sample string 3",
"EventName": "sample string 4",
"EventDate": "2025-10-25T18:09:24.4380317+01:00",
"EventTime": "2025-10-25T18:09:24.4380317+01:00",
"EventLocation": "sample string 5",
"isException": true
},
{
"SiteCode": 1,
"ConsignmentRef": "sample string 2",
"EventCode": "sample string 3",
"EventName": "sample string 4",
"EventDate": "2025-10-25T18:09:24.4380317+01:00",
"EventTime": "2025-10-25T18:09:24.4380317+01:00",
"EventLocation": "sample string 5",
"isException": true
}
]
application/xml, text/xml
Sample:
<ArrayOfJobStatusEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<JobStatusEvent>
<SiteCode>1</SiteCode>
<ConsignmentRef>sample string 2</ConsignmentRef>
<EventCode>sample string 3</EventCode>
<EventName>sample string 4</EventName>
<EventDate>2025-10-25T18:09:24.4380317+01:00</EventDate>
<EventTime>2025-10-25T18:09:24.4380317+01:00</EventTime>
<EventLocation>sample string 5</EventLocation>
<isException>true</isException>
</JobStatusEvent>
<JobStatusEvent>
<SiteCode>1</SiteCode>
<ConsignmentRef>sample string 2</ConsignmentRef>
<EventCode>sample string 3</EventCode>
<EventName>sample string 4</EventName>
<EventDate>2025-10-25T18:09:24.4380317+01:00</EventDate>
<EventTime>2025-10-25T18:09:24.4380317+01:00</EventTime>
<EventLocation>sample string 5</EventLocation>
<isException>true</isException>
</JobStatusEvent>
</ArrayOfJobStatusEvent>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage.
HttpResponseMessage| Name | Description | 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. |