{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/elastic-path/main/json-schema/currencies.json", "title": "Currencies Introduction", "description": "", "version": "26.0225.7248250", "$defs": { "Response.Data": { "type": "object", "properties": { "data": {} } }, "SelfLink": { "type": "object", "properties": { "self": { "description": "Specifies the URL of this currency.", "type": "string" } } }, "Timestamps": { "type": "object", "properties": { "created_at": { "description": "Indicates the creation date of this currency.", "type": "string", "example": "2023-11-07T23:04:18.845Z" }, "updated_at": { "description": "Indicates the updated date of this currency.", "example": "2023-11-07T23:04:18.845Z" } } }, "Response.Meta.Currency": { "type": "object", "properties": { "timestamps": { "$ref": "#/components/schemas/Timestamps" }, "owner": { "description": "Indicates whether the owner is store or org.", "example": "store", "type": "string" } } }, "Response.Currency": { "type": "object", "properties": { "id": { "description": "The unique identifier for this currency.", "example": "0c45e4ec-26e0-4043-86e4-c15b9cf985a0", "type": "string" }, "type": { "description": "Represents the type represents the object being returned.", "example": "currency", "type": "string" }, "code": { "description": "Specifies the currency code. For example, YEN.", "example": "GBP", "type": "string" }, "exchange_rate": { "description": "Specifies the exchange rate from the default currency.", "example": 1, "type": "number" }, "format": { "description": "Specifies how the price currency is displayed. For example, \"\u00a3{price}\".", "example": "\u00a3{price}", "type": "string" }, "decimal_point": { "description": "Indicates the decimal point character.", "example": ".", "type": "string" }, "thousand_separator": { "description": "Indicates the thousand separator character.", "example": ",", "type": "string" }, "decimal_places": { "description": "Indicates how many decimal places the currency is formatted to.", "example": 2, "type": "number" }, "default": { "description": "Specifies whether this is the default currency or not. Either `true` or `false`.", "example": true, "type": "boolean" }, "enabled": { "description": "Specifies if this currency is available for products. Either `true` or `false`.", "example": true, "type": "boolean" }, "links": { "$ref": "#/components/schemas/SelfLink" }, "meta": { "$ref": "#/components/schemas/Response.Meta.Currency" } } }, "Response.Error": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "An application-specific error code.", "example": "1" }, "detail": { "type": "string" }, "status": { "type": "integer", "example": 400 }, "title": { "type": "string" } } } } } }, "Data.CreateCurrencies": { "required": [ "type", "code", "exchange_rate", "format", "decimal_point", "thousand_separator", "decimal_places", "default", "enabled" ], "type": "object", "properties": { "code": { "description": "Specifies the currency code. Example YEN.", "type": "string", "example": "GBP", "maxLength": 3, "minLength": 3 }, "decimal_places": { "description": "Indicates how many decimal places the currency is formatted to.", "type": "number", "example": 2, "minimum": 0 }, "decimal_point": { "description": "Indicates the decimal point character.", "type": "string", "example": "." }, "default": { "description": "Specifies whether this is the default currency or not. Either `true` or `false`.", "type": "boolean", "example": true }, "enabled": { "description": "Specifies if this currency is available for products. Either `true` or `false`.", "type": "boolean", "example": true }, "exchange_rate": { "description": "Specifies the exchange rate from the default currency.", "type": "number", "example": 1, "minimum": 0 }, "format": { "description": "Specifies how the price currency is displayed. For example, \"\u00a5{price}\".", "type": "string", "example": "\u00a3{price}" }, "thousand_separator": { "description": "Indicates the thousand separator character.", "type": "string", "example": "," }, "type": { "description": "Represents the type represents the object being returned.", "type": "string", "example": "currency" } } }, "Request.CreateCurrencies": { "title": "Request.CreateCurrencies", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data.CreateCurrencies" } } }, "Data.UpdateCurrencies": { "title": "Data.UpdateCurrencies", "type": "object", "properties": { "default": { "description": "Specifies whether this is the default currency or not. Either `true` or `false`.", "type": "boolean", "example": true } } }, "Request.UpdateCurrencies": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data.UpdateCurrencies" } } } } }