GetShipmentsXML
POST https://api.techlogistics.com/?v=1.1
This function will retrive all the shipments in the system for a specific customer.
HEADERS**
Content-Type
application/xml
Accept
application/xml
BODY
raw
Request Structure
Title | Type | Required | Multiple Allowed |
---|---|---|---|
GetRatingEngineQuote | Parent Node | Yes | No |
Customer | Child Node | Yes | No |
request | Child Node | Yes | Yes |
Customer
Title | Description | Type | Required | Multiple Allowed |
---|---|---|---|---|
Username | Username | Email Address | Yes | No |
ApiKey | Api Key | String | Yes | No |
locationCode | Parent/Child Location Code | String Endpoint: GetLocations | No | No |
request
Title | Description | Type | Required | Multiple Allowed |
---|---|---|---|---|
action | Api Action Method | String Value: getshipmentslist | Yes | No |
ShipmentRequest | Parameters | Node | Yes | No |
ShipmentRequest
Title | Description | Type | Required | Multiple Allowed |
---|---|---|---|---|
StartDate | Shipment start date | String | No | No |
EndDate | Shipment End date | String | No | No |
UpdatesOnly | Set to Y for only send updates since the last API call | String Value: Y/N | Yes | No |
Note: If no date range is passed we will give 30 days of Data by default.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
v | string |
Request Body
{"GetRatingEngineQuote"=>{"Customer"=>{"Username"=>"demo123@techtransport.com", "ApiKey"=>"d689f46d2e7a9c4cf87f07eb68deb583", "LocationCode"=>""}, "request"=>{"action"=>"get_shipments_list", "ShipmentRequest"=>{"StartDate"=>"2023-05-01", "EndDate"=>"2023-07-28", "UpdatesOnly"=>"N"}}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |