POST api/{siteCode}/Job/CreateBooking

Creates a booking record and notifies the recipient.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteCode

The site code will be issued when instruction has been received from our mutual client.

 integer

Required

Body Parameters

The job booking.

JobDataBooking
NameDescriptionTypeAdditional information
YourRef

Your reference (PO No#, Shipping Invoice no#).

 string

Required

String length: inclusive between 0 and 1000
YourAcct

Your account number (please request this information from your service provider).

 string

Required

String length: inclusive between 0 and 8
YourCompanyName

The name of your company.

 string

String length: inclusive between 0 and 50
ShipperRef

The sender's reference.

 string

String length: inclusive between 0 and 1000
ShipperName

The Sender's name.

 string

String length: inclusive between 0 and 50
ShipperContact

The sending company's contact person.

 string

String length: inclusive between 0 and 50
ShipperAddress

The sender's address (lines 1 and 2).

 string

String length: inclusive between 0 and 1000
ShipperPostcode

The sender's postcode/ZIP.

 string

String length: inclusive between 0 and 50
ShipperCountry

The sender's country.

 string

String length: inclusive between 0 and 2
ShipperPhone

The sender's phone number.

 string

String length: inclusive between 0 and 25
ShipperEmail

The sender's email address.

 string

String length: inclusive between 0 and 50
ConsigneeRef

The receiver's reference.

 string

String length: inclusive between 0 and 1000
ConsigneeName

The receiver's name.

 string

String length: inclusive between 0 and 50
ConsigneeContact

The receiving company's contact person.

 string

String length: inclusive between 0 and 50
ConsigneeAddress

The receiving company's address (line 1 and 2).

 string

String length: inclusive between 0 and 1000
ConsigneePostcode

The receiving company's postcode/ZIP.

 string

String length: inclusive between 0 and 50
ConsigneeCountry

The receiving company's country.

 string

String length: inclusive between 0 and 2
ConsigneePhone

The receiving comapny's phone number.

 string

String length: inclusive between 0 and 25
ConsigneeEmail

The receiving comapny's email address.

 string

String length: inclusive between 0 and 50
RequestedPickUpDate

The requested pick up date.

 date

None.
RequestedDeliveryDate

The requested delivery date.

 date

None.
Pcs

The number of pieces.

 integer

None.
Weight

The gross weight.

 decimal number

None.
WeightType

The weight identifier ('kgs' or 'lbs' are the only valid values).

 string

String length: inclusive between 0 and 5
ChargeableWeight

The calculated chargeable weight of the shipment.

 decimal number

None.
Comments

Comments/instructions.

 string

String length: inclusive between 0 and 1000
CompletedBy

The name of the person/service making this booking.

 string

String length: inclusive between 0 and 50
DescriptionOfGoods

The full description of goods.

 string

String length: inclusive between 0 and 1000
CODAmount

The COD amount.

 decimal number

None.
Currency

The COD currency.

 string

String length: inclusive between 0 and 3
Insurance

Request insurance cover.

 integer

None.
InsuranceValue

If insurance has been selected please declare the insurance value.

 decimal number

None.
Carrier

The carrier name.

 string

String length: inclusive between 0 and 50
BOL

The BOL Number (applies to USA bookings only).

 string

String length: inclusive between 0 and 50
ServiceType

The requested service type.

 string

String length: inclusive between 0 and 50
BillingPartyName

The billing party name.

 string

String length: inclusive between 0 and 1000
BillingParty

The billing party (Third party, etc).

 string

String length: inclusive between 0 and 50
UnitOfMeasure

If the WeightType value is kgs please enter 'metric'. If the WeightType value is lbs please enter 'imperial'.

 string

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample: 
{
  "YourRef": "1234567890",
  "YourAcct": "Account#",
  "YourCompanyName": "Company Names Inc.",
  "ShipperRef": "ShipRef",
  "ShipperName": "Paradise Products",
  "ShipperContact": "Paul Richardson",
  "ShipperAddress": "Happy House, Easy Street, Nice Town, Goodshire",
  "ShipperPostcode": "TW6 3AA",
  "ShipperCountry": "GB",
  "ShipperPhone": "44 208 400 2000",
  "ShipperEmail": "paul@boxtop.net",
  "ConsigneeRef": "ConsRef",
  "ConsigneeName": "iSign Fordelivery",
  "ConsigneeContact": "Will Barrow",
  "ConsigneeAddress": "Delivery House, Parcel Street, Package Town",
  "ConsigneePostcode": "BT1 1BT",
  "ConsigneeCountry": "US",
  "ConsigneePhone": "0181 811 8181",
  "ConsigneeEmail": "paul@boxtop.net",
  "RequestedPickUpDate": "2014-08-11T00:00:00",
  "RequestedDeliveryDate": "2014-08-18T00:00:00",
  "Pcs": 2,
  "Weight": 454.0,
  "WeightType": "lbs",
  "ChargeableWeight": 1334.0,
  "Comments": "Please pick up goods as soon as possible for COD delivery.",
  "CompletedBy": "Ms Clicka Button",
  "DescriptionOfGoods": "Machinery Parts",
  "CODAmount": 9999.99,
  "Currency": "USD",
  "Insurance": -1,
  "InsuranceValue": 12345.0,
  "Carrier": "My Freight Forwarder",
  "BOL": "1234567890",
  "ServiceType": "Express",
  "BillingPartyName": "Paradise Products, Happy House, Easy Street, Nice Town, Goodshire",
  "BillingParty": "Shipper",
  "UnitOfMeasure": "Imperial"
}

application/xml, text/xml

Sample: 
<JobDataBooking xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <YourRef>1234567890</YourRef>
  <YourAcct>Account#</YourAcct>
  <YourCompanyName>Company Names Inc.</YourCompanyName>
  <ShipperRef>ShipRef</ShipperRef>
  <ShipperName>Paradise Products</ShipperName>
  <ShipperContact>Paul Richardson</ShipperContact>
  <ShipperAddress>Happy House, Easy Street, Nice Town, Goodshire</ShipperAddress>
  <ShipperPostcode>TW6 3AA</ShipperPostcode>
  <ShipperCountry>GB</ShipperCountry>
  <ShipperPhone>44 208 400 2000</ShipperPhone>
  <ShipperEmail>paul@boxtop.net</ShipperEmail>
  <ConsigneeRef>ConsRef</ConsigneeRef>
  <ConsigneeName>iSign Fordelivery</ConsigneeName>
  <ConsigneeContact>Will Barrow</ConsigneeContact>
  <ConsigneeAddress>Delivery House, Parcel Street, Package Town</ConsigneeAddress>
  <ConsigneePostcode>BT1 1BT</ConsigneePostcode>
  <ConsigneeCountry>US</ConsigneeCountry>
  <ConsigneePhone>0181 811 8181</ConsigneePhone>
  <ConsigneeEmail>paul@boxtop.net</ConsigneeEmail>
  <RequestedPickUpDate>2014-08-11T00:00:00</RequestedPickUpDate>
  <RequestedDeliveryDate>2014-08-18T00:00:00</RequestedDeliveryDate>
  <Pcs>2</Pcs>
  <Weight>454</Weight>
  <WeightType>lbs</WeightType>
  <ChargeableWeight>1334</ChargeableWeight>
  <Comments>Please pick up goods as soon as possible for COD delivery.</Comments>
  <CompletedBy>Ms Clicka Button</CompletedBy>
  <DescriptionOfGoods>Machinery Parts</DescriptionOfGoods>
  <CODAmount>9999.99</CODAmount>
  <Currency>USD</Currency>
  <Insurance>-1</Insurance>
  <InsuranceValue>12345.0000</InsuranceValue>
  <Carrier>My Freight Forwarder</Carrier>
  <BOL>1234567890</BOL>
  <ServiceType>Express</ServiceType>
  <BillingPartyName>Paradise Products, Happy House, Easy Street, Nice Town, Goodshire</BillingPartyName>
  <BillingParty>Shipper</BillingParty>
  <UnitOfMeasure>Imperial</UnitOfMeasure>
</JobDataBooking>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns HttpStatusCode and if successful the tracking number for the consignment booking or in the event of an error the reason for failure

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.