DeltaTrak API Documentation
List
GET {{baseUrl}}/shipment?tripNumber=Shipment Trip Number&shipperID=Shipper ID&receiverID=Receiver ID&status="Completed" | "Pending" | "Registered" | "Activated"&createdAt=2022-03-01 11:00&query=count&page=1&qty=10
Find Shipments that match specified criteria ■ Should pull back shipments belonging to account, plus shipments shared with
account (explicit & receiver sharing)
■ Optional filters reduce results, and no parameters return all shipments for
account (see above)
■ Should include locations, product, alarm criteria(s), and list of shipment alerts
Body
PARAM
| Key | Datatype | Required | Description |
tripNumber
|
string | (Optional) string | |
shipperID
|
string | (Optional) string | |
receiverID
|
string | (Optional) string | |
status
|
string | (Optional) Filter shipments by its status | |
createdAt
|
string | (Optional) Filter by creation date and time (UTC) | |
query
|
string | (Optional) count | last_item | last_updated | |
page
|
number | (Optional) pagination number | |
qty
|
number | (Optional) number of items by page |
HEADERS
| Key | Datatype | Required | Description |
authorization
|
string |
RESPONSES
status OK
| [
{
"account_id": "TAGOIO",
"shipment_name": "Shipment 1223",
"trip_number": "TAGO1223",
"shipment_status": "Pending",
"purchase_order": "123123123",
"container_number": "Not Implemented",
"alarm_status": false,
"deployment_date": "Not Implemented",
"estimated_departure_date": "Not Implemented",
"departure_date": "Not Implemented",
"estimated_arrival_date": "Not Implemented",
"arrival_date": "Not Implemented",
"last_communication_date": "2022-11-17T17:56:54.586Z",
"receiver_location": {
"type": "receiver",
"name": "Receiver",
"address": "Not implemented",
"lat": -122.4194155,
"lng": 37.7749295,
"radius": 100000
},
"shipper": {
"type": "shipper",
"name": "Shipper 2",
"address": "Not implemented",
"lat": -117.1610838,
"lng": 32.715738,
"radius": 100000
},
"carrier": {
"name": "Test1",
"address": "114 Fayetteville St, Raleigh, NC 27601, USA",
"contact_name": "Test",
"contact_phone": "12354689",
"contact_email": "testemail@gmail.com"
},
"test_range": {
"start": 8,
"end": 12,
"unit": "hours"
},
"product": {
"product_id": "A8pe2512bku!",
"name": "Apple",
"alarm_criteria": {
"temperature": {
"high": 1,
"low": 0,
"minutes_above_high": 0,
"minutes_below_low": 0
},
"temperature_2": {
"high": 0,
"low": 0,
"minutes_above_high": 0,
"minutes_below_low": 0
},
"humidity": {
"high": 0,
"low": 0
},
"mkt": {
"min": 0,
"max": 0
},
"light_max": 0,
"shock_threshold": 0
}
},
"alarms": [],
"airline": {},
"maritime": {
"bol": "BA123",
"scac": "SSC124",
"user_estimated_departure_date": "Not Implemented",
"user_estimated_arrival_date": "Not Implemented",
"vessel_name": "Not Implemented",
"vessel_imo": "Not Implemented",
"container_number": "Not Implemented",
"departure_port": "Not Implemented",
"arrival_port": "Not Implemented",
"provider_estimated_departure_date": "Not Implemented",
"actual_departure_date": "Not Implemented",
"provider_estimated_arrival_date": "Not Implemented",
"actual_arrival_date": "Not Implemented"
}
}
] |
Curl
curl -X GET 'https://7qzar0u2yd.execute-api.us-east-1.amazonaws.com/test//shipment?tripNumber=Shipment Trip Number&shipperID=Shipper ID&receiverID=Receiver ID&status="Completed" | "Pending" | "Registered" | "Activated"&createdAt=2022-03-01 11:00&query=count&page=1&qty=10?tripNumber=Shipment Trip Number&shipperID=Shipper ID&receiverID=Receiver ID&status="Completed" | "Pending" | "Registered" | "Activated"&createdAt=2022-03-01 11:00&query=count&page=1&qty=10' -H 'authorization: eyJhbGciOiJub25lIn0.eyJhZG1pbiI6dHJ1ZSwidXNlcklEIjoiNjM5NzViZDRkY2Q2OTMwMDJjMzgxMDMzIiwiaWF0IjoxNjg1MDIwNTE4LCJpc3MiOiJ1cm46Zmxhc2h0cmFrOmlzc3VlciIsImF1ZCI6InVybjp1c2VyOmF1ZGllbmNlIiwiZXhwIjoyMDAwNTk2NTE4fQ.'
ENDPOINTS