Settings Resource
URL Endpoints
| Endpoint | Supported Metods |
|---|---|
| /[store-handle]/api/v2/settings.json | GET, PUT |
Data Structure
Settings can contain specific application settings under the key applications
GET
/[store-handle]/api/v2/webstore/settings.json
/static/support/documentation/examples/webstore-settings.json
| Name | Path | Type | Description | Example |
|---|---|---|---|---|
| type | uuid | string (readonly) | Resource type. | "settings" |
| handle | handle | string (readonly) | Store handle. | mystore |
| name | address | string | Store name. | "My Great Store" |
| string | Contact email. | "owner@store.com" | ||
| currency | currency | string | Currency code. | "USD", "EUR", "GBP" |
| weightUnit | weightUnit | string | Unit weights are expressed in. | "KG", "LBS" |
| shippingDefaultWeight | shippingDefaultWeight | string | Fallback weight for products without weight. | "1.00" |
| displayPriceIncludingTax | displayPriceIncludingTax | bool | Wether the displayPrice properties on products should include tax or not. | true, false |
| address | address | string | Store address. | |
| street1 | address.street1 | string | Street address. | "123, Broadway" |
| street2 | address.street2 | string | Street address line 2. | "Apt 4 Building 8" |
| city | address.city | string | City name. | "New York" |
| zipCode | address.zipCode | string | Zip/Postal code. | "90210" |
| stateCode | address.stateCode | string | State/Province code. | "NY" |
| stateName | address.stateName | string (readonly) | State/Province name. | "New York" |
| countryCode | address.countryCode | string | Country code. | "US" |
| countryName | address.countryName | string (readonly) | Country name. | "United States" |
| applications | applications | dictionary with dictionaries | Collections of settings for specific application settings that need to persist settings data. Keys are application identifiers. | "com.sofa.enstore-admin", "com.sofa.enstore-webstore" |