Get a product
One product of the catalogue, as in the list.
Errors: api_client.product_not_allowed, product.not_found, auth.credentials_invalid, auth.forbidden, request.rate_limited.
AuthorizationBearer <token>A Microsoft Entra client-credentials token for the Transakt API (scope api://{apiAppId}/.default), issued in the tenant recorded on the API client credential, with the app role matching the operation: Entitlement.Read.All, Catalogue.Read.All or Usage.Write.All.
Scope: api://{apiAppId}/.default
productSlug*stringOK
application/json- response
CatalogueProduct (6.5.5); editions in rank order since slice 11.4a.
slug*stringname*stringtypes*array<>categories*array<>editions*array<>plans*array<>curl -X GET "https://example.com/api/v1/catalogue/products/string"{ "slug": "string", "name": "string", "types": [ "WebApp" ], "categories": [ { "slug": "string", "name": "string" } ], "editions": [ { "slug": "string", "name": "string", "rank": 0 } ], "plans": [ { "slug": "string", "name": "string", "edition": "string", "capabilities": { "property1": true, "property2": true }, "licenceModel": "TenantWide", "marketplace": [] } ]}Check whether a user may use a product GET
The user question: may this user of the tenant use the product? Send `userObjectId`, or a delegated user token (scope `Entitlement.Read`) to ask about the signed-in user. The answer's `licenceOutcome` is `Licensed`, `NotLicensed`, `Unconfirmed` (Microsoft could not confirm: apply your own grace policy) or `ConsentRequired` (repeat with the user's delegated token). Questions by email use the POST form so that personal data never appears in a URL. Errors: [`request.validation_failed`](/errors/request.validation_failed/), [`api_client.product_not_allowed`](/errors/api_client.product_not_allowed/), [`entitlement.user_tenant_mismatch`](/errors/entitlement.user_tenant_mismatch/), [`product.not_found`](/errors/product.not_found/), [`plan.not_found`](/errors/plan.not_found/), [`auth.credentials_invalid`](/errors/auth.credentials_invalid/), [`auth.forbidden`](/errors/auth.forbidden/), [`request.rate_limited`](/errors/request.rate_limited/).
List your products GET
Your products that the API client may read, with their editions (in rank order) and plans; each plan carries its edition and its effective capabilities (features and limits). Scope `catalogue:read` (app role `Catalogue.Read.All`). Errors: [`category.not_found`](/errors/category.not_found/), [`auth.credentials_invalid`](/errors/auth.credentials_invalid/), [`auth.forbidden`](/errors/auth.forbidden/), [`request.rate_limited`](/errors/request.rate_limited/).