Customs Inventory Linking Exports API
| Available in Sandbox | Yes |
|---|---|
| Sandbox base URL | https://test-api.service.hmrc.gov.uk |
| Available in Production | Yes |
| Production base URL | https://api.service.hmrc.gov.uk |
Overview
This API enables the functionality to support the Inventory Linking Export process. Inventory Linking controls and monitors cargo moving through temporary storage facilities, and allows the movement/transition through frontiers.
There are three functional areas;
- Consolidation This enables the combining of consignments into one master consignment, or splitting into multiple consignments.
- Movement Records the movement of consignments within Customs controlled storage facilities.
- Query The querying of data held within the Inventory Linking Export database.
Within each of these functional areas, there are multiple message types, each performing a specific activity.
Errors
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
- 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
- 400 to 499 if it failed because of a client error by your application
- 500 to 599 if it failed because of an error on our server
Errors specific to each API are shown in the Endpoints section, under Response. See our reference guide for more on errors.
Testing
You can use the HMRC Developer Sandbox to test the API. The Sandbox is an enhanced testing service that functions as a simulator of HMRC’s production environment.
Note: The Customs Inventory Linking Exports API is user restricted. For some message types, the person who grants authority to the software must be authorised for that functionality. This means that you must generate an authorised test user if you want to test all the functionality. Use the Create Test User API to generate the test user, passing an appropriate EORI from the CDS Test Data Library. You can download the CDS Test Data Library from the CDS Technical Documentation.
Versioning
When an API changes in a way that is backwards-incompatible, we increase the version number of the API. See our reference guide for more on versioning.
Endpoints
View API endpointsWhy do these endpoints look different?
The endpoints for this API now use the Open API Specification (OAS).
The API has not changed. You do not need to make any updates to your application if you already use this API.