{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown","redocly_category":"Postman Collections","api_domain":"Cross API"},"seo":{"title":"Postman collections","description":"Download and import the Sales Layer Postman collection and environment to test every DAM and Catalog REST API endpoint safely.","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":"postman-collections","__idx":0},"children":["Postman collections"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Sales Layer Postman collection to test the DAM and Catalog REST APIs from a controlled local workspace."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The collection is built for prospects, customers, and implementation partners who want to validate connectivity, authentication, headers, query parameters, and complete request flows before building an integration. It includes at least one ready-to-run example of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["every endpoint"]}," exposed by the current OpenAPI specifications."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-the-collection-covers","__idx":1},"children":["What the collection covers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requests are organized to match the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["API reference"]},". Read-only requests come first; write requests are grouped per resource and clearly labeled."]},{"$$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":"Folder"},"children":["Folder"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Contents"},"children":["Contents"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup checks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quick read-only connectivity and authentication checks for both APIs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DAM REST API v2.0"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List and filter images, and delete an image."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Catalog REST API v2.0 / Metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Schema discovery for the Catalog model, Products, Variants, Categories, Custom Entities, and Points of Sale."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Catalog REST API v2.0 / Products"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List, filter, get, get within a category, get within an attribute set, create, update, delete, and changelogs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Catalog REST API v2.0 / Variants"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List, get, list within a product, get within a product, create, update, delete, and changelogs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Catalog REST API v2.0 / Categories"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List, list with expanded products, get, create, update, delete, and changelogs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Catalog REST API v2.0 / Custom Entities"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List items, create, update, delete, and item changelogs."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept-Language"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$filter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$orderby"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$expand"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$top"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$skip"]}," values in each request are starting examples. Field names such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod_ref"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cat_ref"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["frmt_ref"]}," depend on the account. Confirm the available fields with the matching metadata request before adapting a query or a write payload."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"downloads","__idx":2},"children":["Downloads"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Import both files into Postman:"]},{"$$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":"File"},"children":["File"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/postman-assets/sales-layer-rest-api.postman_collection.json"},"children":["Sales Layer REST APIs collection"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requests grouped by setup checks, DAM REST API v2.0, and Catalog REST API v2.0 resources."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/postman-assets/sales-layer-rest-api.postman_environment.json"},"children":["Sales Layer API environment template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Environment variables for base URL, API key, language, and reusable test identifiers."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The environment template does not contain a real API key. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}," variable is intentionally empty and marked as a secret."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"import-into-postman","__idx":3},"children":["Import into Postman"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open Postman."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Import"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Import ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sales-layer-rest-api.postman_collection.json"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Import ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sales-layer-rest-api.postman_environment.json"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sales Layer API - Template"]}," environment in the top-right environment selector."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the environment and set the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Current value"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}," to the API key provided by Sales Layer."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Save the environment."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keep API keys out of exported files, screenshots, shared workspaces, and source control."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environment-variables","__idx":4},"children":["Environment variables"]},{"$$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":"Variable"},"children":["Variable"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api2.saleslayer.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base URL for the current Sales Layer REST APIs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty secret"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key sent as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-API-KEY"]},". Set this locally in Postman."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["acceptLanguage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language or locale preference sent as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept-Language"]}," for Catalog requests."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["damImageId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For DAM delete tests"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DAM image id used by the delete request. Set it to a controlled test image."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogProductIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For single-product tests"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product identifier. Filled automatically after a successful create-product request, or set manually."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogCategoryIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For category and in-category tests"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Category identifier. Filled automatically after a successful create-category request, or set manually."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogVariantIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For variant tests"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Variant identifier. Filled automatically after a successful create-variant request, or set manually."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attributeSetIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For products-in-attribute-set tests"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attribute set identifier from the account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customEntityDenominator"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For custom entity tests"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom entity denominator. Discover available values with the Custom Entities metadata request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customEntityItemId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For custom entity item tests"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Empty"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom entity item identifier. Filled automatically after a successful create-item request, or set manually."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recommended-first-run","__idx":5},"children":["Recommended first run"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start with read-only requests that do not modify data:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup checks / Catalog service metadata"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup checks / DAM list first page"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Catalog REST API v2.0 / Metadata / Products metadata"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Catalog REST API v2.0 / Products / List products"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DAM REST API v2.0 / List images with pagination"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These requests verify the base URL, API key, and account access without creating, updating, or deleting resources."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"testing-write-operations","__idx":6},"children":["Testing write operations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Write requests are labeled ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["(write)"]}," and live alongside the read requests for each resource. Run them only against a test account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Catalog create requests include a test script that captures the created identifier into the matching environment variable (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogProductIdentifier"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogCategoryIdentifier"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogVariantIdentifier"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customEntityItemId"]},"). This lets you run a full lifecycle in order, for example:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create category (write)"]}," — stores the new id in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogCategoryIdentifier"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create product (write)"]}," — uses that category and stores the new id in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["catalogProductIdentifier"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update product (write)"]}," — sends a partial update."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get product by identifier"]}," — confirms the change."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete product (write)"]}," — removes the test product."]}]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method and endpoint"},"children":["Method and endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete DAM image"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /dam/image/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["damImageId"]},". Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409 Conflict"]}," if the image is still processing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create / update / delete category"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /catalog/rest/Catalog/Categories"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Body fields come from the Categories metadata."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create / update / delete product"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /catalog/rest/Catalog/Products"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cat_id"]}," accepts a single id or an array for multi-category assignment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create / update / delete variant"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /catalog/rest/Catalog/Variants"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod_id"]}," links the variant to its parent product."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create / update / delete custom entity item"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /catalog/rest/Catalog/CustomEntities('{denominator}')"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Body fields depend on the custom entity definition."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before running write requests, confirm that the account and environment are safe for testing."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"discovering-fields-with-metadata","__idx":7},"children":["Discovering fields with metadata"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Catalog fields vary by account configuration. Use the metadata requests before building specific queries or write payloads:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /catalog/rest/Catalog/$metadata\nGET /catalog/rest/Catalog/Products/$metadata\nGET /catalog/rest/Catalog/Categories/$metadata\nGET /catalog/rest/Catalog/Variants/$metadata\nGET /catalog/rest/Catalog/CustomEntities/$metadata\nGET /catalog/rest/Catalog/CustomEntities('{denominator}')/$metadata\nGET /catalog/rest/Catalog/PointsOfSale/$metadata\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After confirming available fields, adjust ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$select"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$filter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$orderby"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$expand"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$top"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$skip"]}," values in Postman as needed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"headers-used-by-the-collection","__idx":8},"children":["Headers used by the collection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The collection sends the API key through Postman's collection-level authentication:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"X-API-KEY: {{apiKey}}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requests also use:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"Accept: application/json\nContent-Type: application/json\nAccept-Language: {{acceptLanguage}}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," is only required for requests with a JSON body. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept-Language"]}," supports exact language or locale codes; q-factor weighting and the wildcard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}," are not supported."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":9},"children":["Troubleshooting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If a request fails, check the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sales Layer API - Template"]}," environment is selected."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}," has a current value in the selected environment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseUrl"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api2.saleslayer.com"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The API key is valid for the account and API area being tested."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Catalog identifiers and field names exist in the current account metadata."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["DAM delete requests use a valid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["damImageId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rate limiting may apply (50 requests per 10 seconds). Retry after a short delay if you receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," response."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-pages","__idx":10},"children":["Related pages"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/headers"},"children":["Headers"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/base-url"},"children":["Base URL"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/rate-limiting"},"children":["Rate limiting"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["API reference overview"]}]}]}]},"headings":[{"value":"Postman collections","id":"postman-collections","depth":1},{"value":"What the collection covers","id":"what-the-collection-covers","depth":2},{"value":"Downloads","id":"downloads","depth":2},{"value":"Import into Postman","id":"import-into-postman","depth":2},{"value":"Environment variables","id":"environment-variables","depth":2},{"value":"Recommended first run","id":"recommended-first-run","depth":2},{"value":"Testing write operations","id":"testing-write-operations","depth":2},{"value":"Discovering fields with metadata","id":"discovering-fields-with-metadata","depth":2},{"value":"Headers used by the collection","id":"headers-used-by-the-collection","depth":2},{"value":"Troubleshooting","id":"troubleshooting","depth":2},{"value":"Related pages","id":"related-pages","depth":2}],"frontmatter":{"seo":{"title":"Postman collections","description":"Download and import the Sales Layer Postman collection and environment to test every DAM and Catalog REST API endpoint safely."},"keywords":{"includes":["Postman","collection","environment","API testing"]},"metadata":{"redocly_category":"Postman Collections","api_domain":"Cross API"}},"lastModified":"2026-06-05T19:23:35.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/postman","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}