Skip to content
/
Expand
Last updated

Use $expand to include supported embedded collections in a Catalog API response.

The current OpenAPI specification documents $expand for selected Catalog endpoints. It is not documented in the current DAM OpenAPI specification.

When to use $expand

Use $expand when an integration needs related data together with the main resource.

For example, a product response may include information about related variants when the endpoint supports expanding that collection.

Syntax

$expand=EMBEDDED_COLLECTION_NAME

Example:

GET https://api2.saleslayer.com/catalog/rest/Catalog/Products?$select=prod_ref,prod_title&$expand=Variants

Supported expansions

Supported expansions depend on the resource and endpoint.

Use metadata endpoints to understand available relationships:

GET https://api2.saleslayer.com/catalog/rest/Catalog/Products/$metadata
GET https://api2.saleslayer.com/catalog/rest/Catalog/Categories/$metadata

Notes

  • Embedded collections are not included unless requested.
  • The migrated source documentation states that embedded collections are supported, while embedded individual resources are not documented as supported.
  • Expanding related data can increase response size; combine it with $select and pagination where appropriate.

Orderby

Logical operators