{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown","redocly_category":"Guides","api_domain":"Catalog"},"seo":{"title":"Expand query parameter","description":"How to use the $expand query parameter to include related Catalog API collections in responses.","keywords":["Sales Layer","REST API","OpenAPI","DAM API","Catalog API","product catalog API","image management API","API integration"],"lang":"en-US","meta":[{"name":"og:type","content":"website"},{"name":"og:site_name","content":"Sales Layer REST API Documentation"},{"name":"og:title","content":"Sales Layer REST API Documentation"},{"name":"og:description","content":"Complete REST API documentation for Sales Layer's DAM and Catalog APIs. Learn authentication, pagination, filtering, and integration patterns."},{"name":"twitter:card","content":"summary_large_image"},{"name":"twitter:site","content":"@saleslayer"},{"name":"twitter:title","content":"Sales Layer REST API Documentation"},{"name":"twitter:description","content":"Complete REST API documentation for Sales Layer's DAM and Catalog APIs. Learn authentication, pagination, filtering, and integration patterns."}],"llmstxt":{"hide":false,"title":"Sales Layer REST API Documentation","description":"Technical guides and OpenAPI references for Sales Layer DAM and Catalog REST APIs.","sections":[{"title":"Guides","description":"Static API guides for authentication, headers, query parameters, responses, rate limiting, and best practices.","includeFiles":["guides/**/*.md","changelog.md"],"excludeFiles":[]},{"title":"API Reference","description":"OpenAPI-based references and API overview pages for Sales Layer REST APIs.","includeFiles":["apis/**/*.md","apis/**/*.yaml"],"excludeFiles":[]},{"title":"Postman collections","description":"Importable Postman collection and environment instructions for testing Sales Layer REST APIs.","includeFiles":["postman/**/*.md"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"expand","__idx":0},"children":["Expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$expand"]}," to include supported embedded collections in a Catalog API response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The current OpenAPI specification documents ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$expand"]}," for selected Catalog endpoints. It is not documented in the current DAM OpenAPI specification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-to-use-expand","__idx":1},"children":["When to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$expand"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$expand"]}," when an integration needs related data together with the main resource."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, a product response may include information about related variants when the endpoint supports expanding that collection."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"syntax","__idx":2},"children":["Syntax"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"$expand=EMBEDDED_COLLECTION_NAME\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://api2.saleslayer.com/catalog/rest/Catalog/Products?$select=prod_ref,prod_title&$expand=Variants\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-expansions","__idx":3},"children":["Supported expansions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported expansions depend on the resource and endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use metadata endpoints to understand available relationships:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://api2.saleslayer.com/catalog/rest/Catalog/Products/$metadata\nGET https://api2.saleslayer.com/catalog/rest/Catalog/Categories/$metadata\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"notes","__idx":4},"children":["Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Embedded collections are not included unless requested."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The migrated source documentation states that embedded collections are supported, while embedded individual resources are not documented as supported."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Expanding related data can increase response size; combine it with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$select"]}," and pagination where appropriate."]}]}]},"headings":[{"value":"Expand","id":"expand","depth":1},{"value":"When to use $expand","id":"when-to-use-expand","depth":2},{"value":"Syntax","id":"syntax","depth":2},{"value":"Supported expansions","id":"supported-expansions","depth":2},{"value":"Notes","id":"notes","depth":2}],"frontmatter":{"seo":{"title":"Expand query parameter","description":"How to use the $expand query parameter to include related Catalog API collections in responses."},"keywords":{"includes":["$expand","embedded collections","related resources","Catalog API"]},"metadata":{"redocly_category":"Guides","api_domain":"Catalog"}},"lastModified":"2026-06-03T15:57:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/expand","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}