Skip to navigation
TIANKII API - API KeyProducts

Get product

View as Markdown

Get product by ID

Returns a single product owned by the authenticated store, together with its fully expanded modifiers (including modifier options) and linked apps (id + name).

Authentication

Requires a Merchant API key in x-api-key with scope Merchant.product.read.

Path params

  • id (required) — the product UUID.

Response

Returns an object with:

  • product — the product fields (with productCategory, modifiers, apps relations excluded from this sub-object).
  • modifiers — array of full modifier objects, each including its options.
  • apps — array of { Id, Name } for linked apps.

Responds 400 Product with id <id> not found if the product does not exist in your store.

Notas: The product must belong to the caller’s store; otherwise 400 (BadRequestException, not 404). modifiers include nested options; apps are projected to Id + Name only.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
The product UUID.

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.