Parsequerade / docs
App Store Version Localizations
GET/apps/{appId}/versions/{versionId}/localizations/{locale}

Implemented · First release · Operator configuration and deployment required

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/apps/1234567890/versions/version_123/localizations/en-US" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
appIdRequiredstringApple’s app ID. Returned by List apps.
versionIdRequiredstringAn explicit version ID belonging to this app. Select it from the version list.
localeRequiredstringThe exact locale to read. No fallback to a different locale.

Query parameters

NameTypeDescription
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
Valuesdescription, locale, keywords, marketingUrl, promotionalText, supportUrl, whatsNew

Response

One flat object for the selected resource.

200 · application/json
{
  "id": "localization_456",
  "appId": "1234567890",
  "versionId": "version_123",
  "locale": "en-US",
  "description": "Keep your notes organized.",
  "keywords": "notes,productivity,writing",
  "marketingUrl": null,
  "supportUrl": "https://example.com/support",
  "promotionalText": "A clearer place for your ideas.",
  "whatsNew": "Faster search and improved offline editing."
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
appIdstringThe app that owns this resource.
versionIdstringThe selected App Store version.
descriptionstring | nullThe localized store description.
localestring | nullThe exact Apple locale identifier, such as en-US.
keywordsstring | nullThe localized keywords, returned as Apple’s comma-separated string.
marketingUrlstring · uri | nullThe localized marketing website. Null remains null.
promotionalTextstring | nullThe localized promotional text shown on the product page.
supportUrlstring · uri | nullThe localized support website.
whatsNewstring | nullThe localized release notes for this version.

Behavior

  • Choose versionId from the app’s version list. The adapter checks that it belongs to appId and resolves locale against that version’s localizations.
  • A missing locale returns 404 localization_not_found. The service does not substitute the primary locale or create a localization during a GET.
  • App name, subtitle, and privacy URLs belong to app-info localizations. They are separate from the version listing shown here.

Errors

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404localization_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
409ambiguous_selectionMore than one localization matches the selected parent and locale.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.

Apple mapping

Upstream route and translation

The adapter calls GET /v1/appStoreVersionLocalizations/{id}. Read Apple’s original endpoint ↗

Resolve the parent’s localization collection using the exact locale, validate ownership, and then supply the resolved ID to this Apple endpoint.

Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.

Facade parameterTypeDescription
fieldsqueryfields[appStoreVersionLocalizations]

Reviewed 2026-10-14 · OpenAPI 4.5.1