Markets and languages

Toolset markets, 16 tools.

RecordsHivatkozás másolása

language_settingsHivatkozás másolása

The store languages kept as drafts: they can be translated and previewed but are not served to visitors. Every other supported language is published. There is one record; pass any id, e.g. "current".

• Permission: settings.read
• Tools: language_settings_get

localeHivatkozás másolása

A language the platform knows, by code (hu, en, de-AT) with its name. The ones the store supports are on the store record.

• Permission: settings.read
• Tools: locale_list, locale_get
• Sorts: code, name

Filters on the list:

marketHivatkozás másolása

A market: the countries the store sells to together, the currencies it prices them in, and the address (domain, or a country subfolder of it) it is served at with that address's languages and whether the subfolder is live. A country belongs to one market, and the store sells exactly to its markets' countries.

• Permission: settings.read
• Tools: market_list, market_get

regionHivatkozás másolása

A region: a group of countries that share one currency and tax behaviour, with the payment providers it offers. Rows list countries with their ISO codes and names. The storefront markets are set in market_list; regions are what checkout prices and taxes by.

• Permission: settings.read
• Tools: region_list, region_get
• Sorts: created_at, name

Filters on the list:

selling_settingsHivatkozás másolása

The countries the store sells to and the primary one, derived from its markets (null while it has no market). Change them with market_create and market_update. There is one record; pass any id, e.g. "current".

• Permission: settings.read
• Tools: selling_settings_get

ActionsHivatkozás másolása

address_updateHivatkozás másolása

Change the languages an address serves, whether its subfolder is live, or its default market.

address is the address key from market_list (address_key), a domain such as bolt.hu or a subfolder such as bolt.hu/at. live true publishes a subfolder, false returns it to draft; a domain's own status is set elsewhere. default_market is a market served at this address.

• Action key: address.update
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "address": "bolt.hu/at",
  "live": true
}

language_settings_updateHivatkozás másolása

Set which store languages are drafts (not served) and which are published.

draft lists every language that should be a draft; the list replaces the current one, and a language not in it is published. Add or remove supported languages with store_set_locales.

• Action key: language_settings.update
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "draft": [
    "de"
  ]
}

market_createHivatkozás másolása

Add a market: countries, currencies and the address it is served at.

A country in two markets is refused unless take_countries moves it here from the other. Put the market on an existing address, or give address_languages for a new one. remove_markets deletes other markets in the same step, for "replace this market with that one".

• Action key: market.create
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "market": {
    "name": "Hungary",
    "countries": [
      "hu"
    ],
    "address": {
      "host": "bolt.hu",
      "prefix": null
    },
    "currencies": {
      "default": "huf",
      "others": []
    }
  },
  "address_languages": {
    "languages": {
      "default": "hu",
      "others": [
        "en"
      ]
    }
  }
}

market_deleteHivatkozás másolása

Delete a market; the store stops selling to its countries.

An address left without a market goes with it.

• Action key: market.delete
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: safe to repeat with the same input.

Example input:

{
  "market_id": "0192f0e0-0000-7000-8000-000000000001"
}

market_updateHivatkozás másolása

Change the name, countries, currencies or address of a market.

Only the fields passed change; countries and currencies replace their lists. Moving the market to an address with no languages yet needs address_languages. take_countries and remove_markets work as in market_create. The market keeps its id.

• Action key: market.update
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "market_id": "0192f0e0-0000-7000-8000-000000000001",
  "countries": [
    "hu",
    "sk"
  ]
}

region_createHivatkozás másolása

Create a region with a currency and its countries.

A country belongs to one region. The payment providers a region offers are set by a person in the admin. automatic_taxes calculates tax from the tax regions; is_tax_inclusive makes prices include it.

• Action key: region.create
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "name": "Hungary",
  "currency_code": "huf",
  "countries": [
    "hu"
  ],
  "automatic_taxes": true
}

region_deleteHivatkozás másolása

Delete a region; its countries stop being sold to through it.

• Action key: region.delete
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: safe to repeat with the same input.

Example input:

{
  "region_id": "019bb66a-289f-7fbe-ad8d-cd924c882647"
}

region_updateHivatkozás másolása

Change a region's name, currency, countries or tax behaviour.

Only the fields passed change; countries replaces the whole list. Check with the merchant before changing the currency or countries of a region that sells today.

• Action key: region.update
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "region_id": "019bb66a-289f-7fbe-ad8d-cd924c882647",
  "countries": [
    "hu",
    "sk"
  ]
}