POST api/{siteCode}/POD/WriteSupplierPODBatch

This call is for use by third parties sending batches of PODs that are destined for other siteCodes.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteCode

string

None.

Body Parameters

The pod batch.

PODBatch
NameDescriptionTypeAdditional 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

Returns a count of records successfully written to the destination database

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.