Regional Pricing

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

productIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

idstringRequired

group_idstringRequired

local_currencystringRequired

local_currency_fx_ratenumber · doubleRequired

blended_vat_ratenumber · doubleRequired

namestringRequired

country_codesstring[]Required

enabledbooleanRequired

priceinteger · nullableOptional

default_price_multiplierinteger · nullableOptional

currencystring · nullableOptional

tax_inclusiveboolean · nullableOptional

updated_atstring · nullableOptional

default

Error response

application/json

get

/v1/stores/{storeId}/products/{productId}/pricing/regions

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/products/{productId}/pricing/regions HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "group_id": "text",
    "local_currency": "text",
    "local_currency_fx_rate": 1,
    "blended_vat_rate": 1,
    "name": "text",
    "country_codes": [
      "text"
    ],
    "enabled": true,
    "price": null,
    "default_price_multiplier": null,
    "currency": null,
    "tax_inclusive": null,
    "updated_at": null
  }
]

patch

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

productIdstring · flake-idRequiredExample: 411486491630370816

regionIdstringRequired

Body

application/jsontext/jsonapplication/*+json

priceinteger · nullableOptional

enabledboolean · nullableOptional

currencystring · nullableOptional

tax_inclusiveboolean · nullableOptional

Responses

204

No Content

default

Error response

application/json

patch

/v1/stores/{storeId}/products/{productId}/pricing/regions/{regionId}

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/products/{productId}/pricing/regions/{regionId} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "price": null,
  "enabled": null,
  "currency": null,
  "tax_inclusive": null
}

application/jsontext/jsonapplication/*+json

No content

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

idstringRequired

group_idstringRequired

local_currencystringRequired

local_currency_fx_ratenumber · doubleRequired

blended_vat_ratenumber · doubleRequired

namestringRequired

country_codesstring[]Required

enabledbooleanRequired

priceinteger · nullableOptional

default_price_multiplierinteger · nullableOptional

currencystring · nullableOptional

tax_inclusiveboolean · nullableOptional

updated_atstring · nullableOptional

default

Error response

application/json

get

/v1/stores/{storeId}/products/pricing/regions

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/products/pricing/regions HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "group_id": "text",
    "local_currency": "text",
    "local_currency_fx_rate": 1,
    "blended_vat_rate": 1,
    "name": "text",
    "country_codes": [
      "text"
    ],
    "enabled": true,
    "price": null,
    "default_price_multiplier": null,
    "currency": null,
    "tax_inclusive": null,
    "updated_at": null
  }
]

patch

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

regionIdstringRequired

Body

application/jsontext/jsonapplication/*+json

default_price_multiplierinteger · nullableOptional

enabledboolean · nullableOptional

currencystring · nullableOptional

tax_inclusiveboolean · nullableOptional

Responses

204

No Content

default

Error response

application/json

patch

/v1/stores/{storeId}/products/pricing/regions/{regionId}

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/products/pricing/regions/{regionId} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "default_price_multiplier": null,
  "enabled": null,
  "currency": null,
  "tax_inclusive": null
}

application/jsontext/jsonapplication/*+json

No content

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

idstringRequired

namestringRequired

descriptionstringRequired

recommended_base_price_multiplierinteger · int64Required

default

Error response

application/json

get

/v1/stores/{storeId}/products/pricing/region-groups

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/products/pricing/region-groups HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "recommended_base_price_multiplier": 1
  }
]