v1

latestOpenAPI 3.0.32026-07-13947245.3 KB

Goods records

Get good records by EORI and optionally lastUpdatedDate, supports pagination

Gets a list of good records

get/customs/traders/goods-profiles/{eori}/records

Path parameters

eoristring required

The traders' EORI number. The first 2 letters are the country code, like GB followed by 12 to 15 digits.

Example:GB123456789012

The traders' EORI number. The first 2 letters are the country code, like GB followed by 12 to 15 digits.

Query parameters

lastUpdatedDatestring date-time

Example:2024-04-18T23:20:19Z

Date value, all records after which have to be retrieved from the backend; This should use standard ISO8601 format (yyyy-mm-dd hh:mm:ssZ).

pageinteger

0 indexed page number

Example:1

The page number to fetch, defaults to 0

sizeinteger

Number of records per page to be requested

Example:100

Number of records per page to be requested, default is 500

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 59fc92c1cdf0b8ef1f138a702effdbd2

An OAuth 2.0 Bearer Token.

Response

OK; Request completed successfully

Example response

{
  "records": [
    {
      "recordId": "8ebb6b04-6ab0-4fe2-ad62-e6389a8a204f",
      "eori": "GB123456789012",
      "actorId": "GB987654321098",
      "traderRef": "SKU123456",
      "comcode": "0810100000",
      "adviceStatus": "Not Requested",
      "goodsDescription": "Bananas",
      "countryOfOrigin": "GB",
      "category": 2,
      "assessments": {
        "assessmentId": "a06846e9a5f61fa4ecf2c4e3b23631fc",
        "primaryCategory": 1,
        "condition": {
          "type": "certificate",
          "conditionId": "Y923",
          "conditionDescription": "Products not considered as waste according to Regulation (EC) No 1013/2006 as retained in UK law",
          "conditionTraderText": "Excluded product"
        }
      },
      "supplementaryUnit": 13,
      "measurementUnit": "Kilograms",
      "comcodeEffectiveFromDate": "2023-01-01T00:00:00Z",
      "comcodeEffectiveToDate": "2028-01-01T00:00:00Z",
      "version": 1,
      "active": true,
      "toReview": false,
      "reviewReason": "Commodity code changed",
      "declarable": "IMMI declarable",
      "ukimsNumber": "XIUKIM47699357400020231115081800",
      "nirmsNumber": "RMS-GB-123456",
      "niphlNumber": "S12345",
      "locked": false,
      "createdDateTime": "2023-01-01T00:00:00Z",
      "updatedDateTime": "2023-01-01T00:00:00Z"
    },
    {
      "recordId": "cf57844a-b79a-425a-995d-2fb357330873",
      "eori": "GB123456789012",
      "actorId": "GB987654321098",
      "traderRef": "SKU123457",
      "comcode": "0810100000",
      "adviceStatus": "Not Requested",
      "goodsDescription": "Apples",
      "countryOfOrigin": "GB",
      "category": 2,
      "assessments": {
        "assessmentId": "a06846e9a5f61fa4ecf2c4e3b23631fc",
        "primaryCategory": 1,
        "condition": {
          "type": "certificate",
          "conditionId": "Y923",
          "conditionDescription": "Products not considered as waste according to Regulation (EC) No 1013/2006 as retained in UK law",
          "conditionTraderText": "Excluded product"
        }
      },
      "supplementaryUnit": 13,
      "measurementUnit": "Kilograms",
      "comcodeEffectiveFromDate": "2023-01-01T00:00:00Z",
      "comcodeEffectiveToDate": "2028-01-01T00:00:00Z",
      "version": 1,
      "active": true,
      "toReview": true,
      "reviewReason": "Commodity code changed",
      "declarable": "IMMI declarable",
      "ukimsNumber": "XIUKIM47699357400020231115081801",
      "nirmsNumber": "RMS-GB-123457",
      "niphlNumber": "S12346",
      "locked": false,
      "createdDateTime": "2023-01-01T00:00:00Z",
      "updatedDateTime": "2023-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "totalRecords": 250,
    "currentPage": 1,
    "totalPages": 3,
    "nextPage": 2
  }
}

All 9 operations