Search

addStoreRegionPriceList

Associate a price list with a store region.

Store regions can be used for grouping stores (locations, warehouses). The main feature of store regions is that price lists can also be applied to a region, not just individual stores, thereby simplifying price list management. A region can have an unlimited number of price lists, unlike a location, which is limited to 5 price lists.

To retrieve a list of regions (and price lists associated with them), see getStoreRegions. To reorder region price lists, see editStoreRegionPriceList. To remove a price list from a region, see removeStoreRegionPriceList.

The price lists associated with a region will be automatically applied when making a sale from POS or creating a sales document in ERPLY back office, or when calling API calculateShoppingCart.

It is also possible to make a price list apply only to a specific customer group, in a region. For that, see API calls addStoreRegionCustomerGroupPriceList, editStoreRegionCustomerGroupPriceList and removeStoreRegionCustomerGroupPriceList.

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

Input parameters

Parameter nameDescriptionPossible valueRequired
priceListIDPrice list ID.Integer Yes
storeRegionIDStore region ID.Integer Yes
positionNumber

Price list's position.

Specify this input parameter if you want to place the price list to a specific position, among this region's price lists; positionNumber = 1 sets it as the region's first price list (and moves the existing ones down), positionNumber = 2 sets it as the second price list and so on.

If you do not set this parameter, a new price list will be added to the end, after all the existing ones.

Price lists will be applied by ERPLY in the same order, meaning that each successive price list "overwrites" the previous one, or applies its discount percentage on top of the previous list price. Hence, the last price list has the highest priority. Location (store) price lists will be applied on top of region price lists.

If you specify a negative or zero value, error 1016 will be returned.

Integer

This API call returns error code 1006 if "Store regions" module has not been enabled on your account, or error code 1026 if this price list has already been associated with this region.