Create market

POST 
/openapi/2026-01/markets

Create a market with a name and covered countries.

Request

application/json

Body

Bodyrequired

namestringrequired

Market name. Maximum 50 characters. Must be unique within the store

countriesstring[]required

Covered countries, ISO 3166-1 alpha-2 codes in upper case (e.g., US, JP). A country may belong to only one market

confirmboolean

Confirmation flag. When false (default) and any country is already occupied by other markets, the request is rejected and the markets that would be deleted are returned. Resubmit with true to proceed; those occupied markets will be automatically deleted

Example

{
  "name": "string",
  "countries": [
    "string"
  ],
  "confirm": true
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

market object

The created market

idstring

Market ID

market_namestring

Market name

is_primaryboolean

Whether this is the primary market

is_defaultboolean

Whether this is the default market

market_statusstring

Market status: active or paused

currencystring

Base currency (ISO 4217)

symbol object

Currency symbol detail

valstring

Symbol value (e.g., £)

leftstring

Symbol placed to the left of the amount

rightstring

Symbol placed to the right of the amount

cn_namestring

Chinese name of the currency

titlestring

Currency title

codestring

Currency code (ISO 4217)

domain_typestring

Domain mode: primary or sub_path

domain_valuestring

Domain value (primary domain or sub-path suffix)

custom_rate_enabledboolean

Whether a custom exchange rate is enabled. Read-only; cannot be modified via the price update endpoint

custom_exchange_ratedouble

Custom exchange rate value. Read-only

price_adjustint64

Price adjustment percentage. Range -99 to 999

local_currency_enabledboolean

Whether local-currency display is enabled

product_tax_includedboolean

Whether product prices already include tax

default_languagestring

Default language code (IETF) of this market

countriesstring[]

Covered countries (ISO 3166-1 alpha-2)

languages object[]

Languages configured on this market

Array [

codestring

IETF language code (e.g., zh-CN)

namestring

Language display name

is_enabledboolean

Whether the language is enabled

urlstring

Storefront URL of the language under this market

is_defaultboolean

Whether this language is the market's default language

]

language_manageableboolean

Whether languages of this market are manageable

urlstring

Storefront URL of this market

created_atstring

Creation time, formatted as ISO-8601

updated_atstring

Last update time, formatted as ISO-8601

actual_ratedouble

Actual exchange rate

exchange_rate object

Exchange rate detail

currencystring

Source currency code (ISO 4217)

to_currencystring

Target currency code (ISO 4217)

ratedouble

Exchange rate value

last_updated_atstring

Last update time of the rate, formatted as ISO-8601

back_exchange_rate object

Reverse exchange rate detail

currencystring

Source currency code (ISO 4217)

to_currencystring

Target currency code (ISO 4217)

ratedouble

Exchange rate value

last_updated_atstring

Last update time of the rate, formatted as ISO-8601

setting object

Market storefront settings

redirect_enabledboolean

Whether market redirect is enabled

price_round_enabledboolean

Whether price rounding is enabled

geolocation_app_installedboolean

Whether the geolocation app is installed

language_selector_enabledboolean

Whether the language selector is enabled

delivery_country_limitedboolean

Whether delivery countries are limited for this market

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "market": {
      "id": "string",
      "market_name": "string",
      "is_primary": true,
      "is_default": true,
      "market_status": "string",
      "currency": "string",
      "symbol": {
        "val": "string",
        "left": "string",
        "right": "string",
        "cn_name": "string",
        "title": "string",
        "code": "string"
      },
      "domain_type": "string",
      "domain_value": "string",
      "custom_rate_enabled": true,
      "custom_exchange_rate": 0,
      "price_adjust": 0,
      "local_currency_enabled": true,
      "product_tax_included": true,
      "default_language": "string",
      "countries": [
        "string"
      ],
      "languages": [
        {
          "code": "string",
          "name": "string",
          "is_enabled": true,
          "url": "string",
          "is_default": true
        }
      ],
      "language_manageable": true,
      "url": "string",
      "created_at": "string",
      "updated_at": "string",
      "actual_rate": 0,
      "exchange_rate": {
        "currency": "string",
        "to_currency": "string",
        "rate": 0,
        "last_updated_at": "string"
      },
      "back_exchange_rate": {
        "currency": "string",
        "to_currency": "string",
        "rate": 0,
        "last_updated_at": "string"
      },
      "setting": {
        "redirect_enabled": true,
        "price_round_enabled": true,
        "geolocation_app_installed": true,
        "language_selector_enabled": true
      },
      "delivery_country_limited": true
    }
  }
}