Skip to main content

​
Catalog Administration

The Catalog Administration APIs are a collection of resources for configuring the catalogs and products offered to your shoppers, including discounts and coupon sets, faceting, price lists, and different types or variations of products. See the Catalog user guides for information about the related features in the Unified Commerce Admin. Use the Attributes resource to manage localization and attribute configurations for your catalogs. This current version of the Attributes API includes localizedContent to support multi-locale catalogs, which was not present in the legacy API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access attribute data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”. Use the Categories resource to organize products and control where they appear on the storefront. Create and maintain a hierarchy of categories and subcategories where the site will store properties. This current version of the Categories API includes localizedContent to support multi-locale catalogs, which was not present in the legacy API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access category data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”. Use the Coupon Sets resource to view and create coupon sets. You can use coupon sets to group multiple coupon codes together and associate them with one or more discounts. Use the Currency resource to manage the currency localization rules and exchange rates for any of the currencies that are supported for placing orders in. Use the Discounts and Discount Settings resources to define and manage discounts to apply to products, product categories, or orders. This current version of the Discounts API includes localizedContent to support multi-locale catalogs, which was not present in the legacy Products API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access discount data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”. Use the Facets resource to manage the facets shoppers use to filter product display results on a storefront. Facets can include categories, product attributes, or prices, and use either a range of values or discrete values. Use the Master Catalog resource to view details of the master catalogs associated with a tenant and to manage the product publishing mode for each master catalog. Use the Price Lists resources to view and create price lists. You can use price lists to override the catalog pricing of products for specific customer segments and/or sites. Use the Products, Product Types/Extras/Options/Properties, and Product Sort Definitions resources to create new product definitions in the master catalog and determine which catalogs will feature products. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the legacy Products API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access product data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”. Use the Publishing resource to publish pending product updates together as part of a set. Use the Search resource to manage all settings and options for providing product search on your site, as well as search tuning rules.