v1

latestOpenAPI 3.0.32026-07-131435187.6 KB
Arrivals

Send an arrival notification message

Notify the customs office of destination that a transit movement has arrived at its final destination.

This request is also called an ‘Arrival Notification’ E_ARR_NOT (IE007) message. <br/><br/> If you use this endpoint to send a small message (up to 5MB), a successful response:

  • will contain a URI that you can use to get the message status
  • will contain the arrival ID specifying the arrival returned
  • can also include an optional box ID, which you can use to match this movement to any messages received from the Push Pull Notifications API

If you use this endpoint to send a large message (up to 8MB), a successful response will include:

  • a URL and additional metadata that you must use when uploading your file
  • will contain the arrival ID specifying the arrival returned
  • a message ID that allows you track the status of that specific message

Note: If an Economic Operators Registration and Identification (EORI) number has not been assigned to you, an HTTP 403 Forbidden error is returned.

post/customs/transits/movements/arrivals

Headers

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

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

Content-Type'application/json' | 'application/xml' required

Specifies the format of the request body, which must be XML or JSON, using UTF-8 character encoding.

Response

Accepted

OR

Example response

{
  "_links": {
    "self": {
      "href": "/customs/transits/movements/arrivals/62fb8f33d233578e"
    },
    "messages": {
      "href": "/customs/transits/movements/arrivals/62fb8f33d233578e/messages"
    },
    "message": {
      "href": "/customs/transits/movements/arrivals/62fb8f33d233578e/messages/64e760870c18a87a"
    }
  },
  "arrivalId": "62fb8f33d233578e",
  "messageId": "64e760870c18a87a",
  "boxId": "b54c2424-955b-496c-bbce-dfb9f57cd797"
}