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

Request

Base URL
https://test-api.service.hmrc.gov.uk
Auth
OAuth 2
Authorization codehttps://api.service.hmrc.gov.uk/oauth/authorize
Token URLhttps://api.service.hmrc.gov.uk/oauth/token
Scopesexcise-movement-control-system
TypeScript
https://skmtc.dev/hmrc/apis/excise-movement-control-system-api/docs/customs/excise/movements/:movementId/messages/get.ts
A function with typed inputs. Its response is checked against the schema.

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

encodedMessagestring byte required

createdOnstring date-time required

messageIdstring required

recipientstring required

messageType'IE704' | 'IE801' | 'IE802' | 'IE803' | 'IE807' | 'IE829' | 'IE839' | 'IE840' | 'IE881' | 'IE905' required

The type of outgoing message

Changes

No recorded changes to this operation across all 1 revision of this API.