Arrivals

Get a cached arrival for an arrival ID

Get a specific arrival notification sent to the customs office of destination within the past 60 days. Movements older than 60 days and their related messages are archived and 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}

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
Scopescommon-transit-convention-traders
TypeScript
https://skmtc.dev/hmrc/apis/common-transit-convention-traders/docs/customs/transits/movements/arrivals/:arrivalId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

arrivalIdstring required

The arrival ID specifying the arrival to return.

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 arrival for arrival ID response

idstring required

movementReferenceNumberstring

createdstring required

updatedstring

enrollmentEORINumberstring required

movementEORINumberstring

Example response

{
  "_links": {
    "self": {
      "href": "/customs/transits/movements/arrivals/6365135ba5e821ee"
    },
    "messages": {
      "href": "/customs/transits/movements/arrivals/6365135ba5e821ee/messages"
    }
  },
  "id": "6365135ba5e821ee",
  "movementReferenceNumber": "ABC123",
  "created": "2022-11-10T15:32:51.459Z",
  "updated": "2022-11-10T15:32:51.459Z",
  "enrollmentEORINumber": "GB1234567890",
  "movementEORINumber": "GB1234567890"
}

Changes

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