v1

latestOpenAPI 3.0.32026-07-13947245.3 KB

Traders profile

Maintain a trader's goods profile

Update a trader's goods profile

put/customs/traders/goods-profiles/{eori}

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.

Headers

Content-Typestring required

Example:application/json

Specifies the format of the request body, which must be JSON.

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.

Request body

actorIdstring required

EORI number of the user making the change. This may be different to the eori. The first 2 letters are the country code, like GB or XI followed by 12 to 15 digits.

ukimsNumberstring required

The traders' UK Internal Market Scheme registration number.

nirmsNumberstring

The traders' Northern Ireland Retail Movement Scheme registration number.

niphlNumberstring

The traders' Northern Ireland Plant Health Label scheme registration number.

Example request

{
  "actorId": "GB987654321098",
  "ukimsNumber": "XIUKIM47699357400020231115081800",
  "nirmsNumber": "RMS-GB-123456",
  "niphlNumber": "SP12345"
}

Response

OK; Request completed successfully

eoristring required

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

actorIdstring required

EORI number of the user making the change. This may be different to the eori. The first 2 letters are the country code, like GB or XI followed by 12 to 15 digits.

ukimsNumberstring required

The traders' UK Internal Market Scheme registration number.

nirmsNumberstring

The traders' Northern Ireland Retail Movement Scheme registration number.

niphlNumberstring

The traders' Northern Ireland Plant Health Label scheme registration number.

Example response

{
  "eori": "GB123456789012",
  "actorId": "GB987654321098",
  "ukimsNumber": "XIUKIM47699357400020231115081800",
  "nirmsNumber": "RMS-GB-123456",
  "niphlNumber": "SP12345"
}