Skip to navigation

List product locations

View as Markdown

Get product locations (apps)

Returns the apps (referred to here as locations) linked to the given product. Each entry is projected to { Id, Name }.

Authentication

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

Path params

  • productId (required) — the product UUID.

Behavior

  • Validates the product exists in your store (400 Product with id <productId> not found otherwise).
  • Returns an array of { Id, Name } app objects.

Notas: The route is named /locations but returns linked apps (join table productApps -> apps), projected to Id + Name. Returns a bare array. Product must belong to the caller’s store.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

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