POST Cargo/PriceDetail
Request Information
URI Parameters
None.
Body Parameters
CargoPriceDetailRequestName | Description | Type | Additional information |
---|---|---|---|
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:
{ "supplierName": "sample string 1", "pickupLocationID": "sample string 2", "destinationAreaID": "sample string 3", "shipmentID": "sample string 4", "serviceID": "sample string 5", "isUseInsurance": true, "goodsValue": 7.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 8", "accessToken": "sample string 9" }
application/xml, text/xml
Sample:
<CargoPriceDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 9</accessToken> <userID>sample string 8</userID> <destinationAreaID>sample string 3</destinationAreaID> <goodsValue>7</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 2</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 5</serviceID> <shipmentID>sample string 4</shipmentID> <supplierName>sample string 1</supplierName> </CargoPriceDetailRequest>
Response Information
Resource Description
CargoPriceDetailResponseName | Description | Type | Additional information |
---|---|---|---|
memberMarkup | decimal number |
None. |
|
salesPrice | decimal number |
None. |
|
totalPrice | decimal number |
None. |
|
chargeableWeight | decimal number |
None. |
|
volumeWeight | decimal number |
None. |
|
grossWeight | decimal number |
None. |
|
publishRate | decimal number |
None. |
|
totalPriceNoSurchargeNoTax | decimal number |
None. |
|
insuranceSurcharge | decimal number |
None. |
|
specialHandlingSurcharge | decimal number |
None. |
|
addCostSurcharge | decimal number |
None. |
|
tax | decimal number |
None. |
|
pieces | Collection of CargoPiecesBookingRespModel |
None. |
|
handlingSurcharges | Collection of CargoHandlingSurchargeBookingRespModel |
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:
{ "memberMarkup": 1.0, "salesPrice": 2.0, "totalPrice": 3.0, "chargeableWeight": 4.0, "volumeWeight": 5.0, "grossWeight": 6.0, "publishRate": 7.0, "totalPriceNoSurchargeNoTax": 8.0, "insuranceSurcharge": 9.0, "specialHandlingSurcharge": 10.0, "addCostSurcharge": 11.0, "tax": 12.0, "pieces": [ { "addCost1Value": 1.0, "addCost2Value": 2.0, "addCostID1": "sample string 3", "addCostID2": "sample string 4", "packagingID": "sample string 5", "length": 6.0, "width": 7.0, "height": 8.0, "grossWeight": 9.0 }, { "addCost1Value": 1.0, "addCost2Value": 2.0, "addCostID1": "sample string 3", "addCostID2": "sample string 4", "packagingID": "sample string 5", "length": 6.0, "width": 7.0, "height": 8.0, "grossWeight": 9.0 } ], "handlingSurcharges": [ { "handlingSurchargeValue": 1.0, "handlingSurchargeID": "sample string 2", "remark": "sample string 3" }, { "handlingSurchargeValue": 1.0, "handlingSurchargeID": "sample string 2", "remark": "sample string 3" } ], "respTime": "2025-01-22T23:50:59.4815342+07:00", "userID": "sample string 14", "accessToken": "sample string 15", "status": "sample string 16", "respMessage": "sample string 17" }
application/xml, text/xml
Sample:
<CargoPriceDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 15</accessToken> <respMessage>sample string 17</respMessage> <respTime>2025-01-22T23:50:59.4815342+07:00</respTime> <status>sample string 16</status> <userID>sample string 14</userID> <addCostSurcharge>11</addCostSurcharge> <chargeableWeight>4</chargeableWeight> <grossWeight>6</grossWeight> <handlingSurcharges> <CargoHandlingSurchargeBookingRespModel> <handlingSurchargeID>sample string 2</handlingSurchargeID> <remark>sample string 3</remark> <handlingSurchargeValue>1</handlingSurchargeValue> </CargoHandlingSurchargeBookingRespModel> <CargoHandlingSurchargeBookingRespModel> <handlingSurchargeID>sample string 2</handlingSurchargeID> <remark>sample string 3</remark> <handlingSurchargeValue>1</handlingSurchargeValue> </CargoHandlingSurchargeBookingRespModel> </handlingSurcharges> <insuranceSurcharge>9</insuranceSurcharge> <memberMarkup>1</memberMarkup> <pieces> <CargoPiecesBookingRespModel> <grossWeight>9</grossWeight> <height>8</height> <length>6</length> <width>7</width> <addCostID1>sample string 3</addCostID1> <addCostID2>sample string 4</addCostID2> <packagingID>sample string 5</packagingID> <addCost1Value>1</addCost1Value> <addCost2Value>2</addCost2Value> </CargoPiecesBookingRespModel> <CargoPiecesBookingRespModel> <grossWeight>9</grossWeight> <height>8</height> <length>6</length> <width>7</width> <addCostID1>sample string 3</addCostID1> <addCostID2>sample string 4</addCostID2> <packagingID>sample string 5</packagingID> <addCost1Value>1</addCost1Value> <addCost2Value>2</addCost2Value> </CargoPiecesBookingRespModel> </pieces> <publishRate>7</publishRate> <salesPrice>2</salesPrice> <specialHandlingSurcharge>10</specialHandlingSurcharge> <tax>12</tax> <totalPrice>3</totalPrice> <totalPriceNoSurchargeNoTax>8</totalPriceNoSurchargeNoTax> <volumeWeight>5</volumeWeight> </CargoPriceDetailResponse>