Sign in

v1

latestOpenAPI 3.0.32026-07-13945127.2 KB
Movements

Get all messages for an excise movement using the movementId

Get all messages for a specific excise movement. </br></br>Note: The consignor ID or consignee ID must match an excise reference number (ERN) in the bearer token that you use for API authentication. If it does not, a 403 Forbidden error will be thrown.

get/customs/excise/movements/{movementId}/messages

Path parameters

movementIdstring required

The movement to get messages for

Query parameters

updatedSincestring date-time

Filter messages received after provided timestamp.<br/>This can be used to poll for new messages per ERN/LRN combination.<br/>You can also poll on the get movements endpoint which allows a more efficient way to poll as that can first give you a list of movements that have new messages and then use this endpoint to retrieve the updated messages for those movements.

traderType'consignor' | 'consignee'

The type of trader (consignor or consignee)

Filter excise movements by trader type (consignor or consignee)

Headers

Accept'application/vnd.hmrc.1.0+json' required

Specifies the response format and the version of the API to be used.

Response

Successful operation