POST Cargo/Booking

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
contentID		string	None.
goodsID		string	None.
handlingID		string	None.
description		string	None.
instruction		string	None.
pickupName		string	None.
pickupAddress		string	None.
pickupPhone		string	None.
pickupEmail		string	None.
pickupZip		string	None.
pickupDistrict		string	None.
pickupCity		string	None.
pickupProvince		string	None.
receiverName		string	None.
receiverAddress		string	None.
receiverPhone		string	None.
receiverEmail		string	None.
receiverTitle		string	None.
receiverDistrict		string	None.
receiverCity		string	None.
receiverProvince		string	None.
receiverZip		string	None.
references		Collection of CargoReferenceBookingModel	None.
supplierName		string	None.
pickupLocationID		string	None.
destinationAreaID		string	None.
shipmentID		string	None.
serviceID		string	None.
isUseInsurance		boolean	None.
goodsValue		decimal number	None.
pieces		Collection of CargoPiecesBookingModel	None.
handlingSurcharges		Collection of CargoHandlingSurchargeBookingModel	None.
userID	user API	string	None.
accessToken	access code getting from login	string	None.

Request Formats

application/json, text/json

Sample:

{
  "contentID": "sample string 1",
  "goodsID": "sample string 2",
  "handlingID": "sample string 3",
  "description": "sample string 4",
  "instruction": "sample string 5",
  "pickupName": "sample string 6",
  "pickupAddress": "sample string 7",
  "pickupPhone": "sample string 8",
  "pickupEmail": "sample string 9",
  "pickupZip": "sample string 10",
  "pickupDistrict": "sample string 11",
  "pickupCity": "sample string 12",
  "pickupProvince": "sample string 13",
  "receiverName": "sample string 14",
  "receiverAddress": "sample string 15",
  "receiverPhone": "sample string 16",
  "receiverEmail": "sample string 17",
  "receiverTitle": "sample string 18",
  "receiverDistrict": "sample string 19",
  "receiverCity": "sample string 20",
  "receiverProvince": "sample string 21",
  "receiverZip": "sample string 22",
  "references": [
    {
      "referenceID": "sample string 1",
      "referenceNo": "sample string 2"
    },
    {
      "referenceID": "sample string 1",
      "referenceNo": "sample string 2"
    }
  ],
  "supplierName": "sample string 23",
  "pickupLocationID": "sample string 24",
  "destinationAreaID": "sample string 25",
  "shipmentID": "sample string 26",
  "serviceID": "sample string 27",
  "isUseInsurance": true,
  "goodsValue": 29.0,
  "pieces": [
    {
      "addCostID1": "sample string 1",
      "addCostID2": "sample string 2",
      "packagingID": "sample string 3",
      "length": 4.0,
      "width": 5.0,
      "height": 6.0,
      "grossWeight": 7.0
    },
    {
      "addCostID1": "sample string 1",
      "addCostID2": "sample string 2",
      "packagingID": "sample string 3",
      "length": 4.0,
      "width": 5.0,
      "height": 6.0,
      "grossWeight": 7.0
    }
  ],
  "handlingSurcharges": [
    {
      "handlingSurchargeID": "sample string 1",
      "remark": "sample string 2"
    },
    {
      "handlingSurchargeID": "sample string 1",
      "remark": "sample string 2"
    }
  ],
  "userID": "sample string 30",
  "accessToken": "sample string 31"
}

application/xml, text/xml

Sample:

<CargoBookingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 31</accessToken>
  <userID>sample string 30</userID>
  <destinationAreaID>sample string 25</destinationAreaID>
  <goodsValue>29</goodsValue>
  <handlingSurcharges>
    <CargoHandlingSurchargeBookingModel>
      <handlingSurchargeID>sample string 1</handlingSurchargeID>
      <remark>sample string 2</remark>
    </CargoHandlingSurchargeBookingModel>
    <CargoHandlingSurchargeBookingModel>
      <handlingSurchargeID>sample string 1</handlingSurchargeID>
      <remark>sample string 2</remark>
    </CargoHandlingSurchargeBookingModel>
  </handlingSurcharges>
  <isUseInsurance>true</isUseInsurance>
  <pickupLocationID>sample string 24</pickupLocationID>
  <pieces>
    <CargoPiecesBookingModel>
      <grossWeight>7</grossWeight>
      <height>6</height>
      <length>4</length>
      <width>5</width>
      <addCostID1>sample string 1</addCostID1>
      <addCostID2>sample string 2</addCostID2>
      <packagingID>sample string 3</packagingID>
    </CargoPiecesBookingModel>
    <CargoPiecesBookingModel>
      <grossWeight>7</grossWeight>
      <height>6</height>
      <length>4</length>
      <width>5</width>
      <addCostID1>sample string 1</addCostID1>
      <addCostID2>sample string 2</addCostID2>
      <packagingID>sample string 3</packagingID>
    </CargoPiecesBookingModel>
  </pieces>
  <serviceID>sample string 27</serviceID>
  <shipmentID>sample string 26</shipmentID>
  <supplierName>sample string 23</supplierName>
  <contentID>sample string 1</contentID>
  <description>sample string 4</description>
  <goodsID>sample string 2</goodsID>
  <handlingID>sample string 3</handlingID>
  <instruction>sample string 5</instruction>
  <pickupAddress>sample string 7</pickupAddress>
  <pickupCity>sample string 12</pickupCity>
  <pickupDistrict>sample string 11</pickupDistrict>
  <pickupEmail>sample string 9</pickupEmail>
  <pickupName>sample string 6</pickupName>
  <pickupPhone>sample string 8</pickupPhone>
  <pickupProvince>sample string 13</pickupProvince>
  <pickupZip>sample string 10</pickupZip>
  <receiverAddress>sample string 15</receiverAddress>
  <receiverCity>sample string 20</receiverCity>
  <receiverDistrict>sample string 19</receiverDistrict>
  <receiverEmail>sample string 17</receiverEmail>
  <receiverName>sample string 14</receiverName>
  <receiverPhone>sample string 16</receiverPhone>
  <receiverProvince>sample string 21</receiverProvince>
  <receiverTitle>sample string 18</receiverTitle>
  <receiverZip>sample string 22</receiverZip>
  <references>
    <CargoReferenceBookingModel>
      <referenceID>sample string 1</referenceID>
      <referenceNo>sample string 2</referenceNo>
    </CargoReferenceBookingModel>
    <CargoReferenceBookingModel>
      <referenceID>sample string 1</referenceID>
      <referenceNo>sample string 2</referenceNo>
    </CargoReferenceBookingModel>
  </references>
</CargoBookingRequest>

Response Information

Resource Description

CargoBookingResponse

Name	Description	Type	Additional information
supplierName		string	None.
sttNumber		string	None.
orderID		string	None.
totalPrice		decimal number	None.
memberMarkup		decimal number	None.
salesPrice		decimal number	None.
bookingStatus		string	None.
respTime	describe time in sending response	date	None.
userID	user ID to access API	string	None.
accessToken	access token that needed to access API	string	None.
status	SUCCESS or FAILED	string	None.
respMessage	detail message of response status	string	None.

Response Formats

application/json, text/json

Sample:

{
  "supplierName": "sample string 1",
  "sttNumber": "sample string 2",
  "orderID": "sample string 3",
  "totalPrice": 4.0,
  "memberMarkup": 5.0,
  "salesPrice": 6.0,
  "bookingStatus": "sample string 7",
  "respTime": "2025-01-22T23:56:35.0907047+07:00",
  "userID": "sample string 9",
  "accessToken": "sample string 10",
  "status": "sample string 11",
  "respMessage": "sample string 12"
}

application/xml, text/xml

Sample:

<CargoBookingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 10</accessToken>
  <respMessage>sample string 12</respMessage>
  <respTime>2025-01-22T23:56:35.0907047+07:00</respTime>
  <status>sample string 11</status>
  <userID>sample string 9</userID>
  <bookingStatus>sample string 7</bookingStatus>
  <memberMarkup>5</memberMarkup>
  <orderID>sample string 3</orderID>
  <salesPrice>6</salesPrice>
  <sttNumber>sample string 2</sttNumber>
  <supplierName>sample string 1</supplierName>
  <totalPrice>4</totalPrice>
</CargoBookingResponse>