List messages for a Shipment

SecurityAuthToken

Request

path Parameters

shipmentId

required

string <uuid>

The id of the shipment

query Parameters

page	integer indicates what page of a list of query results you want to view
page-size	integer indicates the how many items to return per page in a list request
q	string search query

Responses

200

List of messages for the given Shipment

Response Schema: application/json

page_size	integer
	Array of objects (ShipmentMessage)
total_count	integer
total_pages	integer

default

Default error response

get/shipments/{shipmentId}/messages/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"page_size": 0,
"results": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"message": "string",
"read": true,
"sender_avatar": "string",
"sender_id": "3194e023-c19f-4a42-9172-9e18d68e3a3a",
"sender_name": "string",
"shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_count": 0,
"total_pages": 0
}