v1

latestOpenAPI 3.0.32026-07-131435187.6 KB

Departures

Get a cached message related to a departure and message ID

Get a message related to a specific departure and message ID that have been received within the past 60 days. For example, this could include ‘Declaration rejected’ or Movement Reference Number (MRN) allocated messages. Movements older than 60 days and their related messages are archived and cannot be returned by the API. <br/><br/> A successful response can be returned in one of the following formats based on the provided Accept header:

application/vnd.hmrc.3.0+json-xml: JSON-wrapped XML, where the message is provided as an XML string sent as part of JSON payload containing other metadata
application/vnd.hmrc.3.0+json: JSON, where the message is provided as a sub-document sent as part of a JSON payload containing other metadata

The status parameter in a successful response can have the following values:

Pending: the file has not yet been uploaded or checks are not yet completed
Processing: the file has been received by us and the message is being processed
Success: the file has been processed successfully
Failed: there was a problem with the file and the message was not processed

Note: You can view a transit movement only if your Economic Operators Registration and Identification (EORI) number matches the EORI number that created the transit declaration for that movement. Your EORI number is part of the bearer token that you use for API authentication.

get/customs/transits/movements/departures/{departureId}/messages/{messageId}

Path parameters

departureIdstring required

The departure ID specifying the departure to return.

messageIdstring required

The message ID specifying the message to return.

Headers

Accept'application/vnd.hmrc.3.0+json' | 'application/vnd.hmrc.3.0+json-xml' required

Specifies the response format, which must be JSON or JSON+XML, and the version of the API to be used. Acceptable values are application/vnd.hmrc.3.0+json or application/vnd.hmrc.3.0+json-xml.

Response

A successful get message related to departure and message ID response

idstring required

departureIdstring required

receivedstring required

typestring

statusstring required

bodystring

Example response

{
  "_links": {
    "self": {
      "href": "/customs/transits/movements/departures/62f4ebbbf581d4aa/messages/62f4ebbb765ba8c2"
    },
    "departure": {
      "href": "/customs/transits/movements/departures/62f4ebbbf581d4aa"
    }
  },
  "id": "62f4ebbb765ba8c2",
  "departureId": "62f4ebbbf581d4aa",
  "received": "2022-08-11T11:44:59.83705",
  "type": "IE015",
  "status": "Success",
  "body": "<ncts:CC015C PhaseID=\"NCTS6.0\" xmlns:ncts=\"http://ncts.dgtaxud.ec\">...</ncts:CC015C>"
}