POST api/{siteCode}/Courier/CreateCourierJob?prefix={prefix}

Creates a full courier job - multi-branch environment.

Request Information

URI Parameters

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

Body Parameters

The courier job.

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": "HD10264",
  "CustomerRef": "PO123245",
  "CustomerRef2": "SO12345",
  "Carrier": "BoxTop Post",
  "CarrierRef": null,
  "CarrierAccNum": "BOXTOPPO",
  "TrackingNumber": "TRACK12345",
  "CustAccNum": "CustAccNum",
  "ShipperName": "Shipper Shop",
  "ShipperAddress_1": "Shipper House",
  "ShipperAddress_2": "1 Shipper Avenue",
  "ShipperAddress_3": "Shipper City",
  "ShipperAddress_4": "Shipper County",
  "ShipperPostCode": "SH1 9PR",
  "ShipperCountry": "GB",
  "ShipperContact": "Mr S Hipper",
  "ShipperPhone": "020 8400 2000",
  "ShipperDepartment": null,
  "ShipperCity": "Windsor",
  "CollectionDate": null,
  "ShipDate": "2025-02-04T23:06:22.8890533+00:00",
  "ConsigneeName": "UK Consignee Limited",
  "ConsigneeAddress1": "Consignee House",
  "ConsigneeAddress2": "Consignee Road",
  "ConsigneeAddress3": "Consigneeville",
  "ConsigneeAddress4": "Consigneeshire",
  "ConsigneeCountry": "GB",
  "ConsigneePostCode": "CON 51G",
  "ConsigneeContact": "Mr Con Signee",
  "ConsigneePhone": "0181 811 8181",
  "DestCity": "UNITED KINGDOM",
  "DestCountry": null,
  "DestCountryCode": null,
  "DeliveryDate": "2025-02-04T23:06:22.8890533+00:00",
  "DeliveryTime": "23:06",
  "Docs": 0,
  "Description": "Samples",
  "NOP": 1,
  "Weight": 1.0,
  "VolWeight": null,
  "ChargeableWeight": 1.0,
  "UnitOfMeasure": null,
  "CustomsValue": 10.0,
  "CustomsValueCurrency": "GBP",
  "Comments": null,
  "JobType": "Domestic",
  "Service": "Domestic",
  "TariffName": "Domestic",
  "Band": "U",
  "BuyBand": "BoxTop Post|E"
}

application/xml, text/xml

Sample:

<CourierJob xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ConsignmentRef>HD10264</ConsignmentRef>
  <CustomerRef>PO123245</CustomerRef>
  <CustomerRef2>SO12345</CustomerRef2>
  <Carrier>BoxTop Post</Carrier>
  <CarrierAccNum>BOXTOPPO</CarrierAccNum>
  <TrackingNumber>TRACK12345</TrackingNumber>
  <CustAccNum>CustAccNum</CustAccNum>
  <ShipperName>Shipper Shop</ShipperName>
  <ShipperAddress_1>Shipper House</ShipperAddress_1>
  <ShipperAddress_2>1 Shipper Avenue</ShipperAddress_2>
  <ShipperAddress_3>Shipper City</ShipperAddress_3>
  <ShipperAddress_4>Shipper County</ShipperAddress_4>
  <ShipperPostCode>SH1 9PR</ShipperPostCode>
  <ShipperCountry>GB</ShipperCountry>
  <ShipperContact>Mr S Hipper</ShipperContact>
  <ShipperPhone>020 8400 2000</ShipperPhone>
  <ShipperCity>Windsor</ShipperCity>
  <CollectionDate xsi:nil="true" />
  <ShipDate>2025-02-04T23:06:22.8890533+00:00</ShipDate>
  <ConsigneeName>UK Consignee Limited</ConsigneeName>
  <ConsigneeAddress1>Consignee House</ConsigneeAddress1>
  <ConsigneeAddress2>Consignee Road</ConsigneeAddress2>
  <ConsigneeAddress3>Consigneeville</ConsigneeAddress3>
  <ConsigneeAddress4>Consigneeshire</ConsigneeAddress4>
  <ConsigneeCountry>GB</ConsigneeCountry>
  <ConsigneePostCode>CON 51G</ConsigneePostCode>
  <ConsigneeContact>Mr Con Signee</ConsigneeContact>
  <ConsigneePhone>0181 811 8181</ConsigneePhone>
  <DestCity>UNITED KINGDOM</DestCity>
  <DeliveryDate>2025-02-04T23:06:22.8890533+00:00</DeliveryDate>
  <DeliveryTime>23:06</DeliveryTime>
  <Docs>0</Docs>
  <Description>Samples</Description>
  <NOP>1</NOP>
  <Weight>1</Weight>
  <VolWeight xsi:nil="true" />
  <ChargeableWeight>1</ChargeableWeight>
  <CustomsValue>10</CustomsValue>
  <CustomsValueCurrency>GBP</CustomsValueCurrency>
  <JobType>Domestic</JobType>
  <Service>Domestic</Service>
  <TariffName>Domestic</TariffName>
  <Band>U</Band>
  <BuyBand>BoxTop Post|E</BuyBand>
  <ID>0</ID>
  <ConsigneeAddressID xsi:nil="true" />
  <PODdate xsi:nil="true" />
  <PODtime xsi:nil="true" />
  <Problem>0</Problem>
  <Option1 xsi:nil="true" />
  <Option2 xsi:nil="true" />
  <Option3 xsi:nil="true" />
  <Option4 xsi:nil="true" />
  <Option5 xsi:nil="true" />
  <TimeDue xsi:nil="true" />
  <StandingCollectionID xsi:nil="true" />
  <FlightID xsi:nil="true" />
  <Collected xsi:nil="true" />
  <Shipped xsi:nil="true" />
</CourierJob>

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.