Sign in

v1

latestOpenAPI 3.0.02026-07-13655272.1 KB

List Goods Movement Records

This endpoint provides a list of all the Goods Movement Records (GMRs) that you have worked on over the last 28 days.

The returned list of GMRs will contain summary information as per the example below. For the full GMR, use the Get Goods Movement Record endpoint.

get/customs/goods-movement-system/movements

Headers

Acceptstring required
Example:application/vnd.hmrc.1.0+json

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

Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token.

Response

All GMRs from the last 28 days are listed in the response body

gmrIdstring required

The Goods Movement Record (GMR) ID for this GMR. Do not include when POSTing a GMR - GVMS will assign an ID.

isUnaccompaniedboolean

Set to true if the vehicle will not be accompanying the trailer(s) during the crossing, or if the vehicle is carrying a container that will be detached and loaded for the crossing.

inspectionRequiredboolean

If set to true, indicates that the vehicle requires a customs inspection. If set to false, indicates that the vehicle does not require a customs inspection. If not set, indicates the customs inspection decision has not yet been made or is not applicable. For outbound GMRs, this indicates that the vehicle must present at an inspection facility prior to checking-in at the port. For Office of Transit inspections for inbound GMRs, a decision may be made to inspect subsequent to a notification that inspection is not required. In this event a notification will be sent that changes inspectionRequired from false to true. If this happens after leaving the port of arrival, the inspection should be carried out at the next transit office e.g. the office of destination.

vehicleRegNumstring

Vehicle registration number of the vehicle that will arrive at port. If isUnaccompanied is set to false then vehicleRegNum must be provided to check-in.

trailerRegistrationNumsstring[]

For vehicles carrying trailers, the trailer registration number of each trailer. If isUnaccompanied is set to true then trailerRegistrationNums or containerReferenceNums must be provided before check-in.

containerReferenceNumsstring[]

For vehicles arriving with containers that will be detached and loaded, the container reference number of each container in the movement. If isUnaccompanied is set to true then trailerRegistrationNums or containerReferenceNums must be provided before check-in.

createdDateTimestring required

The date and time that this GMR was created.

updatedDateTimestring required

The date and time that this GMR was last updated.

Example response

[
  {
    "gmrId": "GMRA000002JR",
    "reportToLocations": [
      {
        "inspectionTypeId": "1",
        "locationIds": [
          "L0029A",
          "L0030A"
        ]
      }
    ],
    "vehicleRegNum": "AB19 DEF",
    "trailerRegistrationNums": [
      "A1234567"
    ],
    "containerReferenceNums": [
      "CSQU3054383"
    ],
    "createdDateTime": "2021-08-11T10:58:12",
    "updatedDateTime": "2021-08-12T15:34:02",
    "plannedCrossing": {
      "routeId": "18273",
      "localDateTimeOfDeparture": "2021-08-11T10:58"
    },
    "checkedInCrossing": {
      "routeId": "18273",
      "localDateTimeOfArrival": "2021-08-11T10:58"
    },
    "actualCrossing": {
      "routeId": "18273",
      "localDateTimeOfArrival": "2021-08-11T10:58"
    },
    "links": [
      {
        "rel": "get-goods-movement-record",
        "href": "/customs/goods-movement-system/movements/GMRB00000A9C",
        "method": "GET"
      }
    ]
  }
]