Create a Currency

POST 
/v2/currencies

caution

This endpoint is for Administrator use only. Do not use this endpoint on your customer-facing frontends.

Request

application/json

Body

data object

code stringrequired

Possible values: >= 3 characters and <= 3 characters

Specifies the currency code. Example YEN.

decimal_places numberrequired

Indicates how many decimal places the currency is formatted to.

decimal_point stringrequired

Indicates the decimal point character.

default booleanrequired

Specifies whether this is the default currency or not. Either true or false.

enabled booleanrequired

Specifies if this currency is available for products. Either true or false.

exchange_rate numberrequired

Specifies the exchange rate from the default currency.

format stringrequired

Specifies how the price currency is displayed. For example, "¥{price}".

thousand_separator stringrequired

Indicates the thousand separator character.

type stringrequired

Represents the type represents the object being returned.

Responses

201

Created

application/json

Schema

Schema

data object

id string

The unique identifier for this currency.

type string

Represents the type represents the object being returned.

code string

Specifies the currency code. For example, YEN.

exchange_rate number

Specifies the exchange rate from the default currency.

format string

Specifies how the price currency is displayed. For example, "£{price}".

decimal_point string

Indicates the decimal point character.

thousand_separator string

Indicates the thousand separator character.

decimal_places number

Indicates how many decimal places the currency is formatted to.

default boolean

Specifies whether this is the default currency or not. Either true or false.

enabled boolean

Specifies if this currency is available for products. Either true or false.

links object

self string

Specifies the URL of this currency.

meta object

timestamps object

created_at string

Indicates the creation date of this currency.

updated_at

Indicates the updated date of this currency.

owner string

Indicates whether the owner is store or org.

type

Example (from schema)

{
  "data": {
    "id": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0",
    "type": "currency",
    "code": "GBP",
    "exchange_rate": 1,
    "format": "£{price}",
    "decimal_point": ".",
    "thousand_separator": ",",
    "decimal_places": 2,
    "default": true,
    "enabled": true,
    "links": {
      "self": "string"
    },
    "meta": {
      "timestamps": {
        "created_at": "2023-11-07T23:04:18.845Z",
        "updated_at": "2023-11-07T23:04:18.845Z"
      },
      "owner": "store"
    }
  },
  "type": {}
}

400

Bad Request

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 400,
    "title": "Currency already exists",
    "description": "The specified currency code already exists"
  }
}

422

Bad Request

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 422,
    "title": "Currency limit reached",
    "description": "You have reached the maximum allowed currency limit of 10"
  }
}

Loading...