Products

Archive a product.

Soft-archive. Product.status flips to archived; the product disappears from default listings (still visible with the ?showArchived=true filter). Existing passports keep resolving — archive blocks NEW passport creation against this product going forward; it doesn't break any QR already in customers' hands.

Returns 409 when any non-archived passport still references the product. Honours Idempotency-Key.

post/api/v1/products/{id}/archive

Request

  • Base URL: https://app.tracepass.eu
  • URL: https://app.tracepass.eu/api/v1/products/{id}/archive
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.tracepass.eu/api/oauth/authorize, token URL https://app.tracepass.eu/api/oauth/token, scopes: passports:write)

Response

Archived.

_idstring

MongoDB ObjectId hex string (24 chars).

namestring
modelstring
categorystring
templateIdstring

MongoDB ObjectId hex string (24 chars).

defaultFieldValuesobject

Seed values for passports created from this product, keyed by template field. Each value is checked against the template: a numeric string for a number field is stored as a number, and any other value the template rejects answers 400 Invalid default field values with details (in a batch, that item's result is an error).

imageUrlsstring[]
passportCountinteger
status'active' | 'archived'
sourceLocalestring
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "_id": "6650a1b2c3d4e5f6a7b8c9d0",
  "templateId": "6650a1b2c3d4e5f6a7b8c9d0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.