Products in the Trade Catalog: Overview of Methods
Using REST methods, you can create simple products or services, as well as products with variations.
A simple product or service is a single inventory item with a name and unit of measurement. A product variation is a trade offer where the product has additional characteristics: color and size. For each combination of characteristics, a separate inventory item with a unique SKU is created.
Quick navigation: all methods and events
User documentation:
Linking Products to Other Objects
Trade Catalog. A product must be linked to a specific trade catalog. You can obtain the identifiers of available trade catalogs using the catalog.catalog.list method.
Sections of the Trade Catalog. Products are typically distributed across sections. To create and manage sections, use the group of methods catalog.section.* .
Units of Measurement. You can add the necessary units of measurement using the catalog.measure.* methods.
Product and Variation Images. To help customers understand what the product is, add product images: a detailed picture, a preview image, as well as additional images. For this, use the catalog.productImage.* methods.
Product and Variation Properties. All products and variations in the online store have a set of properties that distinguish them from one another, such as color or size. These properties help customers search for and select products on the site. Create properties using the catalog.productProperty.* methods.
Price Types. Price types allow you to manage different pricing categories. A single product can have multiple prices: wholesale, retail, partner. To manage price types, use the catalog.priceType.* methods.
Price. Specify the product price using the catalog.price.* methods.
Inventory Management. If inventory management is enabled, you do not need to specify the available quantity when creating or editing a product — inventory management will automatically set the values.
Overview of Methods and Events
Scope:
catalogWho can perform methods: administrator
Products
|
Method |
Description |
|
Adds a product |
|
|
Updates product fields |
|
|
Returns product field values by identifier |
|
|
Returns a list of products by filter |
|
|
Downloads product files by provided parameters |
|
|
Deletes a product |
|
|
Returns product fields by filter |
|
Event |
Triggered |
|
When a product is added |
|
|
When a product is updated |
|
|
When a product is deleted |
Services
|
Method |
Description |
|
Adds a service |
|
|
Updates service fields |
|
|
Returns service field values by identifier |
|
|
Returns a list of services by filter |
|
|
Downloads service files by provided parameters |
|
|
Deletes a service |
|
|
Returns service fields by filter |
|
Event |
Triggered |
|
When a service is added |
|
|
When a service is updated |
|
|
When a service is deleted |
Products with Variations: Parent Products
|
Method |
Description |
|
Adds a parent product |
|
|
Updates parent product fields |
|
|
Returns parent product field values by identifier |
|
|
Returns a list of parent products by filter |
|
|
Downloads parent product files by provided parameters |
|
|
Deletes a parent product |
|
|
Returns parent product fields by filter |
|
Event |
Triggered |
|
When a parent product is added |
|
|
When a parent product is updated |
|
|
When a parent product is deleted |
Products with Variations: Variations
|
Method |
Description |
|
Adds a product variation |
|
|
Updates product variation fields |
|
|
Returns product variation field values by identifier |
|
|
Returns a list of product variations by filter |
|
|
Downloads product variation files by provided parameters |
|
|
Deletes a product variation |
|
|
Returns product variation fields by filter |
|
Event |
Triggered |
|
When a variation is added |
|
|
When a variation is updated |
|
|
When a variation is deleted |