SallaInstall

Summary

Retrieve detailed information about a specific brand within the catalog resource by its unique Brand ID and optional query parameters.

Inputs

• Sub-resource (required) — Select a sub-resource within the chosen category (for this operation, typically "brands").
• Brand ID (required) — Unique identifier assigned to the Brand to fetch its details.
• Return Mode — Choose whether to return only the brand's data payload or the full backend response envelope.
• Additional Fields — Optional query parameters such as "translations" to include localized data in the response.

Output shape

A single item (object) containing brand details if Return Mode is 'Data Only', or a single item with the full API response envelope (including status and raw data) if Return Mode is 'Full Envelope'.

The operation expects a valid Brand ID; errors occur if the ID is missing or invalid. The 'Additional Fields' may influence included data such as translations. The response's exact structure depends on the API's returned brand data schema. Only one brand is fetched per request.

Examples

Example 1: Fetch brand details with ID 123 in data only mode.

Set Sub-resource to 'brands', Brand ID to 123, and Return Mode to 'Data Only'. Optionally, add 'translations' to Additional Fields to include brand translations.