Sign in

v1

latestOpenAPI 3.0.32026-07-131435187.6 KB
Departures

Get all cached departures

Get all departure declarations sent to the customs office of departure within the past 60 days. You can filter for departure declarations updated before and/or after a specific date and time, and optionally filter for departure declarations with a specific EORI. 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 and their related messages are archived and cannot be returned by the API. A successful response will include the total count of the number of movements and a Movement Reference Number (MRN) only after it has been allocated to a movement. <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/departures

Query parameters

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

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

movementEORIstring
Example:GB1234567890

This is an optional query parameter that you can use to filter for departure declarations that were submitted with a specified movement EORI.

movementReferenceNumberstring
Example:27WF9X1FQ9RCKN0TM3

This is an optional query parameter that allows a list of departures to be filtered by an MRN.

localReferenceNumberstring
Example:3CnsTh79I7vtOy6

This is an optional query parameter that allows a list of departures to be filtered by an LRN.

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 departure declarations 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 departures response

totalCountnumber required

Number of movements returned by the filter

Example response

{
  "_links": {
    "self": {
      "href": "/customs/transits/movements/departures"
    }
  },
  "totalCount": 1,
  "departures": [
    {
      "_links": {
        "self": {
          "href": "/customs/transits/movements/departures/63651574c3447b12"
        },
        "messages": {
          "href": "/customs/transits/movements/departures/63651574c3447b12/messages"
        }
      },
      "id": "63651574c3447b12",
      "movementReferenceNumber": "27WF9X1FQ9RCKN0TM3",
      "created": "2022-11-04T13:36:52.332Z",
      "updated": "2022-11-04T13:36:52.332Z",
      "enrollmentEORINumber": "9999912345",
      "movementEORINumber": "GB1234567890"
    },
    {
      "_links": {
        "self": {
          "href": "/customs/transits/movements/departures/6365135ba5e821ee"
        },
        "messages": {
          "href": "/customs/transits/movements/departures/6365135ba5e821ee/messages"
        }
      },
      "id": "6365135ba5e821ee",
      "movementReferenceNumber": "27WF9X1FQ9RCKN0TM3",
      "created": "2022-11-04T13:27:55.522Z",
      "updated": "2022-11-04T13:27:55.522Z",
      "enrollmentEORINumber": "9999912345",
      "movementEORINumber": "GB1234567890"
    }
  ]
}
All 14 operations