v1

latestOpenAPI 3.0.32026-07-137163303.5 KB

Endpoints

Search for declarations

Get a list of declarations matching the query parameters

get/customs/declarations-information/search

Query parameters

partyRolestring required

Example:submitter

The party role. One of submitter, consignee, consignor or declarant. Only submitter is valid in this release.

declarationCategorystring required

Example:ALL

The category of a declaration. One of IM, EX, CO or ALL.

eoristring

Example:GB123456789000

For use in a future release.

dateFromstring date

Example:2021-04-09

The declaration start date. If omitted, then the results start from the earliest declaration. If both dates are omitted then the default is the last 30 days.

dateTostring date

Example:2021-04-16

The declaration end date. If omitted, then the results start from the dateFrom parameter to the current date. If both dates are omitted then the default is the last 30 days.

goodsLocationCodestring

Example:BELBELOB4

The goods location code. Maximum length is 12 characters.

declarationStatusstring

Example:uncleared

The status of a declaration. One of cleared, uncleared, rejected or all. If omitted the default is uncleared.

pageNumberinteger

The page number of the results. Default value is 1.

Headers

Acceptstring required

Example:application/vnd.hmrc.2.0+xml

Specifies the version of the API that you want to call. See versioning.

X-Badge-Identifierstring

Example:ABC123

Represents the end-user who is interacting with the subscribed application. CSPs must have an X-Badge-Identifier or X-Submitter-Identifier. Must be 6 to 12 characters, consisting of any combination of numeric digits and/or upper-case letters.

X-Submitter-Identifierstring

Example:GB123456789000

The EORI associated with the originating owner of the declaration.

CSPs must have an X-Badge-Identifier or X-Submitter-Identifier.

Must have a maximum length of 17 characters, consisting of any combination of numeric digits and/or letters.

All 7 operations