GET api/Commodity/{auth}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
Required |
Body Parameters
None.
Response Information
Resource Description
CommodityResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Items | Collection of CommodityItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"Items": [
{
"CommodityGUID": "sample string 1",
"CompanyID": 2,
"ProperName": "sample string 3",
"Instructions": "sample string 4",
"UNNumber": "sample string 5",
"IsDangerousGoods": true,
"CommodityClass": "sample string 7",
"CommoditySource": "sample string 8",
"LegacyID": "sample string 9",
"LegacyType": "sample string 10",
"LegacyChargeCode": "sample string 11",
"InsertUserGUID": "sample string 12",
"InsertDateTime": "2025-12-03T11:31:38.8236681+00:00",
"UpdateUserGUID": "sample string 14",
"UpdateDateTime": "2025-12-03T11:31:38.8236681+00:00",
"IsRadioactive": true
},
{
"CommodityGUID": "sample string 1",
"CompanyID": 2,
"ProperName": "sample string 3",
"Instructions": "sample string 4",
"UNNumber": "sample string 5",
"IsDangerousGoods": true,
"CommodityClass": "sample string 7",
"CommoditySource": "sample string 8",
"LegacyID": "sample string 9",
"LegacyType": "sample string 10",
"LegacyChargeCode": "sample string 11",
"InsertUserGUID": "sample string 12",
"InsertDateTime": "2025-12-03T11:31:38.8236681+00:00",
"UpdateUserGUID": "sample string 14",
"UpdateDateTime": "2025-12-03T11:31:38.8236681+00:00",
"IsRadioactive": true
}
]
}
application/xml, text/xml
Sample:
<CommodityResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
<ErrorMessage>sample string 2</ErrorMessage>
<IsSuccessful>true</IsSuccessful>
<Items>
<CommodityItem>
<CommodityClass>sample string 7</CommodityClass>
<CommodityGUID>sample string 1</CommodityGUID>
<CommoditySource>sample string 8</CommoditySource>
<CompanyID>2</CompanyID>
<InsertDateTime>2025-12-03T11:31:38.8236681+00:00</InsertDateTime>
<InsertUserGUID>sample string 12</InsertUserGUID>
<Instructions>sample string 4</Instructions>
<IsDangerousGoods>true</IsDangerousGoods>
<IsRadioactive>true</IsRadioactive>
<LegacyChargeCode>sample string 11</LegacyChargeCode>
<LegacyID>sample string 9</LegacyID>
<LegacyType>sample string 10</LegacyType>
<ProperName>sample string 3</ProperName>
<UNNumber>sample string 5</UNNumber>
<UpdateDateTime>2025-12-03T11:31:38.8236681+00:00</UpdateDateTime>
<UpdateUserGUID>sample string 14</UpdateUserGUID>
</CommodityItem>
<CommodityItem>
<CommodityClass>sample string 7</CommodityClass>
<CommodityGUID>sample string 1</CommodityGUID>
<CommoditySource>sample string 8</CommoditySource>
<CompanyID>2</CompanyID>
<InsertDateTime>2025-12-03T11:31:38.8236681+00:00</InsertDateTime>
<InsertUserGUID>sample string 12</InsertUserGUID>
<Instructions>sample string 4</Instructions>
<IsDangerousGoods>true</IsDangerousGoods>
<IsRadioactive>true</IsRadioactive>
<LegacyChargeCode>sample string 11</LegacyChargeCode>
<LegacyID>sample string 9</LegacyID>
<LegacyType>sample string 10</LegacyType>
<ProperName>sample string 3</ProperName>
<UNNumber>sample string 5</UNNumber>
<UpdateDateTime>2025-12-03T11:31:38.8236681+00:00</UpdateDateTime>
<UpdateUserGUID>sample string 14</UpdateUserGUID>
</CommodityItem>
</Items>
</CommodityResp>