xclade
Store APIRegions

Get a Region

Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.

GET
/store/regions/{id}

Path Parameters

id*string

The region's ID.

Query Parameters

fields?string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Header Parameters

x-publishable-api-key*string

Publishable API Key created in the Medusa Admin.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X GET "https://{tenant}.api.myxclade.com/store/regions/string" \  -H "x-publishable-api-key: string"
{
  "region": {
    "id": "string",
    "name": "string",
    "currency_code": "usd",
    "automatic_taxes": true,
    "countries": [
      {
        "id": "string",
        "iso_2": "us",
        "iso_3": "usa",
        "num_code": 840,
        "name": "string",
        "display_name": "string"
      }
    ],
    "payment_providers": [
      {
        "id": "string",
        "is_enabled": true
      }
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}