{
  "openapi": "3.0.1",
  "info": {
    "title": "Store Languages",
    "description": "Create and administer a collection of store languages.",
    "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-languages": {
      "get": {
        "tags": [
          "store-languages"
        ],
        "description": "Get a collection of store languages.",
        "operationId": "getStoreLanguages",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The reference ID of the store this language associated with.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The language ID is associated with this store.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "The currency code is associated with this language and store.",
            "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"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of store languages.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreLanguageCollection"
                }
              }
            }
          },
          "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-languages"
        ],
        "description": "Create a store language.",
        "operationId": "createStoreLanguage",
        "requestBody": {
          "description": "The store languages.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreLanguage"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the StoreLanguage.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetStoreLanguageById": {
                "operationRef": "#/paths/~1store-languages~1storeId:{storeId},languageId:{languageId}/get",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `storeId`& `languageId`value used in the request body can be used as the `storeId`& `languageId`  parameter in `GET /store-languages/storeId:{storeId},languageId:{languageId}`.\n"
              },
              "DeleteStoreLanguageById": {
                "operationRef": "#/paths/~1store-languages~1storeId:{storeId},languageId:{languageId}/delete",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `storeId` & `languageId`value used in the request body can be used as the `storeId`& `languageId`  parameter in `DELETE ​/store-languages/storeId:{storeId},languageId:{languageId}`.\n"
              },
              "UpdateStoreLanguageById": {
                "operationRef": "#/paths/~1store-languages/storeId:{storeId},languageId:{languageId}/patch",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "languageId": "$request.body#/languageId"
                },
                "description": "The `storeId`& `languageId`value used in the request body can be used as the `storeId` & `languageId`  parameter in `PATCH /store-languages/storeId:{storeId},languageId:{languageId}`.\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": "StoreLanguage"
      }
    },
    "/store-languages/storeId:{storeId},languageId:{languageId}": {
      "get": {
        "tags": [
          "store-languages"
        ],
        "description": "Get a store language.",
        "operationId": "getStoreLanguageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this language associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID is associated with this store.",
            "required": true,
            "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"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The store languages.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreLanguages"
                }
              }
            }
          },
          "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-languages"
        ],
        "description": "Delete a store language.",
        "operationId": "deleteStoreLanguageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this language associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID is associated with this store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "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-languages"
        ],
        "description": "Update a store language.",
        "operationId": "updateStoreLanguageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this language associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language ID is associated with this store.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "The store languages.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreLanguage"
              }
            }
          },
          "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": "StoreLanguage"
      }
    }
  },
  "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."
      },
      "StoreLanguage": {
        "type": "object",
        "required": [
          "storeId",
          "languageId"
        ],
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this language associated with.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The language ID is associated with this store.",
            "format": "int32"
          },
          "currency": {
            "type": "string",
            "description": "The currency code is associated with this language and store."
          }
        },
        "description": "The store languages."
      },
      "StoreLanguages": {
        "type": "object",
        "required": [
          "storeId",
          "languageId"
        ],
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this language associated with.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The language ID is associated with this store.",
            "format": "int32"
          },
          "currency": {
            "type": "string",
            "description": "The currency code is associated with this language and store."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The store languages."
      },
      "StoreLanguageCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/StoreLanguages"
            }
          }
        },
        "description": "A collection of store languages."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}