Search

saveAssortment

Add or update 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 delete an assortment, see deleteAssortment. To manipulate with the products associated with an assortment, see API calls getAssortmentProducts, 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 edit an existing record.Integer
nameAssortment name. Use either general parameter "name" or one or more of the following parameters if you need to set the names in specific languages.String
nameENGString
nameSPAString
nameGERString
nameSWEString
nameFINString
nameRUSString
nameESTString
nameLATString
nameLITString
nameGREString
codeAssortment code. ERPLY itself does not use assortment code for any purpose, but it may be useful for integrations.String
attributeName#Attribute name. Name can only contain the following symbols: A-Z, a-z, 0-9, dash and underscore.String
attributeType#Attribute type, possible types are 'text', 'int' and 'double'. By default 'text'.String
attributeValue#Value of the attribute. Set value to 'null' or 'undefined' to delete an attribute.
'text' attribute can be any string, maximum 255 characters.
'int' must be a signed 32-bit integer.
'double' must be a decimal number.
String

Response

Field nameTypeDescription
assortmentIDIntegerAssortment ID.

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