Retrieving Store Configuration

Last updated: July 31, 2020

Edit on GitHub

Depending on your project needs, you can set up a single store that serves all your business needs or have multiple stores designed for different applications or available in different countries. Regardless of how many stores you have, a store contains such generic configuration as the currencies that can be used in transactions, countries where a store is available, supported languages and the time zone of the store.

The configuration of the current store in a project can be retrieved via an endpoint provided by the Stores API.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see Glue Application Feature Integration.

Usage

To retrieve store configuration, send a GET request to the following endpoint: /stores Request sample: GET http://mysprykershop.com/stores The endpoint will respond with a RestStoresResponse.

Response sample

{
		"data": [
			{
				"type": "stores",
				"id": "DE",
				"attributes": {
					"timeZone": "Europe/Berlin",
					"defaultCurrency": "EUR",
					"currencies": [
						{
							"code": "EUR",
							"name": "Euro"
						},
						{
							"code": "CHF",
							"name": "Swiss Franc"
						}
					],
					"locales": [
						{
							"code": "en",
							"name": "en_US"
						},
						{
							"code": "de",
							"name": "de_DE"
						}
					],
					"countries": [
						{
							"iso2Code": "AT",
							"iso3Code": "AUT",
							"name": "Austria",
							"postalCodeMandatory": true,
							"postalCodeRegex": "\\d{4}",
							"regions": []
						},
						{
							"iso2Code": "DE",
							"iso3Code": "DEU",
							"name": "Germany",
							"postalCodeMandatory": true,
							"postalCodeRegex": "\\d{5}",
							"regions": []
						}
					]
				},
				"links": {
					"self": "http://mysprykershop.com/stores/DE"
				}
			}
		],
		"links": {
			"self": "http://mysprykershop.com/stores"
		}
}