commerce/catalog

A collection of resources related to catalogs and catalog management.

Resource Description
commerce/catalog/admin/attributedefinition/attributes

Attributes are used to add custom definitions and characteristics to the following objects:

  • Product attributes — are attributes that define the characteristics of products, enabling you to uniquely describe a product. They consist of options, properties, and extras. Refer to Product Attributes in the Guides section for more information.
  • Customer attributes — are custom attributes that you can apply to customer accounts to add further definition for special uses, such as marketing campaigns, or discounts. Refer to Customer Attributes in the Guides section for more information.
  • Order attributes — are custom attributes that enable you to uniquely describe an aspect of an order. Depending on the attribute definition, either you or a shopper can enter values for the order attribute. Refer to Order Attributes in the Guides section for more information.
commerce/catalog/admin/attributedefinition/producttypes

Use the Product Types resource to manage the types for your product catalog. Product types act as configuration templates, which store a set of attributes common to all products associated with that type. Unlike categories, products can only be associated with a single product type.

commerce/catalog/admin/categories

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.

commerce/catalog/admin/discounts

Use the Discounts resource to define and manage discounts to apply to products, product categories, or orders. The discounts can be a specified amount off the price, percentage off the price, or for free shipping. You can create a coupon code that shoppers can use to redeem the discount.

commerce/catalog/admin/facets

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.

commerce/catalog/admin/locationinventory

Use the Location Inventory resource to manage the level of active product inventory maintained at each defined location, at the location level.

commerce/catalog/admin/mastercatalogs

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.

commerce/catalog/admin/productreservations

Use the Product Reservations resource to temporarily hold a product from inventory while a shopper is filling out payment information. You can create a product reservation when a shopper proceeds to check out and then release the reservation when the order process is complete.

commerce/catalog/admin/products

Use the Product Administration resource to create new product definitions in the master catalog and determine which catalogs will feature products. You can also assign attribute values for defined products, manage product-level location inventory, and configure the variations of a product.

commerce/catalog/admin/publishing

Use the Product Publishing resource to publish or discard pending changes to products in a master catalog, or to add or remove pending changes to and from product publish sets.

You can use product publish sets to group pending product changes together and publish them all at the same time.

commerce/catalog/admin/search

Use the Search resource to manage all settings and options for providing product search on your site, as well as search tuning rules.

commerce/catalog/storefront/categories

Use the Storefront Categories resource to view the product category hierarchy as it appears to shoppers who are browsing the storefront. The hierarchy can be returned as a flat list or as a category tree.

commerce/catalog/storefront/products

Use the Storefront Products resource to manage the shopper product selection process during a visit to the web storefront. You can update product options as shoppers pick and choose their product choices. A shopper cannot add a product to a cart until all of its required options have been selected.

commerce/catalog/storefront/productsearch

Use the Product Search resource to provide dynamic search results to shoppers as they browse and search for products on the web storefront, and to suggest possible search terms as the shopper enters text.

commerce/catalog/storefront/shipping

Use the Storefront Shipping resource to retrieve shipping rate information from the website.