Sign in

v1

latestOpenAPI 3.0.32026-07-131435187.6 KB
Arrivals

Get all cached messages related to an arrival

Get all messages related to a specific arrival that have been received within the past 60 days. You can filter for arrival notifications received before and/or after a specific date and time. For a multi-page query you can filter for a specific page, and optionally the number of items per page. Movements older than 60 days are archived, so any messages related to them cannot be returned by the API. <br/><br/> 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/arrivals/{arrivalId}/messages

Path parameters

arrivalIdstring required

The arrival ID specifying the arrival to return.

Query parameters

receivedSincestring date-time
Example:2021-06-21T09:00:00Z

This is an optional query parameter that you can use to filter for arrivals received after a specific date and time.

pageinteger
Example:2

This is an optional query parameter (default value is 1) that allows the selection of a specific page from a multi-page query. If used, you must enter a positive number.

countinteger
Example:50

This is an optional query parameter (default value is 25) that you can use to select the number of items per page in a multi-page query. If used, you must enter a positive number. The maximum value allowed is 500.

receivedUntilstring date-time
Example:2023-06-15T09:00:00Z

This is an optional query parameter that you can use to filter for arrivals updated before a specific date and time.

Headers

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

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

Response

A successful get all messages related to arrival response

totalCountnumber required

Example response

{
  "_links": {
    "self": {
      "href": "/customs/transits/movements/arrivals/63498209a2d89ad8/messages"
    },
    "arrival": {
      "href": "/customs/transits/movements/arrivals/63498209a2d89ad8"
    }
  },
  "totalCount": 1,
  "messages": [
    {
      "_links": {
        "self": {
          "href": "/customs/transits/movements/arrivals/63498209a2d89ad8/messages/634982098f02f00a"
        },
        "arrival": {
          "href": "/customs/transits/movements/arrivals/63498209a2d89ad8"
        }
      },
      "id": "634982098f02f00a",
      "arrivalId": "63498209a2d89ad8",
      "received": "2022-11-10T15:32:51.459Z",
      "type": "IE007",
      "status": "Success"
    }
  ]
}