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 | 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 |