Search

getAssortmentProducts

Get a list of products contained in 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 delete an assortment, see deleteAssortment. To manipulate with the products associated with an assortment, see API calls addAssortmentProducts, 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
assortmentIDAssortment ID. Specify assortment ID to get associated products.Integer yes
recordsOnPageNumber of records API should return. By default 1000, at most 1000.Integer
pageNoAPI returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".Integer

Response

Field nameTypeDescription
productIDIntegerProduct ID.
statusStringProduct status: 'ACTIVE', 'NO_LONGER_ORDERED', 'NOT_FOR_SALE' or 'ARCHIVED'.

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