POST Cargo/PickupLocation

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
supplierName		string	None.
keyword		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",
  "keyword": "sample string 2",
  "userID": "sample string 3",
  "accessToken": "sample string 4"
}

application/xml, text/xml

Sample:

<CargoPickupLocationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 4</accessToken>
  <userID>sample string 3</userID>
  <keyword>sample string 2</keyword>
  <supplierName>sample string 1</supplierName>
</CargoPickupLocationRequest>

Response Information

Resource Description

CargoPickupLocationResponse

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

{
  "pickupLocations": [
    {
      "locationID": "sample string 1",
      "locationName": "sample string 2",
      "provinceID": "sample string 3",
      "provinceName": "sample string 4",
      "cityID": "sample string 5",
      "cityName": "sample string 6"
    },
    {
      "locationID": "sample string 1",
      "locationName": "sample string 2",
      "provinceID": "sample string 3",
      "provinceName": "sample string 4",
      "cityID": "sample string 5",
      "cityName": "sample string 6"
    }
  ],
  "respTime": "2025-01-23T00:00:57.4141209+07:00",
  "userID": "sample string 2",
  "accessToken": "sample string 3",
  "status": "sample string 4",
  "respMessage": "sample string 5"
}

application/xml, text/xml

Sample:

<CargoPickupLocationResponse 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:00:57.4141209+07:00</respTime>
  <status>sample string 4</status>
  <userID>sample string 2</userID>
  <pickupLocations>
    <CargoPickupLocationModel>
      <cityID>sample string 5</cityID>
      <cityName>sample string 6</cityName>
      <locationID>sample string 1</locationID>
      <locationName>sample string 2</locationName>
      <provinceID>sample string 3</provinceID>
      <provinceName>sample string 4</provinceName>
    </CargoPickupLocationModel>
    <CargoPickupLocationModel>
      <cityID>sample string 5</cityID>
      <cityName>sample string 6</cityName>
      <locationID>sample string 1</locationID>
      <locationName>sample string 2</locationName>
      <provinceID>sample string 3</provinceID>
      <provinceName>sample string 4</provinceName>
    </CargoPickupLocationModel>
  </pickupLocations>
</CargoPickupLocationResponse>