POST api/{siteCode}/Courier/CreateCourierBookingBatch

Creates a batch of courier bookings.

Request Information

URI Parameters

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

Body Parameters

The courier bookings.

Collection of CourierJob

Name	Type	Additional information
ConsignmentRef	string	String length: inclusive between 0 and 50
CustomerRef	string	String length: inclusive between 0 and 255
CustomerRef2	string	String length: inclusive between 0 and 50
Carrier	string	String length: inclusive between 0 and 50
CarrierRef	string	String length: inclusive between 0 and 50
CarrierAccNum	string	String length: inclusive between 0 and 50
TrackingNumber	string	String length: inclusive between 0 and 50
CustAccNum	string	String length: inclusive between 0 and 50
ShipperName	string	String length: inclusive between 0 and 50
ShipperAddress_1	string	String length: inclusive between 0 and 50
ShipperAddress_2	string	String length: inclusive between 0 and 50
ShipperAddress_3	string	String length: inclusive between 0 and 50
ShipperAddress_4	string	String length: inclusive between 0 and 50
ShipperPostCode	string	String length: inclusive between 0 and 50
ShipperCountry	string	String length: inclusive between 0 and 50
ShipperContact	string	String length: inclusive between 0 and 50
ShipperPhone	string	String length: inclusive between 0 and 50
ShipperDepartment	string	String length: inclusive between 0 and 50
ShipperCity	string	String length: inclusive between 0 and 50
CollectionDate	date	None.
ShipDate	date	None.
ConsigneeName	string	String length: inclusive between 0 and 50
ConsigneeAddress1	string	String length: inclusive between 0 and 50
ConsigneeAddress2	string	String length: inclusive between 0 and 50
ConsigneeAddress3	string	String length: inclusive between 0 and 50
ConsigneeAddress4	string	String length: inclusive between 0 and 50
ConsigneeCountry	string	String length: inclusive between 0 and 50
ConsigneePostCode	string	String length: inclusive between 0 and 50
ConsigneeContact	string	String length: inclusive between 0 and 50
ConsigneePhone	string	String length: inclusive between 0 and 50
DestCity	string	String length: inclusive between 0 and 50
DestCountry	string	String length: inclusive between 0 and 50
DestCountryCode	string	String length: inclusive between 0 and 50
DeliveryDate	date	None.
DeliveryTime	string	String length: inclusive between 0 and 50
Docs	integer	None.
Description	string	None.
NOP	integer	None.
Weight	decimal number	None.
VolWeight	decimal number	None.
ChargeableWeight	decimal number	None.
UnitOfMeasure	string	String length: inclusive between 0 and 50
CustomsValue	decimal number	None.
CustomsValueCurrency	string	String length: inclusive between 0 and 50
Comments	string	String length: inclusive between 0 and 1000
JobType	string	Required String length: inclusive between 0 and 50
Service	string	String length: inclusive between 0 and 50
TariffName	string	String length: inclusive between 0 and 50
Band	string	String length: inclusive between 0 and 50
BuyBand	string	String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

[
  {
    "ConsignmentRef": "sample string 1",
    "CustomerRef": "sample string 2",
    "CustomerRef2": "sample string 3",
    "Carrier": "sample string 4",
    "CarrierRef": "sample string 5",
    "CarrierAccNum": "sample string 6",
    "TrackingNumber": "sample string 7",
    "CustAccNum": "sample string 8",
    "ShipperName": "sample string 9",
    "ShipperAddress_1": "sample string 10",
    "ShipperAddress_2": "sample string 11",
    "ShipperAddress_3": "sample string 12",
    "ShipperAddress_4": "sample string 13",
    "ShipperPostCode": "sample string 14",
    "ShipperCountry": "sample string 15",
    "ShipperContact": "sample string 16",
    "ShipperPhone": "sample string 17",
    "ShipperDepartment": "sample string 18",
    "ShipperCity": "sample string 19",
    "CollectionDate": "2025-02-05T06:56:10.5404346+00:00",
    "ShipDate": "2025-02-05T06:56:10.5404346+00:00",
    "ConsigneeName": "sample string 20",
    "ConsigneeAddress1": "sample string 21",
    "ConsigneeAddress2": "sample string 22",
    "ConsigneeAddress3": "sample string 23",
    "ConsigneeAddress4": "sample string 24",
    "ConsigneeCountry": "sample string 25",
    "ConsigneePostCode": "sample string 26",
    "ConsigneeContact": "sample string 27",
    "ConsigneePhone": "sample string 28",
    "DestCity": "sample string 29",
    "DestCountry": "sample string 30",
    "DestCountryCode": "sample string 31",
    "DeliveryDate": "2025-02-05T06:56:10.5404346+00:00",
    "DeliveryTime": "sample string 32",
    "Docs": 1,
    "Description": "sample string 33",
    "NOP": 1,
    "Weight": 1.1,
    "VolWeight": 1.1,
    "ChargeableWeight": 1.1,
    "UnitOfMeasure": "sample string 34",
    "CustomsValue": 1.0,
    "CustomsValueCurrency": "sample string 35",
    "Comments": "sample string 36",
    "JobType": "sample string 37",
    "Service": "sample string 38",
    "TariffName": "sample string 39",
    "Band": "sample string 40",
    "BuyBand": "sample string 41"
  },
  {
    "ConsignmentRef": "sample string 1",
    "CustomerRef": "sample string 2",
    "CustomerRef2": "sample string 3",
    "Carrier": "sample string 4",
    "CarrierRef": "sample string 5",
    "CarrierAccNum": "sample string 6",
    "TrackingNumber": "sample string 7",
    "CustAccNum": "sample string 8",
    "ShipperName": "sample string 9",
    "ShipperAddress_1": "sample string 10",
    "ShipperAddress_2": "sample string 11",
    "ShipperAddress_3": "sample string 12",
    "ShipperAddress_4": "sample string 13",
    "ShipperPostCode": "sample string 14",
    "ShipperCountry": "sample string 15",
    "ShipperContact": "sample string 16",
    "ShipperPhone": "sample string 17",
    "ShipperDepartment": "sample string 18",
    "ShipperCity": "sample string 19",
    "CollectionDate": "2025-02-05T06:56:10.5404346+00:00",
    "ShipDate": "2025-02-05T06:56:10.5404346+00:00",
    "ConsigneeName": "sample string 20",
    "ConsigneeAddress1": "sample string 21",
    "ConsigneeAddress2": "sample string 22",
    "ConsigneeAddress3": "sample string 23",
    "ConsigneeAddress4": "sample string 24",
    "ConsigneeCountry": "sample string 25",
    "ConsigneePostCode": "sample string 26",
    "ConsigneeContact": "sample string 27",
    "ConsigneePhone": "sample string 28",
    "DestCity": "sample string 29",
    "DestCountry": "sample string 30",
    "DestCountryCode": "sample string 31",
    "DeliveryDate": "2025-02-05T06:56:10.5404346+00:00",
    "DeliveryTime": "sample string 32",
    "Docs": 1,
    "Description": "sample string 33",
    "NOP": 1,
    "Weight": 1.1,
    "VolWeight": 1.1,
    "ChargeableWeight": 1.1,
    "UnitOfMeasure": "sample string 34",
    "CustomsValue": 1.0,
    "CustomsValueCurrency": "sample string 35",
    "Comments": "sample string 36",
    "JobType": "sample string 37",
    "Service": "sample string 38",
    "TariffName": "sample string 39",
    "Band": "sample string 40",
    "BuyBand": "sample string 41"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCourierJob xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CourierJob>
    <ConsignmentRef>sample string 1</ConsignmentRef>
    <CustomerRef>sample string 2</CustomerRef>
    <CustomerRef2>sample string 3</CustomerRef2>
    <Carrier>sample string 4</Carrier>
    <CarrierRef>sample string 5</CarrierRef>
    <CarrierAccNum>sample string 6</CarrierAccNum>
    <TrackingNumber>sample string 7</TrackingNumber>
    <CustAccNum>sample string 8</CustAccNum>
    <ShipperName>sample string 9</ShipperName>
    <ShipperAddress_1>sample string 10</ShipperAddress_1>
    <ShipperAddress_2>sample string 11</ShipperAddress_2>
    <ShipperAddress_3>sample string 12</ShipperAddress_3>
    <ShipperAddress_4>sample string 13</ShipperAddress_4>
    <ShipperPostCode>sample string 14</ShipperPostCode>
    <ShipperCountry>sample string 15</ShipperCountry>
    <ShipperContact>sample string 16</ShipperContact>
    <ShipperPhone>sample string 17</ShipperPhone>
    <ShipperDepartment>sample string 18</ShipperDepartment>
    <ShipperCity>sample string 19</ShipperCity>
    <CollectionDate>2025-02-05T06:56:10.5404346+00:00</CollectionDate>
    <ShipDate>2025-02-05T06:56:10.5404346+00:00</ShipDate>
    <ConsigneeName>sample string 20</ConsigneeName>
    <ConsigneeAddress1>sample string 21</ConsigneeAddress1>
    <ConsigneeAddress2>sample string 22</ConsigneeAddress2>
    <ConsigneeAddress3>sample string 23</ConsigneeAddress3>
    <ConsigneeAddress4>sample string 24</ConsigneeAddress4>
    <ConsigneeCountry>sample string 25</ConsigneeCountry>
    <ConsigneePostCode>sample string 26</ConsigneePostCode>
    <ConsigneeContact>sample string 27</ConsigneeContact>
    <ConsigneePhone>sample string 28</ConsigneePhone>
    <DestCity>sample string 29</DestCity>
    <DestCountry>sample string 30</DestCountry>
    <DestCountryCode>sample string 31</DestCountryCode>
    <DeliveryDate>2025-02-05T06:56:10.5404346+00:00</DeliveryDate>
    <DeliveryTime>sample string 32</DeliveryTime>
    <Docs>1</Docs>
    <Description>sample string 33</Description>
    <NOP>1</NOP>
    <Weight>1.1</Weight>
    <VolWeight>1.1</VolWeight>
    <ChargeableWeight>1.1</ChargeableWeight>
    <UnitOfMeasure>sample string 34</UnitOfMeasure>
    <CustomsValue>1</CustomsValue>
    <CustomsValueCurrency>sample string 35</CustomsValueCurrency>
    <Comments>sample string 36</Comments>
    <JobType>sample string 37</JobType>
    <Service>sample string 38</Service>
    <TariffName>sample string 39</TariffName>
    <Band>sample string 40</Band>
    <BuyBand>sample string 41</BuyBand>
    <ConsigneeFax>sample string 42</ConsigneeFax>
    <ShipperFax>sample string 43</ShipperFax>
    <ID>44</ID>
    <JobNumber>sample string 45</JobNumber>
    <ConsigneeAddressID>1</ConsigneeAddressID>
    <Bag>sample string 46</Bag>
    <DestHub>sample string 47</DestHub>
    <PODname>sample string 48</PODname>
    <PODdate>2025-02-05T06:56:10.5559989+00:00</PODdate>
    <PODtime>2025-02-05T06:56:10.5559989+00:00</PODtime>
    <InvoiceNumber>sample string 49</InvoiceNumber>
    <Problem>1</Problem>
    <CostCentre>sample string 50</CostCentre>
    <Option1>1</Option1>
    <Option2>1</Option2>
    <Option3>1</Option3>
    <Option4>1</Option4>
    <Option5>1</Option5>
    <TimeDue>2025-02-05T06:56:10.5559989+00:00</TimeDue>
    <Vehicle>sample string 51</Vehicle>
    <Checked>sample string 52</Checked>
    <Agent>sample string 53</Agent>
    <AgentAccNum>sample string 54</AgentAccNum>
    <AgentAddress>sample string 55</AgentAddress>
    <StandingCollectionID>1</StandingCollectionID>
    <Flight>sample string 56</Flight>
    <FlightID>1</FlightID>
    <Collected>1</Collected>
    <ManifestID>sample string 57</ManifestID>
    <Shipped>1</Shipped>
    <TemplateName>sample string 58</TemplateName>
    <CompletedBy>sample string 59</CompletedBy>
    <TariffJobType>sample string 60</TariffJobType>
    <TSTAMP>QEA=</TSTAMP>
  </CourierJob>
  <CourierJob>
    <ConsignmentRef>sample string 1</ConsignmentRef>
    <CustomerRef>sample string 2</CustomerRef>
    <CustomerRef2>sample string 3</CustomerRef2>
    <Carrier>sample string 4</Carrier>
    <CarrierRef>sample string 5</CarrierRef>
    <CarrierAccNum>sample string 6</CarrierAccNum>
    <TrackingNumber>sample string 7</TrackingNumber>
    <CustAccNum>sample string 8</CustAccNum>
    <ShipperName>sample string 9</ShipperName>
    <ShipperAddress_1>sample string 10</ShipperAddress_1>
    <ShipperAddress_2>sample string 11</ShipperAddress_2>
    <ShipperAddress_3>sample string 12</ShipperAddress_3>
    <ShipperAddress_4>sample string 13</ShipperAddress_4>
    <ShipperPostCode>sample string 14</ShipperPostCode>
    <ShipperCountry>sample string 15</ShipperCountry>
    <ShipperContact>sample string 16</ShipperContact>
    <ShipperPhone>sample string 17</ShipperPhone>
    <ShipperDepartment>sample string 18</ShipperDepartment>
    <ShipperCity>sample string 19</ShipperCity>
    <CollectionDate>2025-02-05T06:56:10.5404346+00:00</CollectionDate>
    <ShipDate>2025-02-05T06:56:10.5404346+00:00</ShipDate>
    <ConsigneeName>sample string 20</ConsigneeName>
    <ConsigneeAddress1>sample string 21</ConsigneeAddress1>
    <ConsigneeAddress2>sample string 22</ConsigneeAddress2>
    <ConsigneeAddress3>sample string 23</ConsigneeAddress3>
    <ConsigneeAddress4>sample string 24</ConsigneeAddress4>
    <ConsigneeCountry>sample string 25</ConsigneeCountry>
    <ConsigneePostCode>sample string 26</ConsigneePostCode>
    <ConsigneeContact>sample string 27</ConsigneeContact>
    <ConsigneePhone>sample string 28</ConsigneePhone>
    <DestCity>sample string 29</DestCity>
    <DestCountry>sample string 30</DestCountry>
    <DestCountryCode>sample string 31</DestCountryCode>
    <DeliveryDate>2025-02-05T06:56:10.5404346+00:00</DeliveryDate>
    <DeliveryTime>sample string 32</DeliveryTime>
    <Docs>1</Docs>
    <Description>sample string 33</Description>
    <NOP>1</NOP>
    <Weight>1.1</Weight>
    <VolWeight>1.1</VolWeight>
    <ChargeableWeight>1.1</ChargeableWeight>
    <UnitOfMeasure>sample string 34</UnitOfMeasure>
    <CustomsValue>1</CustomsValue>
    <CustomsValueCurrency>sample string 35</CustomsValueCurrency>
    <Comments>sample string 36</Comments>
    <JobType>sample string 37</JobType>
    <Service>sample string 38</Service>
    <TariffName>sample string 39</TariffName>
    <Band>sample string 40</Band>
    <BuyBand>sample string 41</BuyBand>
    <ConsigneeFax>sample string 42</ConsigneeFax>
    <ShipperFax>sample string 43</ShipperFax>
    <ID>44</ID>
    <JobNumber>sample string 45</JobNumber>
    <ConsigneeAddressID>1</ConsigneeAddressID>
    <Bag>sample string 46</Bag>
    <DestHub>sample string 47</DestHub>
    <PODname>sample string 48</PODname>
    <PODdate>2025-02-05T06:56:10.5559989+00:00</PODdate>
    <PODtime>2025-02-05T06:56:10.5559989+00:00</PODtime>
    <InvoiceNumber>sample string 49</InvoiceNumber>
    <Problem>1</Problem>
    <CostCentre>sample string 50</CostCentre>
    <Option1>1</Option1>
    <Option2>1</Option2>
    <Option3>1</Option3>
    <Option4>1</Option4>
    <Option5>1</Option5>
    <TimeDue>2025-02-05T06:56:10.5559989+00:00</TimeDue>
    <Vehicle>sample string 51</Vehicle>
    <Checked>sample string 52</Checked>
    <Agent>sample string 53</Agent>
    <AgentAccNum>sample string 54</AgentAccNum>
    <AgentAddress>sample string 55</AgentAddress>
    <StandingCollectionID>1</StandingCollectionID>
    <Flight>sample string 56</Flight>
    <FlightID>1</FlightID>
    <Collected>1</Collected>
    <ManifestID>sample string 57</ManifestID>
    <Shipped>1</Shipped>
    <TemplateName>sample string 58</TemplateName>
    <CompletedBy>sample string 59</CompletedBy>
    <TariffJobType>sample string 60</TariffJobType>
    <TSTAMP>QEA=</TSTAMP>
  </CourierJob>
</ArrayOfCourierJob>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of CourierBookingResponse

Name	Type	Additional information
CourierJobID	integer	None.
CourierJobNumber	string	None.
ConsignmentReference	string	None.
CustomerReference	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CourierJobID": 1,
    "CourierJobNumber": "sample string 1",
    "ConsignmentReference": "sample string 2",
    "CustomerReference": "sample string 3"
  },
  {
    "CourierJobID": 1,
    "CourierJobNumber": "sample string 1",
    "ConsignmentReference": "sample string 2",
    "CustomerReference": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCourierBookingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CourierBookingResponse>
    <CourierJobID>1</CourierJobID>
    <CourierJobNumber>sample string 1</CourierJobNumber>
    <ConsignmentReference>sample string 2</ConsignmentReference>
    <CustomerReference>sample string 3</CustomerReference>
  </CourierBookingResponse>
  <CourierBookingResponse>
    <CourierJobID>1</CourierJobID>
    <CourierJobNumber>sample string 1</CourierJobNumber>
    <ConsignmentReference>sample string 2</ConsignmentReference>
    <CustomerReference>sample string 3</CustomerReference>
  </CourierBookingResponse>
</ArrayOfCourierBookingResponse>