Parent Products: Overview of Methods

A parent product is a product with variations. For example, a t-shirt is a parent product, while a blue t-shirt in size M and a white t-shirt in size L are its variations. A parent product is not a standalone item. It consolidates variations and stores common information: name, description, category. Price, currency, VAT, unit of measurement, and stock quantity are specified separately for each variation.

Differences between a parent product and a simple product:

  • A parent product cannot be purchased directly; one must select one of its variations. To work with variations, use the group of methods catalog.product.offer.*.

  • A simple product is a single item without variations. It can be added to the cart and purchased immediately. To work with simple products, use the group of methods catalog.product.*.

Quick navigation: all methods

User documentation: Add products to the catalog

Relationship of Parent Products with 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 method catalog.catalog.list.

Sections of the Trade Catalog. Parent products are usually distributed across sections. To create and manage sections, use the group of methods catalog.section.*.

Images. A parent product can contain images: for the announcement, detailed view, and additional images. To add images, use the methods catalog.productImage.*, and to download, use the method catalog.product.sku.download.

User. Each product stores the identifiers of users who created and modified it. User information can be obtained using the methods user.get and user.search.

Product and Variation Properties. Parent products can have additional properties: manufacturer, season, or material. You can work with properties using the methods catalog.productProperty.*.

CRM. In parent products, you can specify leads, deals, SPAs, invoices, contacts, and companies using the property type "Link to CRM entities."

Overview of Methods

Scope: catalog

Who can execute the method: administrator

Method

Description

catalog.product.sku.add

Adds a parent product to the trade catalog

catalog.product.sku.update

Updates fields of the parent product

catalog.product.sku.get

Returns field values of the parent product by identifier

catalog.product.sku.list

Returns a list of parent products by filter

catalog.product.sku.download

Downloads files of the parent product based on the provided parameters

catalog.product.sku.delete

Deletes a parent product

catalog.product.sku.getFieldsByFilter

Returns fields of the parent product by filter