Search

addAssortmentProducts

Add products into an assortment.

An assortment defines which products a particular store is allowed to sell and/or to purchase.

To retrieve a list of assortments, see getAssortments. To edit an assortment or add a new one, see saveAssortment. To manipulate with the products associated with an assortment, see API calls getAssortmentProducts, editAssortmentProducts and removeAssortmentProducts. To retrieve all products that can be sold in location according to product status in assortment and it’s card see getSellableProducts.

This API call is available only if “Assortments” module has been enabled on your account.

Input parameters

Parameter nameDescriptionPossible valueRequired
productIDsComma-separated list of product IDs.String Yes
assortmentIDAssortment ID.Integer Yes
statusProduct status, possible statuses are 'ACTIVE', 'NO_LONGER_ORDERED', 'NOT_FOR_SALE' and 'ARCHIVED'. If you don't specify this field, products will be added to assortment with the default status 'ACTIVE'.String

Response

Field nameTypeDescription
productsAlreadyInAssortmentStringComma-separated list of already products that already exist in this assortment. Note that the status of these items will not be changed. To change the status of items that already are in the assortment, use editAssortmentProducts.
nonExistingIDsStringComma-separated list of non-existing products.

This API call returns error code 1006 if "Assortments" module has not been enabled on your account.