POST api/Waybill/ValidateWaybillRequest?MerchantID={MerchantID}&serverName={serverName}

Request Information

URI Parameters

Name	Description	Type	Additional information
MerchantID		integer	Required
serverName		string	Required

Body Parameters

BookingRequest

Name	Type	Additional information
OperatorContactNumber	string	None.
serviceType	string	None.
trackingNumber	string	None.
referenceNumber1	string	None.
referenceNumber2	string	None.
referenceNumber3	string	None.
referenceNumber4	string	None.
referenceNumber5	string	None.
pickupDate	date	None.
expectedDeliveryDate	date	None.
paymentMethod	string	None.
codAmount	decimal number	None.
declaredValue	decimal number	None.
quantity	decimal number	None.
shipperCode	string	None.
shipperName	string	None.
shipperAddress	string	None.
shipperCountry	string	None.
shipperAddress1	string	None.
shipperAddress2	string	None.
shipperAddress3	string	None.
shipperAddress4	string	None.
shipperPostal	string	None.
shipperContact	string	None.
shipperEmail	string	None.
shipperLongitude	string	None.
shipperLatitude	string	None.
consigneeName	string	None.
consigneeAddress	string	None.
consigneeCountry	string	None.
consigneeAddress1	string	None.
consigneeAddress2	string	None.
consigneeAddress3	string	None.
consigneeAddress4	string	None.
consigneePostal	string	None.
consigneeContact	string	None.
consigneeEmail	string	None.
consigneeLongitude	string	None.
consigneeLatitude	string	None.
returnName	string	None.
returnAddress	string	None.
returnCountry	string	None.
returnAddress1	string	None.
returnAddress2	string	None.
returnAddress3	string	None.
returnAddress4	string	None.
returnPostal	string	None.
returnContact	string	None.
returnEmail	string	None.
returnLongitude	string	None.
returnLatitude	string	None.
itemDescription	string	None.
handlingInstructions	string	None.
merchantName	string	None.
packageType	string	None.
packageLength	decimal number	None.
packageWidth	decimal number	None.
packageHeight	decimal number	None.
packageWeight	decimal number	None.
Packagevolume	decimal number	None.
warehouseName	string	None.
childWaybills	Collection of BookingRequestWaybillItems	None.

Request Formats

application/json, text/json

Sample:

{
  "OperatorContactNumber": "sample string 1",
  "serviceType": "sample string 2",
  "trackingNumber": "sample string 3",
  "referenceNumber1": "sample string 4",
  "referenceNumber2": "sample string 5",
  "referenceNumber3": "sample string 6",
  "referenceNumber4": "sample string 7",
  "referenceNumber5": "sample string 8",
  "pickupDate": "2025-06-24T20:44:13.7374443+08:00",
  "expectedDeliveryDate": "2025-06-24T20:44:13.7374443+08:00",
  "paymentMethod": "sample string 10",
  "codAmount": 1.0,
  "declaredValue": 1.0,
  "quantity": 1.0,
  "shipperCode": "sample string 11",
  "shipperName": "sample string 12",
  "shipperAddress": "sample string 13",
  "shipperCountry": "sample string 14",
  "shipperAddress1": "sample string 15",
  "shipperAddress2": "sample string 16",
  "shipperAddress3": "sample string 17",
  "shipperAddress4": "sample string 18",
  "shipperPostal": "sample string 19",
  "shipperContact": "sample string 20",
  "shipperEmail": "sample string 21",
  "shipperLongitude": "sample string 22",
  "shipperLatitude": "sample string 23",
  "consigneeName": "sample string 24",
  "consigneeAddress": "sample string 25",
  "consigneeCountry": "sample string 26",
  "consigneeAddress1": "sample string 27",
  "consigneeAddress2": "sample string 28",
  "consigneeAddress3": "sample string 29",
  "consigneeAddress4": "sample string 30",
  "consigneePostal": "sample string 31",
  "consigneeContact": "sample string 32",
  "consigneeEmail": "sample string 33",
  "consigneeLongitude": "sample string 34",
  "consigneeLatitude": "sample string 35",
  "returnName": "sample string 36",
  "returnAddress": "sample string 37",
  "returnCountry": "sample string 38",
  "returnAddress1": "sample string 39",
  "returnAddress2": "sample string 40",
  "returnAddress3": "sample string 41",
  "returnAddress4": "sample string 42",
  "returnPostal": "sample string 43",
  "returnContact": "sample string 44",
  "returnEmail": "sample string 45",
  "returnLongitude": "sample string 46",
  "returnLatitude": "sample string 47",
  "itemDescription": "sample string 48",
  "handlingInstructions": "sample string 49",
  "merchantName": "sample string 50",
  "packageType": "sample string 51",
  "packageLength": 1.0,
  "packageWidth": 1.0,
  "packageHeight": 1.0,
  "packageWeight": 1.0,
  "Packagevolume": 1.0,
  "warehouseName": "sample string 52",
  "childWaybills": [
    {
      "trackingNumber": "sample string 1",
      "packageType": "sample string 2",
      "itemDescription": "sample string 3",
      "remarks": "sample string 4",
      "quantity": 1,
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0,
      "uom": "sample string 5",
      "declaredValue": 1.0,
      "itemTrackingNumber": "sample string 6",
      "status": "sample string 7",
      "warehouse": "sample string 8",
      "commodity": "sample string 9",
      "toBeRemoved": "sample string 10"
    },
    {
      "trackingNumber": "sample string 1",
      "packageType": "sample string 2",
      "itemDescription": "sample string 3",
      "remarks": "sample string 4",
      "quantity": 1,
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0,
      "uom": "sample string 5",
      "declaredValue": 1.0,
      "itemTrackingNumber": "sample string 6",
      "status": "sample string 7",
      "warehouse": "sample string 8",
      "commodity": "sample string 9",
      "toBeRemoved": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:

<BookingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RiderX_Open_API.App_Data">
  <OperatorContactNumber>sample string 1</OperatorContactNumber>
  <Packagevolume>1</Packagevolume>
  <childWaybills>
    <BookingRequestWaybillItems>
      <commodity>sample string 9</commodity>
      <declaredValue>1</declaredValue>
      <height>1</height>
      <itemDescription>sample string 3</itemDescription>
      <itemTrackingNumber>sample string 6</itemTrackingNumber>
      <length>1</length>
      <packageType>sample string 2</packageType>
      <quantity>1</quantity>
      <remarks>sample string 4</remarks>
      <status>sample string 7</status>
      <toBeRemoved>sample string 10</toBeRemoved>
      <trackingNumber>sample string 1</trackingNumber>
      <uom>sample string 5</uom>
      <warehouse>sample string 8</warehouse>
      <weight>1</weight>
      <width>1</width>
    </BookingRequestWaybillItems>
    <BookingRequestWaybillItems>
      <commodity>sample string 9</commodity>
      <declaredValue>1</declaredValue>
      <height>1</height>
      <itemDescription>sample string 3</itemDescription>
      <itemTrackingNumber>sample string 6</itemTrackingNumber>
      <length>1</length>
      <packageType>sample string 2</packageType>
      <quantity>1</quantity>
      <remarks>sample string 4</remarks>
      <status>sample string 7</status>
      <toBeRemoved>sample string 10</toBeRemoved>
      <trackingNumber>sample string 1</trackingNumber>
      <uom>sample string 5</uom>
      <warehouse>sample string 8</warehouse>
      <weight>1</weight>
      <width>1</width>
    </BookingRequestWaybillItems>
  </childWaybills>
  <codAmount>1</codAmount>
  <consigneeAddress>sample string 25</consigneeAddress>
  <consigneeAddress1>sample string 27</consigneeAddress1>
  <consigneeAddress2>sample string 28</consigneeAddress2>
  <consigneeAddress3>sample string 29</consigneeAddress3>
  <consigneeAddress4>sample string 30</consigneeAddress4>
  <consigneeContact>sample string 32</consigneeContact>
  <consigneeCountry>sample string 26</consigneeCountry>
  <consigneeEmail>sample string 33</consigneeEmail>
  <consigneeLatitude>sample string 35</consigneeLatitude>
  <consigneeLongitude>sample string 34</consigneeLongitude>
  <consigneeName>sample string 24</consigneeName>
  <consigneePostal>sample string 31</consigneePostal>
  <declaredValue>1</declaredValue>
  <expectedDeliveryDate>2025-06-24T20:44:13.7374443+08:00</expectedDeliveryDate>
  <handlingInstructions>sample string 49</handlingInstructions>
  <itemDescription>sample string 48</itemDescription>
  <merchantName>sample string 50</merchantName>
  <packageHeight>1</packageHeight>
  <packageLength>1</packageLength>
  <packageType>sample string 51</packageType>
  <packageWeight>1</packageWeight>
  <packageWidth>1</packageWidth>
  <paymentMethod>sample string 10</paymentMethod>
  <pickupDate>2025-06-24T20:44:13.7374443+08:00</pickupDate>
  <quantity>1</quantity>
  <referenceNumber1>sample string 4</referenceNumber1>
  <referenceNumber2>sample string 5</referenceNumber2>
  <referenceNumber3>sample string 6</referenceNumber3>
  <referenceNumber4>sample string 7</referenceNumber4>
  <referenceNumber5>sample string 8</referenceNumber5>
  <returnAddress>sample string 37</returnAddress>
  <returnAddress1>sample string 39</returnAddress1>
  <returnAddress2>sample string 40</returnAddress2>
  <returnAddress3>sample string 41</returnAddress3>
  <returnAddress4>sample string 42</returnAddress4>
  <returnContact>sample string 44</returnContact>
  <returnCountry>sample string 38</returnCountry>
  <returnEmail>sample string 45</returnEmail>
  <returnLatitude>sample string 47</returnLatitude>
  <returnLongitude>sample string 46</returnLongitude>
  <returnName>sample string 36</returnName>
  <returnPostal>sample string 43</returnPostal>
  <serviceType>sample string 2</serviceType>
  <shipperAddress>sample string 13</shipperAddress>
  <shipperAddress1>sample string 15</shipperAddress1>
  <shipperAddress2>sample string 16</shipperAddress2>
  <shipperAddress3>sample string 17</shipperAddress3>
  <shipperAddress4>sample string 18</shipperAddress4>
  <shipperCode>sample string 11</shipperCode>
  <shipperContact>sample string 20</shipperContact>
  <shipperCountry>sample string 14</shipperCountry>
  <shipperEmail>sample string 21</shipperEmail>
  <shipperLatitude>sample string 23</shipperLatitude>
  <shipperLongitude>sample string 22</shipperLongitude>
  <shipperName>sample string 12</shipperName>
  <shipperPostal>sample string 19</shipperPostal>
  <trackingNumber>sample string 3</trackingNumber>
  <warehouseName>sample string 52</warehouseName>
</BookingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

bookingFailedReturn

Name	Description	Type	Additional information
ErrorCode		string	None.
Remarks		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "sample string 1",
  "Remarks": "sample string 2"
}

application/xml, text/xml

Sample:

<bookingFailedReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RiderX_Open_API.App_Data">
  <ErrorCode>sample string 1</ErrorCode>
  <Remarks>sample string 2</Remarks>
</bookingFailedReturn>