POST api/CustomsBroker
Request Information
URI Parameters
None.
Body Parameters
CustomsBrokerParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| CompanyName | string |
None. |
|
| AirportID | string |
None. |
|
| ShowDeleted | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"CompanyName": "sample string 2",
"AirportID": "sample string 3",
"ShowDeleted": true
}
application/xml, text/xml
Sample:
<CustomsBrokerParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <AirportID>sample string 3</AirportID> <CompanyName>sample string 2</CompanyName> <ShowDeleted>true</ShowDeleted> <auth>sample string 1</auth> </CustomsBrokerParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CustomsBrokerResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Items | Collection of CustomsBrokerItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"Items": [
{
"CustomsBrokerGUID": "sample string 1",
"CompanyID": 2,
"CompanyName": "sample string 3",
"Address1": "sample string 4",
"Address2": "sample string 5",
"Address3": "sample string 6",
"CityName": "sample string 7",
"StateProvID": "sample string 8",
"PostalCode": "sample string 9",
"CountryID": "sample string 10",
"AirportID": "sample string 11",
"PhoneNumber": "sample string 12",
"FaxNumber": "sample string 13",
"EmailAddress": "sample string 14",
"InsertUserGUID": "sample string 15",
"InsertDateTime": "2025-12-03T12:35:59.1242094+00:00",
"UpdateUserGUID": "sample string 17",
"UpdateDateTime": "2025-12-03T12:35:59.1242094+00:00",
"AmsSiteID": "sample string 18",
"AmsWaybillOriginator": "sample string 19"
},
{
"CustomsBrokerGUID": "sample string 1",
"CompanyID": 2,
"CompanyName": "sample string 3",
"Address1": "sample string 4",
"Address2": "sample string 5",
"Address3": "sample string 6",
"CityName": "sample string 7",
"StateProvID": "sample string 8",
"PostalCode": "sample string 9",
"CountryID": "sample string 10",
"AirportID": "sample string 11",
"PhoneNumber": "sample string 12",
"FaxNumber": "sample string 13",
"EmailAddress": "sample string 14",
"InsertUserGUID": "sample string 15",
"InsertDateTime": "2025-12-03T12:35:59.1242094+00:00",
"UpdateUserGUID": "sample string 17",
"UpdateDateTime": "2025-12-03T12:35:59.1242094+00:00",
"AmsSiteID": "sample string 18",
"AmsWaybillOriginator": "sample string 19"
}
]
}
application/xml, text/xml
Sample:
<CustomsBrokerResp 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>
<CustomsBrokerItem>
<Address1>sample string 4</Address1>
<Address2>sample string 5</Address2>
<Address3>sample string 6</Address3>
<AirportID>sample string 11</AirportID>
<AmsSiteID>sample string 18</AmsSiteID>
<AmsWaybillOriginator>sample string 19</AmsWaybillOriginator>
<CityName>sample string 7</CityName>
<CompanyID>2</CompanyID>
<CompanyName>sample string 3</CompanyName>
<CountryID>sample string 10</CountryID>
<CustomsBrokerGUID>sample string 1</CustomsBrokerGUID>
<EmailAddress>sample string 14</EmailAddress>
<FaxNumber>sample string 13</FaxNumber>
<InsertDateTime>2025-12-03T12:35:59.1242094+00:00</InsertDateTime>
<InsertUserGUID>sample string 15</InsertUserGUID>
<PhoneNumber>sample string 12</PhoneNumber>
<PostalCode>sample string 9</PostalCode>
<StateProvID>sample string 8</StateProvID>
<UpdateDateTime>2025-12-03T12:35:59.1242094+00:00</UpdateDateTime>
<UpdateUserGUID>sample string 17</UpdateUserGUID>
</CustomsBrokerItem>
<CustomsBrokerItem>
<Address1>sample string 4</Address1>
<Address2>sample string 5</Address2>
<Address3>sample string 6</Address3>
<AirportID>sample string 11</AirportID>
<AmsSiteID>sample string 18</AmsSiteID>
<AmsWaybillOriginator>sample string 19</AmsWaybillOriginator>
<CityName>sample string 7</CityName>
<CompanyID>2</CompanyID>
<CompanyName>sample string 3</CompanyName>
<CountryID>sample string 10</CountryID>
<CustomsBrokerGUID>sample string 1</CustomsBrokerGUID>
<EmailAddress>sample string 14</EmailAddress>
<FaxNumber>sample string 13</FaxNumber>
<InsertDateTime>2025-12-03T12:35:59.1242094+00:00</InsertDateTime>
<InsertUserGUID>sample string 15</InsertUserGUID>
<PhoneNumber>sample string 12</PhoneNumber>
<PostalCode>sample string 9</PostalCode>
<StateProvID>sample string 8</StateProvID>
<UpdateDateTime>2025-12-03T12:35:59.1242094+00:00</UpdateDateTime>
<UpdateUserGUID>sample string 17</UpdateUserGUID>
</CustomsBrokerItem>
</Items>
</CustomsBrokerResp>