Products

Read one product.

Read one product by ID. Returns the full document including default field values, image URLs, template reference, and the running passportCount.

get/api/v1/products/{id}

Request

  • Base URL: https://app.tracepass.eu
  • URL: https://app.tracepass.eu/api/v1/products/{id}
  • 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:read)

Response

Product.

_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.