POST Cargo/Tariff

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
supplierName		string	None.
pickupLocationID		string	None.
destinationAreaID		string	None.
pieces		Collection of CargoPiecesModel	None.
packagingID		string	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",
  "pieces": [
    {
      "length": 1.0,
      "width": 2.0,
      "height": 3.0,
      "grossWeight": 4.0
    },
    {
      "length": 1.0,
      "width": 2.0,
      "height": 3.0,
      "grossWeight": 4.0
    }
  ],
  "packagingID": "sample string 4",
  "userID": "sample string 5",
  "accessToken": "sample string 6"
}

application/xml, text/xml

Sample:

<CargoTariffRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 6</accessToken>
  <userID>sample string 5</userID>
  <destinationAreaID>sample string 3</destinationAreaID>
  <packagingID>sample string 4</packagingID>
  <pickupLocationID>sample string 2</pickupLocationID>
  <pieces>
    <CargoPiecesModel>
      <grossWeight>4</grossWeight>
      <height>3</height>
      <length>1</length>
      <width>2</width>
    </CargoPiecesModel>
    <CargoPiecesModel>
      <grossWeight>4</grossWeight>
      <height>3</height>
      <length>1</length>
      <width>2</width>
    </CargoPiecesModel>
  </pieces>
  <supplierName>sample string 1</supplierName>
</CargoTariffRequest>

Response Information

Resource Description

CargoTariffResponse

Name	Description	Type	Additional information
tariffs		Collection of CargoTariffModel	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:

{
  "tariffs": [
    {
      "grossWeight": 1.0,
      "volumeWeight": 2.0,
      "chargeableWeight": 3.0,
      "publishRate": 4.0,
      "totalTariff": 5.0,
      "minKg": 6,
      "priceNextKg": 7.0,
      "leadTime": 8,
      "serviceID": "sample string 9",
      "serviceName": "sample string 10",
      "shipmentTypeID": "sample string 11",
      "shipmentTypeName": "sample string 12"
    },
    {
      "grossWeight": 1.0,
      "volumeWeight": 2.0,
      "chargeableWeight": 3.0,
      "publishRate": 4.0,
      "totalTariff": 5.0,
      "minKg": 6,
      "priceNextKg": 7.0,
      "leadTime": 8,
      "serviceID": "sample string 9",
      "serviceName": "sample string 10",
      "shipmentTypeID": "sample string 11",
      "shipmentTypeName": "sample string 12"
    }
  ],
  "respTime": "2025-01-23T00:05:11.341464+07:00",
  "userID": "sample string 2",
  "accessToken": "sample string 3",
  "status": "sample string 4",
  "respMessage": "sample string 5"
}

application/xml, text/xml

Sample:

<CargoTariffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 3</accessToken>
  <respMessage>sample string 5</respMessage>
  <respTime>2025-01-23T00:05:11.341464+07:00</respTime>
  <status>sample string 4</status>
  <userID>sample string 2</userID>
  <tariffs>
    <CargoTariffModel>
      <chargeableWeight>3</chargeableWeight>
      <grossWeight>1</grossWeight>
      <leadTime>8</leadTime>
      <minKg>6</minKg>
      <priceNextKg>7</priceNextKg>
      <publishRate>4</publishRate>
      <serviceID>sample string 9</serviceID>
      <serviceName>sample string 10</serviceName>
      <shipmentTypeID>sample string 11</shipmentTypeID>
      <shipmentTypeName>sample string 12</shipmentTypeName>
      <totalTariff>5</totalTariff>
      <volumeWeight>2</volumeWeight>
    </CargoTariffModel>
    <CargoTariffModel>
      <chargeableWeight>3</chargeableWeight>
      <grossWeight>1</grossWeight>
      <leadTime>8</leadTime>
      <minKg>6</minKg>
      <priceNextKg>7</priceNextKg>
      <publishRate>4</publishRate>
      <serviceID>sample string 9</serviceID>
      <serviceName>sample string 10</serviceName>
      <shipmentTypeID>sample string 11</shipmentTypeID>
      <shipmentTypeName>sample string 12</shipmentTypeName>
      <totalTariff>5</totalTariff>
      <volumeWeight>2</volumeWeight>
    </CargoTariffModel>
  </tariffs>
</CargoTariffResponse>