Add or update 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 also have an unlimited number of price lists, unlike a location, which is limited to 5 price lists.
To retrieve a list of store regions, see getStoreRegions. To delete a store region, see deleteStoreRegion. To manipulate with the price lists associated with a region, see API calls addStoreRegionPriceList, editStoreRegionPriceList and removeStoreRegionPriceList.
This API call is available only if "Store regions" module has been enabled on your account.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| storeRegionID | Store region ID. Specify store region ID to edit an existing record. | integer | |
| name | Region 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 | |
| nameENG | string | ||
| nameSPA | string | ||
| nameGER | string | ||
| nameSWE | string | ||
| nameFIN | string | ||
| nameRUS | string | ||
| nameEST | string | ||
| nameLAT | string | ||
| nameLIT | string | ||
| nameGRE | string | ||
| code | Region code | 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 |
| Field name | Type | Description |
|---|---|---|
| storeRegionID | integer | Store region ID. |
This API call returns error code 1006 if "Store regions" module has not been enabled on your account.