{
  "openapi": "3.0.1",
  "info": {
    "title": "Store Currencies",
    "description": "Create and administer a collection of store supported currencies.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "paths": {
    "/store-currencies": {
      "get": {
        "tags": [
          "store-currencies"
        ],
        "description": "Get a collection of store supported currencies.",
        "operationId": "getStoreCurrencies",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The reference ID of the store this currency code associated with.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "A currency object.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of store supported currencies, such as USD, CAD, or Pound.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCurrencyCollection"
                },
                "example": {
                  "href": "https://10.190.66.10:8000/rest/admin/v2/store-currencies",
                  "count": 76,
                  "items": [
                    {
                      "storeId": 0,
                      "currency": "BEF",
                      "links": {
                        "self": {
                          "href": "https://10.190.66.10:8000/rest/admin/v2/store-currencies/storeId:0,currency:BEF"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "store-currencies"
        ],
        "description": "Create a store supported currency relation.",
        "operationId": "createStoreCurrency",
        "requestBody": {
          "description": "The store supported currencies resource.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCurrencies"
              },
              "example": {
                "storeId": 2,
                "currency": "BEF"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the StoreCurrencies.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetStoreCurrenciesByStoreIdAndCurrency": {
                "operationRef": "#/paths/~1store-currencies~1storeId:{storeId},currency:{currency}/get",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "currency": "$request.body#/currency"
                },
                "description": "The `storeId` value used in the request body can be used as the `storeId` parameter in `GET /store-currencies/storeId:{storeId},currency:{currency}`.\n"
              },
              "DeleteStoreCurrenciesByStoreIdAndCurrency": {
                "operationRef": "#/paths/~1store-currencies~1storeId:{storeId},currency:{currency}/delete",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "currency": "$request.body#/currency"
                },
                "description": "The `storeId` value used in the request body can be used as the `storeId` parameter in `DELETE /store-currencies/storeId:{storeId},currency:{currency}`.\n"
              },
              "UpdateStoreCurrenciesByStoreIdAndCurrency": {
                "operationRef": "#/paths/~1store-currencies~1storeId:{storeId},currency:{currency}/patch",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "currency": "$request.body#/currency"
                },
                "description": "The `storeId` value used in the request body can be used as the `stroeId` parameter in `PATCH /store-currencies/storeId:{storeId},currency:{currency}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "StoreCurrency"
      }
    },
    "/store-currencies/storeId:{storeId},currency:{currency}": {
      "get": {
        "tags": [
          "store-currencies"
        ],
        "description": "Get a store supported currency.",
        "operationId": "getStoreCurrencyById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this currency code associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "path",
            "description": "A currency object.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The store supported currencies resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreCurrency"
                },
                "example": {
                  "storeId": 2,
                  "currency": "BEF",
                  "links": {
                    "self": {
                      "href": "https://10.190.66.10:8000/rest/admin/v2/store-currencies/storeId:2,currency:BEF"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "store-currencies"
        ],
        "description": "Delete a store supported currency relation.",
        "operationId": "deleteStoreCurrencyById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this currency code associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "path",
            "description": "A currency object.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "store-currencies"
        ],
        "description": "Update a store supported currency relation.",
        "operationId": "updateStoreCurrencyById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this currency code associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "path",
            "description": "A currency object.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The store supported currencies resource.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreCurrencies"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "StoreCurrency"
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "StoreCurrency": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this currency code associated with.",
            "format": "int32"
          },
          "currency": {
            "type": "string",
            "description": "A currency object."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "The store supported currencies resource."
      },
      "StoreCurrencies": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this currency code associated with.",
            "format": "int32"
          },
          "currency": {
            "type": "string",
            "description": "A currency object."
          }
        }
      },
      "StoreCurrencyCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/StoreCurrency"
            }
          }
        },
        "description": "A collection of store supported currencies, such as USD, CAD, or Pound."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}