Skip to main content
POST
/
admin
/
regions
Create Region
curl --request POST \
  --url https://api.headlesscommerce.io/v1/admin/regions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "currency": "<string>",
  "tax_rate": 123,
  "prices_include_tax": true,
  "is_default": true,
  "metadata": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "code": "<string>",
  "currency": "<string>",
  "tax_rate": 123,
  "prices_include_tax": true,
  "is_default": true,
  "is_active": true,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Body

application/json
name
string
required
code
string
required
Required string length: 1 - 10
currency
string
required
Required string length: 3
tax_rate
integer
prices_include_tax
boolean
is_default
boolean
metadata
object

Response

201 - application/json

Created

id
string
name
string
code
string

Region code (e.g., KR, US)

currency
string

ISO 4217

tax_rate
integer

basis points. 1000 = 10%

prices_include_tax
boolean
is_default
boolean
is_active
boolean
metadata
object
created_at
string<date-time>