{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"seo":{"title":"Versioning and compatibility","description":"Versioning, compatibility, and changelog expectations for Sales Layer REST APIs.","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":"versioning-and-compatibility","__idx":0},"children":["Versioning and compatibility"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page explains how to read API versions, compatibility expectations, and changelog entries in this documentation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"current-documented-versions","__idx":1},"children":["Current documented versions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The current references published in this site are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Current reference"},"children":["Current reference"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM REST API"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/dam-v2.0"},"children":["DAM REST API v2.0"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Catalog REST API"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/catalog-v2.0"},"children":["Catalog REST API v2.0"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the API overview pages for functional context and the OpenAPI references for endpoint-level details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"compatibility-expectations","__idx":2},"children":["Compatibility expectations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Versioned references describe the API behavior documented for that version."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Changes are usually considered compatible when they add functionality without requiring existing clients to change. Examples include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding a new endpoint."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding an optional request field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding a response field that clients can safely ignore."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding a new documented status code for a behavior that already existed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Improving examples or descriptions without changing API behavior."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Changes may require integration review when they affect existing requests or assumptions. Examples include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removing or renaming an endpoint."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removing or renaming a request or response field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changing required fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changing validation rules for existing fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changing pagination, filtering, or sorting behavior."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"client-recommendations","__idx":3},"children":["Client recommendations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Build integrations so they tolerate compatible additions:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ignore unknown response fields unless your workflow explicitly needs them."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validate only the fields your integration depends on."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store API version assumptions in integration documentation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Monitor the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/changelog"},"children":["Changelog"]}," before updating generated clients or request mappings."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Test critical workflows against the OpenAPI reference before releasing integration changes."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"changelog-usage","__idx":4},"children":["Changelog usage"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the changelog to understand documented changes over time."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For each new version, review:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added, changed, or removed endpoints."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Status code changes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request and response schema changes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validation behavior."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Documentation corrections that affect implementation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-pages","__idx":5},"children":["Related pages"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/changelog"},"children":["Changelog"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["API reference overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/current-limitations"},"children":["Current limitations"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/best-practices"},"children":["Best practices"]}]}]}]},"headings":[{"value":"Versioning and compatibility","id":"versioning-and-compatibility","depth":1},{"value":"Current documented versions","id":"current-documented-versions","depth":2},{"value":"Compatibility expectations","id":"compatibility-expectations","depth":2},{"value":"Client recommendations","id":"client-recommendations","depth":2},{"value":"Changelog usage","id":"changelog-usage","depth":2},{"value":"Related pages","id":"related-pages","depth":2}],"frontmatter":{"seo":{"title":"Versioning and compatibility","description":"Versioning, compatibility, and changelog expectations for Sales Layer REST APIs."},"keywords":{"includes":["versioning","compatibility","breaking changes","changelog"]},"metadata":{"redocly_category":"Guides","api_domain":"Cross API"}},"lastModified":"2026-06-03T15:43:35.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/versioning-and-compatibility","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}