Developers
API referenceBusiness sign in

Shipments

Current prohibited-items declaration

GET/declarations/prohibited-items

Every booking and ship run must confirm { accepted: true, version } for the current version, after your shop has shown it to whoever books. A changed version makes older confirmations fail with 409 PROHIBITED_ITEMS_DECLARATION_REQUIRED. Any valid key; no scope.

Request

No parameters.

Response

Success responses
StatusMeaning
200The declaration in force

The body is { "status": "success", "data": … }. Fields of data (DeclarationResult):

Response data
FieldTypeDescription
declarationRequiredobject
versionRequiredstringSend this as prohibitedItemsDeclaration.version.
titleRequiredstring
bodyRequiredstringThe text to show before confirming.
publishedAtOptionalstring (date-time)

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.