{"items":[{"type":"link","fsPath":"index.page.tsx","metadata":{},"label":"Home","link":"/","routeSlug":"/"},{"type":"group","label":"API Reference","items":[{"type":"link","fsPath":"apis/index.md","metadata":{"type":"markdown","redocly_category":"API Reference","api_domain":"Overview"},"label":"Overview","link":"/apis","routeSlug":"/apis"},{"type":"link","fsPath":"apis/dam.md","metadata":{"type":"markdown","redocly_category":"API Reference","api_domain":"DAM"},"label":"DAM REST API","link":"/apis/dam","routeSlug":"/apis/dam"},{"type":"link","label":"Sales Layer DAM REST API","link":"/apis/dam-v2.0","routeSlug":"/apis/dam-v2.0"},{"type":"group","label":"Files","link":"/apis/dam-v2.0/files","routeSlug":"/apis/dam-v2.0/files","items":[{"label":"Filter Files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files/get","routeSlug":"/apis/dam-v2.0/files/paths/~1files/get","metadata":{"seo":{"title":"Filter Files","description":"Returns a paginated collection of the tenant's non-image files (documents, spreadsheets, archives, …),filtered and sorted using OData query options ($filter, $orderby, $top, $skip)."}},"httpPath":"/files"},{"label":"Create File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files/post","routeSlug":"/apis/dam-v2.0/files/paths/~1files/post","metadata":{"seo":{"title":"Create File","description":"Registers a new file from a publicly accessible URL, optionally tagging it. The file is fetched, checked against the supported formats and the size limit, and stored."}},"httpPath":"/files"},{"label":"Get File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files({reference})/get","routeSlug":"/apis/dam-v2.0/files/paths/~1files({reference})/get","metadata":{"seo":{"title":"Get File","description":"In DAM, files are identified by their filename (reference), which is unique per tenant.Use this endpoint to retrieve a specific file when you already know its filename."}},"httpPath":"/files({reference})"},{"label":"Patch File","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files({reference})/patch","routeSlug":"/apis/dam-v2.0/files/paths/~1files({reference})/patch","metadata":{"seo":{"title":"Patch File","description":"Partially updates an existing file identified by its filename (reference), which is unique per tenant — substitute its contents via a new url and/or replace its tags. At least one of these fields must be supplied."}},"httpPath":"/files({reference})"},{"label":"Delete File","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/files/paths/~1files({reference})/delete","routeSlug":"/apis/dam-v2.0/files/paths/~1files({reference})/delete","metadata":{"seo":{"title":"Delete File","description":"Deletes a file by its filename (reference), which is unique per tenant."}},"httpPath":"/files({reference})"}]},{"type":"group","label":"Images","link":"/apis/dam-v2.0/images","routeSlug":"/apis/dam-v2.0/images","items":[{"label":"Filter Images","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images/get","routeSlug":"/apis/dam-v2.0/images/paths/~1images/get","metadata":{"seo":{"title":"Filter Images","description":"Returns a paginated collection of the tenant's images, filtered and sorted using OData query options ($filter, $orderby, $top, $skip)."}},"httpPath":"/images"},{"label":"Create Image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images/post","routeSlug":"/apis/dam-v2.0/images/paths/~1images/post","metadata":{"seo":{"title":"Create Image","description":"Registers a new image from a publicly accessible URL, optionally tagging it. The image is downloaded, validated against the supported formats and size limits, and processed asynchronously in the background."}},"httpPath":"/images"},{"label":"Get Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images({reference})/get","routeSlug":"/apis/dam-v2.0/images/paths/~1images({reference})/get","metadata":{"seo":{"title":"Get Image","description":"In DAM, images are identified by their filename (reference), which is unique per tenant.Use this endpoint to retrieve a specific image when you already know its filename."}},"httpPath":"/images({reference})"},{"label":"Patch Image","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images({reference})/patch","routeSlug":"/apis/dam-v2.0/images/paths/~1images({reference})/patch","metadata":{"seo":{"title":"Patch Image","description":"Partially updates an existing image identified by its filename (reference), which is unique per tenant — substitute its file via a new url and/or replace its tags. At least one of these fields must be supplied."}},"httpPath":"/images({reference})"},{"label":"Delete Image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/dam-v2.0/images/paths/~1images({reference})/delete","routeSlug":"/apis/dam-v2.0/images/paths/~1images({reference})/delete","metadata":{"seo":{"title":"Delete Image","description":"Deletes an image by its filename (reference), which is unique per tenant."}},"httpPath":"/images({reference})"}]},{"type":"link","fsPath":"apis/catalog.md","metadata":{"type":"markdown","redocly_category":"API Reference","api_domain":"Catalog"},"label":"Catalog REST API","link":"/apis/catalog","routeSlug":"/apis/catalog"},{"type":"link","label":"Sales Layer Catalog REST API","link":"/apis/catalog-v2.0","routeSlug":"/apis/catalog-v2.0"},{"type":"group","label":"Attribute Sets","link":"/apis/catalog-v2.0/attribute-sets","routeSlug":"/apis/catalog-v2.0/attribute-sets","items":[{"label":"Filter Attribute Sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets/filterattributesetsasync","routeSlug":"/apis/catalog-v2.0/attribute-sets/filterattributesetsasync","metadata":{"seo":{"title":"Filter Attribute Sets","description":"Filters the tenant's <b>Attribute Set</b> resources using OData query options (<b>$select</b>, <b>$expand</b>, <b>$filter</b>, <b>$orderby</b>, <b>$skip</b>, <b>$top</b>, <b>$skipToken</b>). Result's paging is done using the default paging size options."}},"httpPath":"/AttributeSets"},{"label":"Get Attribute Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets/searchattributesetasync","routeSlug":"/apis/catalog-v2.0/attribute-sets/searchattributesetasync","metadata":{"seo":{"title":"Get Attribute Set","description":"Returns a single <b>Attribute Set</b> resource by its identifier, using OData query options (<b>$select</b>, <b>$expand</b>) to shape the result."}},"httpPath":"/AttributeSets({attributeSetIdentifier})"},{"label":"Filter Attribute Set Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets/filterproductsinattributesetasync","routeSlug":"/apis/catalog-v2.0/attribute-sets/filterproductsinattributesetasync","metadata":{"seo":{"title":"Filter Attribute Set Products","description":"Filters and returns a paginated collection of Product resources scoped to the given Attribute Set, using OData query options."}},"httpPath":"/AttributeSets({attributeSetIdentifier})/Products"},{"label":"Get Attribute Set Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets/getattributesetmetadataasync","routeSlug":"/apis/catalog-v2.0/attribute-sets/getattributesetmetadataasync","metadata":{"seo":{"title":"Get Attribute Set Metadata","description":"Returns the public metadata of the <b>Attribute Set</b> model as a JSON schema document describing the resources (<b>Product</b>, <b>Variant</b>) associated to the <b>Attribute Set</b> and the relationships between them. Use it to build requests against the various methods of the API."}},"httpPath":"/AttributeSets/$metadata"}]},{"type":"group","label":"Attribute Sets v2","link":"/apis/catalog-v2.0/attribute-sets-v2","routeSlug":"/apis/catalog-v2.0/attribute-sets-v2","items":[{"label":"Get Attribute Sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets-v2/getattributesets","routeSlug":"/apis/catalog-v2.0/attribute-sets-v2/getattributesets","metadata":{"seo":{"title":"Get Attribute Sets","description":"Returns all attribute sets defined for the tenant, each including its name, identifier,and form layout configuration for Products and Variants (ProductLayout, VariantLayout)."}},"httpPath":"/v2/AttributeSets"},{"label":"Create Attribute Set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets-v2/createattributeset","routeSlug":"/apis/catalog-v2.0/attribute-sets-v2/createattributeset","metadata":{"seo":{"title":"Create Attribute Set","description":"Creates a new attribute set for the tenant from the supplied name and optional Product andVariant form layouts, returning the created attribute set and a Location header pointing to it."}},"httpPath":"/v2/AttributeSets"},{"label":"Get Attribute Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets-v2/getattributeset","routeSlug":"/apis/catalog-v2.0/attribute-sets-v2/getattributeset","metadata":{"seo":{"title":"Get Attribute Set","description":"Returns a single attribute set identified by id. Accepted values:"}},"httpPath":"/v2/AttributeSets({id})"},{"label":"Update Attribute Set","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets-v2/updateattributeset","routeSlug":"/apis/catalog-v2.0/attribute-sets-v2/updateattributeset","metadata":{"seo":{"title":"Update Attribute Set","description":"Partially updates an existing attribute set identified by id. Accepted values:"}},"httpPath":"/v2/AttributeSets({id})"},{"label":"Delete Attribute Set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/attribute-sets-v2/deleteattributeset","routeSlug":"/apis/catalog-v2.0/attribute-sets-v2/deleteattributeset","metadata":{"seo":{"title":"Delete Attribute Set","description":"Deletes the attribute set identified by id (a positive integer). The tenant's defaultattribute set cannot be deleted."}},"httpPath":"/v2/AttributeSets({id})"}]},{"type":"group","label":"Categories","link":"/apis/catalog-v2.0/categories","routeSlug":"/apis/catalog-v2.0/categories","items":[{"label":"Filter Categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/filtercategoriesasync","routeSlug":"/apis/catalog-v2.0/categories/filtercategoriesasync","metadata":{"seo":{"title":"Filter Categories","description":"Filters the tenant's Categories using OData query options and returns the matchingresources as a paginated collection."}},"httpPath":"/Categories"},{"label":"Create Category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/createcategoryasync","routeSlug":"/apis/catalog-v2.0/categories/createcategoryasync","metadata":{"seo":{"title":"Create Category","description":"Creates a new Category from the supplied JSON object and returns its location in theLocation header."}},"httpPath":"/Categories"},{"label":"Get Category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/searchcategoryasync","routeSlug":"/apis/catalog-v2.0/categories/searchcategoryasync","metadata":{"seo":{"title":"Get Category","description":"Returns a single Category resource identified by its route identifier, optionally shapingthe response with $select and $expand."}},"httpPath":"/Categories({categoryIdentifier})"},{"label":"Update Category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/updatecategoryasync","routeSlug":"/apis/catalog-v2.0/categories/updatecategoryasync","metadata":{"seo":{"title":"Update Category","description":"Updates an existing Category identified by its route identifier, applying only the writablefields supplied in the request body (PATCH semantics)."}},"httpPath":"/Categories({categoryId})"},{"label":"Delete Category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/deletecategoryasync","routeSlug":"/apis/catalog-v2.0/categories/deletecategoryasync","metadata":{"seo":{"title":"Delete Category","description":"Deletes the Category identified by its route identifier."}},"httpPath":"/Categories({categoryId})"},{"label":"Filter Category Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/filterproductsincategoryasync","routeSlug":"/apis/catalog-v2.0/categories/filterproductsincategoryasync","metadata":{"seo":{"title":"Filter Category Products","description":"Filters and returns a paginated collection of Product resources scoped to the given Category, using OData query options."}},"httpPath":"/Categories({categoryIdentifier})/Products"},{"label":"Get Category Product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/searchproductincategoryasync","routeSlug":"/apis/catalog-v2.0/categories/searchproductincategoryasync","metadata":{"seo":{"title":"Get Category Product","description":"Returns a single Product resource by its identifier, scoped to the given Category."}},"httpPath":"/Categories({categoryIdentifier})/Products({productIdentifier})"},{"label":"Get Categories Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/filtercategorieschangelogasync","routeSlug":"/apis/catalog-v2.0/categories/filtercategorieschangelogasync","metadata":{"seo":{"title":"Get Categories Changelog","description":"Returns the changelog entries for the tenant's Categories as a collection, filterable andpageable with OData query options."}},"httpPath":"/Categories/Changelog"},{"label":"Get Category Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/filtercategorychangelogasync","routeSlug":"/apis/catalog-v2.0/categories/filtercategorychangelogasync","metadata":{"seo":{"title":"Get Category Changelog","description":"Returns the changelog entries for a single Category identified by its route identifier,filterable and pageable with OData query options."}},"httpPath":"/Categories({categoryIdentifier})/Changelog"},{"label":"Get Category Layout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/getcategoryformlayoutasync","routeSlug":"/apis/catalog-v2.0/categories/getcategoryformlayoutasync","metadata":{"seo":{"title":"Get Category Layout","description":"The layout describes how the Category edit form is rendered. It is a JSON document with asections array; each section has a title and a rows array; each row has afields array and, optionally, a divider (dividerType and dividerTitle).Each field carries an attributeId and a grid size — one of quarter,half, threeQuarters or row. When a row has a divider its dividerTypeis one of normal, wide or lineBreak. dividerType anddividerTitle are omitted from a row when they have no value, so a row without a dividercontains only its fields."}},"httpPath":"/Categories/layout"},{"label":"Update Category Layout","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/updatecategoryformlayoutasync","routeSlug":"/apis/catalog-v2.0/categories/updatecategoryformlayoutasync","metadata":{"seo":{"title":"Update Category Layout","description":"Fully overwrites the currently stored Category layout. The payload is not merged with theexisting layout — it replaces it entirely."}},"httpPath":"/Categories/layout"},{"label":"Get Category Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/categories/getcategorymetadataasync","routeSlug":"/apis/catalog-v2.0/categories/getcategorymetadataasync","metadata":{"seo":{"title":"Get Category Metadata","description":"The metadata is a JSON Schema document that describes:"}},"httpPath":"/Categories/$metadata"}]},{"type":"group","label":"Products","link":"/apis/catalog-v2.0/products","routeSlug":"/apis/catalog-v2.0/products","items":[{"label":"Filter Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/filterproductsasync","routeSlug":"/apis/catalog-v2.0/products/filterproductsasync","metadata":{"seo":{"title":"Filter Products","description":"Filters and returns a paginated collection of Product resources using OData query options."}},"httpPath":"/Products"},{"label":"Create Product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/createproductasync","routeSlug":"/apis/catalog-v2.0/products/createproductasync","metadata":{"seo":{"title":"Create Product","description":"Creates a new Product resource from the supplied JSON body and returns its location."}},"httpPath":"/Products"},{"label":"Get Product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/searchproductasync","routeSlug":"/apis/catalog-v2.0/products/searchproductasync","metadata":{"seo":{"title":"Get Product","description":"Returns a single Product resource by its identifier."}},"httpPath":"/Products({productIdentifier})"},{"label":"Update Product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/updateproductasync","routeSlug":"/apis/catalog-v2.0/products/updateproductasync","metadata":{"seo":{"title":"Update Product","description":"Updates an existing Product resource, applying only the fields supplied in the JSON body (PATCH semantics)."}},"httpPath":"/Products({productId})"},{"label":"Delete Product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/deleteproductasync","routeSlug":"/apis/catalog-v2.0/products/deleteproductasync","metadata":{"seo":{"title":"Delete Product","description":"Deletes the Product resource identified by the given identifier."}},"httpPath":"/Products({productId})"},{"label":"Filter Product Variants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/filtervariantsinproductasync","routeSlug":"/apis/catalog-v2.0/products/filtervariantsinproductasync","metadata":{"seo":{"title":"Filter Product Variants","description":"Filters the Variant resources nested within the specified Product using OData query options and returns the matching collection."}},"httpPath":"/Products({productIdentifier})/Variants"},{"label":"Get Product Variant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/searchvariantinproductasync","routeSlug":"/apis/catalog-v2.0/products/searchvariantinproductasync","metadata":{"seo":{"title":"Get Product Variant","description":"Returns a single Variant resource nested within the specified Product, with the published fields selected via OData query options."}},"httpPath":"/Products({productIdentifier})/Variants({variantIdentifier})"},{"label":"Get Products Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/filterproductschangelogasync","routeSlug":"/apis/catalog-v2.0/products/filterproductschangelogasync","metadata":{"seo":{"title":"Get Products Changelog","description":"Returns a paginated collection of changelog entries recording changes to Products, filterable with OData query options."}},"httpPath":"/Products/Changelog"},{"label":"Get Product Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/filterproductchangelogasync","routeSlug":"/apis/catalog-v2.0/products/filterproductchangelogasync","metadata":{"seo":{"title":"Get Product Changelog","description":"Returns a paginated collection of changelog entries for a single Product, filterable with OData query options."}},"httpPath":"/Products({productIdentifier})/Changelog"},{"label":"Get Product Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/products/getproductmetadataasync","routeSlug":"/apis/catalog-v2.0/products/getproductmetadataasync","metadata":{"seo":{"title":"Get Product Metadata","description":"The metadata is a JSON Schema document that describes:"}},"httpPath":"/Products/$metadata"}]},{"type":"group","label":"Variants","link":"/apis/catalog-v2.0/variants","routeSlug":"/apis/catalog-v2.0/variants","items":[{"label":"Filter Variants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/filtervariantsasync","routeSlug":"/apis/catalog-v2.0/variants/filtervariantsasync","metadata":{"seo":{"title":"Filter Variants","description":"Filters the tenant's Variant resources using OData query options and returns the matching collection."}},"httpPath":"/Variants"},{"label":"Create Variant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/createvariantasync","routeSlug":"/apis/catalog-v2.0/variants/createvariantasync","metadata":{"seo":{"title":"Create Variant","description":"Creates a new Variant resource from the supplied JSON body and returns its location in the Location header."}},"httpPath":"/Variants"},{"label":"Get Variant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/searchvariantasync","routeSlug":"/apis/catalog-v2.0/variants/searchvariantasync","metadata":{"seo":{"title":"Get Variant","description":"Returns a single Variant resource identified by its identifier, with the published fields selected via OData query options."}},"httpPath":"/Variants({variantIdentifier})"},{"label":"Update Variant","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/updatevariantasync","routeSlug":"/apis/catalog-v2.0/variants/updatevariantasync","metadata":{"seo":{"title":"Update Variant","description":"Updates the writable fields of an existing Variant from the supplied JSON body using PATCH semantics (only the supplied fields are modified)."}},"httpPath":"/Variants({variantId})"},{"label":"Delete Variant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/deletevariantasync","routeSlug":"/apis/catalog-v2.0/variants/deletevariantasync","metadata":{"seo":{"title":"Delete Variant","description":"Deletes the Variant resource identified by its identifier."}},"httpPath":"/Variants({variantId})"},{"label":"Get Variants Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/filtervariantschangelogasync","routeSlug":"/apis/catalog-v2.0/variants/filtervariantschangelogasync","metadata":{"seo":{"title":"Get Variants Changelog","description":"Returns the changelog entries recorded across the tenant's Variants, filtered and paged via OData query options."}},"httpPath":"/Variants/Changelog"},{"label":"Get Variant Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/filtervariantchangelogasync","routeSlug":"/apis/catalog-v2.0/variants/filtervariantchangelogasync","metadata":{"seo":{"title":"Get Variant Changelog","description":"Returns the changelog entries recorded for the Variant identified by its identifier, filtered and paged via OData query options."}},"httpPath":"/Variants({variantIdentifier})/Changelog"},{"label":"Get Variant Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/variants/getvariantmetadataasync","routeSlug":"/apis/catalog-v2.0/variants/getvariantmetadataasync","metadata":{"seo":{"title":"Get Variant Metadata","description":"The metadata is a JSON Schema document that describes:"}},"httpPath":"/Variants/$metadata"}]},{"type":"group","label":"Custom Entities","link":"/apis/catalog-v2.0/custom-entities","routeSlug":"/apis/catalog-v2.0/custom-entities","items":[{"label":"Filter Custom Entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/filtercustomentitiesasync","routeSlug":"/apis/catalog-v2.0/custom-entities/filtercustomentitiesasync","metadata":{"seo":{"title":"Filter Custom Entities","description":"Filters the items of a Custom Entity type, identified by its denominator, returning thematching resources as a collection. Supports OData query options for selecting, expanding,filtering, ordering and paging the results."}},"httpPath":"/CustomEntities('{customEntityDenominator}')"},{"label":"Create Custom Entity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/createcustomentityasync","routeSlug":"/apis/catalog-v2.0/custom-entities/createcustomentityasync","metadata":{"seo":{"title":"Create Custom Entity","description":"Creates a new item for a Custom Entity type, identified by its denominator, from the suppliedJSON object. On success returns 201 Created with the new resource location in the Location header."}},"httpPath":"/CustomEntities('{customEntityDenominator}')"},{"label":"Update Custom Entity","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/updatecustomentityasync","routeSlug":"/apis/catalog-v2.0/custom-entities/updatecustomentityasync","metadata":{"seo":{"title":"Update Custom Entity","description":"Updates an existing item of a Custom Entity type, identified by its denominator and itemidentifier, applying PATCH semantics so that only the supplied fields are modified. Returns200 OK when the update is applied."}},"httpPath":"/CustomEntities('{customEntityDenominator}')/item({itemId})"},{"label":"Delete Custom Entity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/deletecustomentityasync","routeSlug":"/apis/catalog-v2.0/custom-entities/deletecustomentityasync","metadata":{"seo":{"title":"Delete Custom Entity","description":"Deletes an item of a Custom Entity type, identified by its denominator and item identifier.Returns 204 No Content when the item has been deleted."}},"httpPath":"/CustomEntities('{customEntityDenominator}')/item({itemId})"},{"label":"Get Custom Entities Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/filtercustomentitieschangelogasync","routeSlug":"/apis/catalog-v2.0/custom-entities/filtercustomentitieschangelogasync","metadata":{"seo":{"title":"Get Custom Entities Changelog","description":"Returns the changelog entries for a Custom Entity type, identified by its denominator, as acollection. Supports OData query options to filter, order and page the results."}},"httpPath":"/CustomEntities('{customEntityDenominator}')/Changelog"},{"label":"Get Custom Entity Changelog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/filtercustomentitychangelogasync","routeSlug":"/apis/catalog-v2.0/custom-entities/filtercustomentitychangelogasync","metadata":{"seo":{"title":"Get Custom Entity Changelog","description":"Returns the changelog entries for a single Custom Entity item, identified by its denominatorand item identifier, as a collection. Supports OData query options to filter, order and pagethe results."}},"httpPath":"/CustomEntities('{customEntityDenominator}')/Changelog({itemIdentifier})"},{"label":"Get Custom Entity Layout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/getcustomentityformlayoutasync","routeSlug":"/apis/catalog-v2.0/custom-entities/getcustomentityformlayoutasync","metadata":{"seo":{"title":"Get Custom Entity Layout","description":"Unlike the Category model — which has a single layout shared by all categories — each CustomEntity type has its own layout, selected by the route's customEntityDenominator."}},"httpPath":"/CustomEntities('{customEntityDenominator}')/layout"},{"label":"Update Custom Entity Layout","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/updatecustomentityformlayoutasync","routeSlug":"/apis/catalog-v2.0/custom-entities/updatecustomentityformlayoutasync","metadata":{"seo":{"title":"Update Custom Entity Layout","description":"Each Custom Entity type has its own layout identified by customEntityDenominator. The suppliedlayout fully overwrites the currently stored layout for that Custom Entity; it is not merged."}},"httpPath":"/CustomEntities('{customEntityDenominator}')/layout"},{"label":"Get Custom Entities Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/getcustomentitiesmetadataasync","routeSlug":"/apis/catalog-v2.0/custom-entities/getcustomentitiesmetadataasync","metadata":{"seo":{"title":"Get Custom Entities Metadata","description":"The metadata is a JSON Schema document that lists the Custom Entities defined in the PIMfor the current tenant, together with their relationships. Use the returned denominatorsto query individual Custom Entity schemas via GET /CustomEntities('{denominator}')/$metadata."}},"httpPath":"/CustomEntities/$metadata"},{"label":"Get Custom Entity Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/custom-entities/getcustomentitymetadataasync","routeSlug":"/apis/catalog-v2.0/custom-entities/getcustomentitymetadataasync","metadata":{"seo":{"title":"Get Custom Entity Metadata","description":"The metadata is a JSON Schema document that describes the implicit and custom propertiesexposed by the specified Custom Entity resource. The schema should be consulted to buildrequests against the other Custom Entity endpoints (which fields can be used in $select,$filter, $orderby, request bodies, etc.)."}},"httpPath":"/CustomEntities('{customEntityDenominator}')/$metadata"}]},{"type":"group","label":"Metadata","link":"/apis/catalog-v2.0/metadata","routeSlug":"/apis/catalog-v2.0/metadata","items":[{"label":"Get Catalog Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/catalog-v2.0/metadata/getmetadataasync","routeSlug":"/apis/catalog-v2.0/metadata/getmetadataasync","metadata":{"seo":{"title":"Get Catalog Metadata","description":"Returns the Catalog metadata as a JSON Schema document describing every resource(Category, Attribute Set, Product, Variant, Point of Sale) and the relationshipsbetween them. Use it to build requests against the rest of the API."}},"httpPath":"/$metadata"}]}]},{"type":"group","label":"Postman collections","items":[{"type":"link","fsPath":"postman/index.md","metadata":{"type":"markdown","redocly_category":"Postman Collections","api_domain":"Cross API"},"label":"Overview and downloads","link":"/postman","routeSlug":"/postman"}]},{"type":"group","label":"Guides","items":[{"type":"link","fsPath":"guides/quickstart.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Quickstart","link":"/guides/quickstart","routeSlug":"/guides/quickstart"},{"type":"link","fsPath":"guides/introduction.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Introduction","link":"/guides/introduction","routeSlug":"/guides/introduction"},{"type":"link","fsPath":"guides/authentication.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Authentication","link":"/guides/authentication","routeSlug":"/guides/authentication"},{"type":"link","fsPath":"guides/base-url.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Base URL","link":"/guides/base-url","routeSlug":"/guides/base-url"},{"type":"link","fsPath":"guides/headers.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Headers","link":"/guides/headers","routeSlug":"/guides/headers"},{"type":"link","fsPath":"guides/rate-limiting.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Rate limiting","link":"/guides/rate-limiting","routeSlug":"/guides/rate-limiting"},{"type":"link","fsPath":"guides/pagination-and-filtering.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Pagination and filtering","link":"/guides/pagination-and-filtering","routeSlug":"/guides/pagination-and-filtering"},{"type":"link","fsPath":"guides/select.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Catalog"},"label":"Select","link":"/guides/select","routeSlug":"/guides/select"},{"type":"link","fsPath":"guides/filter.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Filter","link":"/guides/filter","routeSlug":"/guides/filter"},{"type":"link","fsPath":"guides/orderby.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Orderby","link":"/guides/orderby","routeSlug":"/guides/orderby"},{"type":"link","fsPath":"guides/expand.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Catalog"},"label":"Expand","link":"/guides/expand","routeSlug":"/guides/expand"},{"type":"link","fsPath":"guides/logical-operators.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Logical operators","link":"/guides/logical-operators","routeSlug":"/guides/logical-operators"},{"type":"link","fsPath":"guides/string-functions.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"String functions","link":"/guides/string-functions","routeSlug":"/guides/string-functions"},{"type":"link","fsPath":"guides/page-size-limits.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Page size limits","link":"/guides/page-size-limits","routeSlug":"/guides/page-size-limits"},{"type":"link","fsPath":"guides/pagination-strategies.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Pagination strategies","link":"/guides/pagination-strategies","routeSlug":"/guides/pagination-strategies"},{"type":"link","fsPath":"guides/current-limitations.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Current limitations","link":"/guides/current-limitations","routeSlug":"/guides/current-limitations"},{"type":"link","fsPath":"guides/recipes.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Recipes","link":"/guides/recipes","routeSlug":"/guides/recipes"},{"type":"link","fsPath":"guides/best-practices.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Best practices","link":"/guides/best-practices","routeSlug":"/guides/best-practices"},{"type":"link","fsPath":"guides/versioning-and-compatibility.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Versioning and compatibility","link":"/guides/versioning-and-compatibility","routeSlug":"/guides/versioning-and-compatibility"},{"type":"link","fsPath":"guides/success-responses.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Success responses","link":"/guides/success-responses","routeSlug":"/guides/success-responses"},{"type":"link","fsPath":"guides/error-responses.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Error responses","link":"/guides/error-responses","routeSlug":"/guides/error-responses"},{"type":"link","fsPath":"guides/errors.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"DAM"},"label":"DAM error details","link":"/guides/errors","routeSlug":"/guides/errors"},{"type":"link","fsPath":"guides/feedback-privacy.md","metadata":{"type":"markdown","redocly_category":"Guides","api_domain":"Cross API"},"label":"Feedback and privacy","link":"/guides/feedback-privacy","routeSlug":"/guides/feedback-privacy"}]},{"type":"group","label":"MCP Server","items":[{"type":"link","fsPath":"mcp-server/index.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Overview","link":"/mcp-server","routeSlug":"/mcp-server"},{"type":"link","fsPath":"mcp-server/quickstart.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Quickstart","link":"/mcp-server/quickstart","routeSlug":"/mcp-server/quickstart"},{"type":"link","fsPath":"mcp-server/authentication.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Authentication","link":"/mcp-server/authentication","routeSlug":"/mcp-server/authentication"},{"type":"link","fsPath":"mcp-server/permissions.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Access profiles and permissions","link":"/mcp-server/permissions","routeSlug":"/mcp-server/permissions"},{"type":"link","fsPath":"mcp-server/tools.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Tool reference","link":"/mcp-server/tools","routeSlug":"/mcp-server/tools"},{"type":"link","fsPath":"mcp-server/recipes.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Recipes","link":"/mcp-server/recipes","routeSlug":"/mcp-server/recipes"},{"type":"link","fsPath":"mcp-server/troubleshooting.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Troubleshooting","link":"/mcp-server/troubleshooting","routeSlug":"/mcp-server/troubleshooting"},{"type":"link","fsPath":"mcp-server/local-development.md","metadata":{"type":"markdown","redocly_category":"MCP Server","api_domain":"MCP"},"label":"Local install","link":"/mcp-server/local-development","routeSlug":"/mcp-server/local-development"}]},{"type":"link","fsPath":"changelog.md","metadata":{"type":"markdown","redocly_category":"Changelog","api_domain":"Cross API"},"label":"Changelog","link":"/changelog","routeSlug":"/changelog"}]}