Sign in

v1

latestOpenAPI 3.0.32026-07-1311114.0 KB
Goods records

Patch an existing goods record

Patch an existing goods record, updating any fields supplied in the payload and leaving other fields unchanged.

patch/customs/traders/goods-profiles-test-support/profiles/{eori}/records/{recordId}

Path parameters

eoristring required

The trader's EORI number. The first 2 letters are the country code, like GB or XI, followed by 12 or 15 digits.

Example:GB123456789012

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

recordIdstring uuid required

ID of the record for the TGP Product in the TGP Core database (UUID)

Example:8ebb6b04-6ab0-4fe2-ad62-e6389a8a204f

ID of the record for the TGP Product in the TGP Core database (UUID)

Headers

Content-Typestring required
Example:application/json

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

Authorizationstring required
Example:Bearer 59fc92c1cdf0b8ef1f138a702effdbd2

An OAuth 2.0 Bearer Token.

Request body

adviceStatus'Not Requested' | 'Requested' | 'In progress' | 'Information Requested' | 'Advice request withdrawn' | 'Advice Provided' | 'Advice not provided'

Indicates the advice status of a record if the trader has requested that HMRC review their commodity code.

versioninteger

Version of the TGP record.

activeboolean

Status of the TGP record.

lockedboolean

Whether the record is locked for updating due to the adviceStatus

toReviewboolean

The state of the record and if the trader needs to review it.

declarable'IMMI Ready' | 'Not Ready For IMMI' | 'Not Ready For Use'

Status of TGP record for H8 declarations.

reviewReason'commodity' | 'country' | 'measure' | 'unclear' | 'inadequate' | 'mismatch'

commodity - The commodity code has expired. You'll need to change the commodity code and categorise the goods.

country - The country of origin is not valid. You'll need to change the country of origin and categorise the record.

measure - The commodity code or restrictions have changed. You'll need to categorise the record.

unclear - HMRC have reviewed the record. The goods description is unclear. If you want to use this record on an IMMI, you'll need to amend the goods description.

inadequate - HMRC have reviewed this record. The goods description does not have enough detail. If you want to use this record on an IMMI, you'll need to amend the goods description.

mismatch - HMRC have reviewed this record. The commodity code and goods description do not match. If you want to use this record on an IMMI, you'll need to amend the commodity code and the goods description.

updatedDateTimestring date-time

Timestamp when the record was last updated.

Example request

{
  "adviceStatus": "Not Requested",
  "version": 1,
  "active": true,
  "toReview": true,
  "declarable": "Not Ready For Use",
  "reviewReason": "commodity",
  "updatedDateTime": "2023-01-01T00:00:00Z"
}

Response

TGP record was successfully patched

All 1 operations