Sign in

v1

latestOpenAPI 3.0.32026-07-131435187.6 KB
Arrivals

Send a message related to an arrival

Send a message to the customs office of destination about an arrival.

For example, if you are a trader at destination, you will send an ‘Unloading Remarks’ E_ULD_REM (IE044) message to the office of destination indicating that unloading of the goods has been completed. <br/><br/> If you use this endpoint to send a small message (up to 5MB), a successful response will contain a URI, an arrival ID, and a message ID related to the arrival, which you can use to get the message status. <br/><br/> 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
  • an arrival ID, specifying the arrival to return
  • 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/{arrivalId}/messages

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.

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/6365135ba5e821ee/messages/634982098f02f00a"
    },
    "arrival": {
      "href": "/customs/transits/movements/arrivals/6365135ba5e821ee"
    }
  },
  "arrivalId": "6365135ba5e821ee",
  "messageId": "634982098f02f00a"
}