POST api/{siteCode}/POD/WritePOD

This service will process batches of PODs for either Courier consignments, Delivery Notes or Jobs. Courier consignments are recognised by the Consignment Reference. Delivery Notes are recognised by the Job Number and Note ID [JobNumber]-[NoteID]. In the event that the ID is not provided the POD will be processed as a Job.

Request Information

URI Parameters

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

Body Parameters

The pod batch.

PODBatch

Name	Description	Type	Additional information
PODItems		Collection of PODItem	None.

Request Formats

application/json, text/json

Sample:

{
  "PODItems": [
    {
      "SiteCode": 1,
      "Shipment_Type": "Courier",
      "ConsignmentRef": "Consignment Ref",
      "DelDate": "2025-02-04T00:00:00+00:00",
      "DelTime": "2025-02-04T23:06:22.8890533+00:00",
      "DelSignature": "Mr Sig Nature"
    },
    {
      "SiteCode": 1,
      "Shipment_Type": "Delivery Note",
      "ConsignmentRef": "JobNumber-NoteID",
      "DelDate": "2025-02-04T00:00:00+00:00",
      "DelTime": "2025-02-04T23:06:22.8890533+00:00",
      "DelSignature": "Mr Sig Nature"
    }
  ]
}

application/xml, text/xml

Sample:

<PODBatch xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PODItems>
    <PODItem>
      <SiteCode>1</SiteCode>
      <Shipment_Type>Courier</Shipment_Type>
      <ConsignmentRef>Consignment Ref</ConsignmentRef>
      <DelDate>2025-02-04T00:00:00+00:00</DelDate>
      <DelTime>2025-02-04T23:06:22.8890533+00:00</DelTime>
      <DelSignature>Mr Sig Nature</DelSignature>
    </PODItem>
    <PODItem>
      <SiteCode>1</SiteCode>
      <Shipment_Type>Delivery Note</Shipment_Type>
      <ConsignmentRef>JobNumber-NoteID</ConsignmentRef>
      <DelDate>2025-02-04T00:00:00+00:00</DelDate>
      <DelTime>2025-02-04T23:06:22.8890533+00:00</DelTime>
      <DelSignature>Mr Sig Nature</DelSignature>
    </PODItem>
  </PODItems>
</PODBatch>

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.