Language and market models

Models for store languages, markets and price lists. Inspect the context returned to your integration before reading or updating localized resources.

Data schemas

Get store context — Response

ApiResponse_ContextData_ · Fields, types and constraints of data accepted or returned by the API.

dataContextData Required: Response example · ContextData.

Example: {"base_market_id":"example","default_locale":"en","global_enabled":false,"languages":[{"code":"en","direction":"ltr","is_default":true,"name":"English","native_name":"English","status":"draft"}],"markets":[{"code":"PL","currency":{"code":"PLN","minor_units":2},"id":"example","is_default":true,"name":"Poland","price_list":null,"status":"draft"}],"multilingual_enabled":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Additional fields: No

Get store context — Response

ContextData · Fields, types and constraints of data accepted or returned by the API.

base_market_idStringRequired: Identifier of the store's base market.

Example: "example"
default_localeStringRequired: Store's default language code.

Example: "en"
global_enabledBooleanRequired: global_enabled indicates the plan entitlement to additional markets. The base market works without this entitlement. There is no manual Shopently Global switch; multilingual mode is independent.

Example: false
languagesArray <LanguageData > Required: Languages available in the store context.

Example: [{"code":"en","direction":"ltr","is_default":true,"name":"English","native_name":"English","status":"draft"}]
marketsArray <shopently_engine__domains__global_commerce__adapters__public_http__context__schemas__MarketData > Required: Markets available in the store context.

Example: [{"code":"PL","currency":{"code":"PLN","minor_units":2},"id":"example","is_default":true,"name":"Poland","price_list":null,"status":"draft"}]
multilingual_enabledBooleanRequired: Whether multiple-language functionality is enabled.

Example: false

Additional fields: No

Currency code for the amount

CurrencyData · Schema · Language and market models

codeStringRequired: Stable machine-readable code.

Example: "PLN"
minor_unitsIntegerRequired: Number of fractional digits used by the currency.

Example: 2

Additional fields: No

Languages available in the store context

LanguageData · Schema · Language and market models

codeStringRequired

Stable machine-readable code.

Example: "en"

directionStringRequired

Text direction.

Constraints

enum: ["ltr", "rtl"]

Example: "ltr"

is_defaultBooleanRequired

Whether this is the default choice.

Example: true

nameStringRequired

Resource name in the relevant context.

Example: "English"

native_nameStringRequired

Name in the language's own writing system.

Example: "English"

statusStringRequired

Status accepted by this specific operation.

Constraints

enum: ["draft", "published"]

Example: "draft"

Additional fields: No

Markets available in the store context

shopently_engine__domains__global_commerce__adapters__public_http__context__schemas__MarketData · Schema · Language and market models

codeStringRequired

Stable machine-readable code.

Example: "PL"

currencyCurrencyData nullRequired

Currency code for the amount.

Example: {"code":"PLN","minor_units":2}

idStringRequired

Resource identifier; preserve it as returned. (MarketData).

Example: "example"

is_defaultBooleanRequired

Whether this is the default choice.

Example: true

nameStringRequired

Resource name in the relevant context.

Example: "Poland"

price_listPriceListData nullRequired

Price-list information.

Example: null

statusStringRequired

Status accepted by this specific operation.

Constraints

enum: ["draft", "sales_active", "suspended"]

Example: "draft"

Additional fields: No