---
title: "GET /customs/goods-movement-system/reference-data"
method: GET
path: "/customs/goods-movement-system/reference-data"
---

# GET /customs/goods-movement-system/reference-data

`GET /customs/goods-movement-system/reference-data`

This endpoint gets details of all reference data used by GVMS.

Reference data includes lists of:

* Carriers operating on GVMS routes
* Ports operating GVMS routes 
* GVMS routes (combining a carrier and a pair of ports
* Validation rule failure codes and descriptions

The reference data is returned as a single JSON document containing all required data lists.
New carriers, routes, ports and locations will be added with effective from and to dates, so your software will have an advance view of upcoming changes.  It should not offer up routes that are not yet in effect or that have expired.

GVMS reference data is updated periodically. If you are a GVMS API subscriber, you will receive notifications about upcoming updates. If you receive a notification about an update, your application software must refresh the reference data by calling the GET reference-data endpoint.

## Headers

- `Accept` string, required

## Response `200`

GMVS reference data is returned in the response body

- object
  - `routes` object[] — The routes covered by GVMS
    - `routeId` string, required — The route identifier
    - `routeDirection` 'UK_INBOUND' | 'UK_OUTBOUND' | 'GB_TO_NI' | 'NI_TO_GB', required — The direction of the route
    - `routeEffectiveFrom` string, date, required — Date the route came into effect
    - `departurePortId` integer, required — The id of the departure port
    - `arrivalPortId` integer, required — The id of the arrival port
    - `carrierId` integer, required — the id of the carrier operating that route
    - `routeEffectiveTo` string, date — The date the route stopped being used
  - `ports` object[]
    - `portId` integer, required — The id of the port
    - `portRegion` string — The region the port is grouped into for CTC
    - `portEffectiveFrom` string, date, required — The date the port came into effect
    - `portDescription` string, required — Description of the port eg: the ports name
    - `timezoneId` string — The UTC Identifier
    - `chiefPortCode` string — The port code specific to CHIEF
    - `cdsPortCode` string — The port code specific to CDS
    - `officeOfTransitCustomsOfficeCode` string, required — Customs office code for CTC
    - `portEffectiveTo` string, date — The date the port stopped being used
    - `portCountryCode` string, required — The Country code of the associated Port
    - `isOperatingArrivedExportsProcess` boolean — If true, indicates that this port is operating the arrived exports process and as such requires all customs export declarations to be pre-arrived prior to check-in. If omitted or false, indicates that this port is operating the standard exports process.
  - `carriers` object[]
    - `carrierId` integer, required — The id of the carrier
    - `carrierName` string, required — The name of the carrier
    - `countryCode` string — The country code where the carrier is registered
  - `locations` object[]
    - `locationId` string, required — The id of the inspection facility.
    - `locationDescription` string, required — The name of the inspection facility location.
    - `address` object, required — The address where the inspection facility is located.
      - `lines` string[], required — The building name or number, and street name where the inspection facility is located.
      - `town` string — The town where the inspection facility is located.
      - `postcode` string, required — The postcode where the inspection facility is located.
    - `locationType` 'IBF' | 'BCP' | 'ALL', required — The type of inspection facility; either Inland Border Facility (IBF), Border Control Post (BCP) or a facility that carries out all inspection types (ALL).
    - `supportedDirections` string[], required — The directions of travel supported by the location.
    - `locationEffectiveFrom` string, date, required — The date the inspection facility location starts being used.
    - `locationEffectiveTo` string, date — The date the inspection facility location stops being used.
    - `supportedInspectionTypeIds` string[], required — The list of inspectionTypeIds for the types of inspections carried out.
    - `requiredInspectionLocations` integer[], required — The list of portIds that the inspection facility supports.
  - `inspectionTypes` object[]
    - `inspectionTypeId` string, required — The id of the type of inspection that needs to be performed on the vehicle.
    - `description` string, required — The category of the type of inspection that needs to be performed on the vehicle e.g. CUSTOMS, DEFRA or TRANSIT.
  - `ruleFailures` object[] — The list of business and other possible rule failures within a GMR
    - `ruleId` string, required
    - `ruleDescription` string, required

---

[API](https://skmtc.dev/hmrc/apis/goods-movement-system-haulier-api.md) · [All operations](https://skmtc.dev/hmrc/apis/goods-movement-system-haulier-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hmrc/goods-movement-system-haulier-api/revisions/9ff4efa9be1c/schema)