Web Service Endpoint

Get Multiple Storefronts

Fetch one or more storefronts by using their identifiers.

URL

GET https://api.music.apple.com/v1/storefronts

Query Parameters

ids
[string]
(Required)

A list of the identifiers (ISO 3166 alpha-2 country codes) for the storefronts you want to fetch.

l
string

The localization to use, specified by a language tag. Any supported language tag may be used here. If none is specified, en-US is used.

Response Codes

OK

The request was successful.

Discussion

If successful, the HTTP status code is 200 (OK) and the data array in the ResponseRoot object contains one or more Storefront objects. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. See Handle a Response.

Example

https://api.music.apple.com/v1/storefronts?ids=us,ca,cn,au,hk
{ "data": [ { "attributes": { "defaultLanguageTag": "en-US", "name": "United States", "supportedLanguageTags": [ "en-US", "es-MX" ] }, "href": "/v1/storefronts/us", "id": "us", "type": "storefronts" }, { "attributes": { "defaultLanguageTag": "en-CA", "name": "Canada", "supportedLanguageTags": [ "en-CA", "fr-CA" ] }, "href": "/v1/storefronts/ca", "id": "ca", "type": "storefronts" }, { "attributes": { "defaultLanguageTag": "zh-Hans-CN", "name": "China", "supportedLanguageTags": [ "zh-Hans-CN", "en-GB" ] }, "href": "/v1/storefronts/cn", "id": "cn", "type": "storefronts" }, { "attributes": { "defaultLanguageTag": "en-AU", "name": "Australia", "supportedLanguageTags": [ "en-AU" ] }, "href": "/v1/storefronts/au", "id": "au", "type": "storefronts" }, { "attributes": { "defaultLanguageTag": "zh-Hant-HK", "name": "Hong Kong", "supportedLanguageTags": [ "zh-Hant-HK", "zh-Hant-TW", "en-GB" ] }, "href": "/v1/storefronts/hk", "id": "hk", "type": "storefronts" } ]}

See Also

Storefronts

Get a Storefront

Fetch a single storefront by using its identifier.

Get All Storefronts

Fetch all the storefronts in alphabetical order.

Get a User's Storefront

Fetch a user’s storefront.