{
  "openapi": "3.0.1",
  "info": {
    "title": "Store Alternative Languages",
    "description": "Create and administer a collection of store alternative 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-alternative-languages": {
      "get": {
        "tags": [
          "store-alternative-languages"
        ],
        "description": "Get a collection of store alternative languages.",
        "operationId": "getStoreAlternativeLanguages",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "query",
            "description": "The language Id for the requested language.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "altLanguageId",
            "in": "query",
            "description": "The language Id for the alternative language.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "sequence",
            "in": "query",
            "description": "When the requested language is supported (see the store-languages resource) but information is not available in that language, each alternative language is tried in ascending order of SEQUENCE. A store may override the SEQUENCE specified for its StoreGroup.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "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 alternative languages relationship.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreAlternativeLanguageCollection"
                }
              }
            }
          },
          "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-alternative-languages"
        ],
        "description": "Create a store alternative language.",
        "operationId": "createStoreAlternativeLanguage",
        "requestBody": {
          "description": "The store alternative language resource.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreAlternativeLanguage"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the StoreAlternativeLanguage.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetStoreAlternativeLanguageById": {
                "operationRef": "#/paths/~1/store-alternative-languages~1storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}/get",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "languageId": "$request.body#/languageId",
                  "altLanguageId": "$request.body#/altLanguageId"
                },
                "description": "The `storeId`,`languageId`,`altLanguageId` value used in the request body can be used as the `storeId`,`languageId`,`altLanguageId`  parameter in `GET /store-alternative-languages/storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}`.\n"
              },
              "DeleteStoreAlternativeLanguageById": {
                "operationRef": "#/paths/~1store-alternative-languages~1storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}/delete",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "languageId": "$request.body#/languageId",
                  "altLanguageId": "$request.body#/altLanguageId"
                },
                "description": "The `storeId`,`languageId`,`altLanguageId` value used in the request body can be used as the `storeId`,`languageId`,`altLanguageId`   parameter in `DELETE /store-alternative-languages/storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}`.\n"
              },
              "UPdateStoreAlternativeLanguageById": {
                "operationRef": "#/paths/~1store-alternative-languages~1storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}/patch",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "languageId": "$request.body#/languageId",
                  "altLanguageId": "$request.body#/altLanguageId"
                },
                "description": "The `storeId`,`languageId`,`altLanguageId` value used in the request body can be used as the `storeId`,`languageId`,`altLanguageId`   parameter in `PATCH /store-alternative-languages/storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}.\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": "StoreAlternativeLanguage"
      }
    },
    "/store-alternative-languages/storeId:{storeId},languageId:{languageId},altLanguageId:{altLanguageId}": {
      "get": {
        "tags": [
          "store-alternative-languages"
        ],
        "description": "Get a store alternative language.",
        "operationId": "getStoreAlternativeLanguageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language Id for the requested language.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "altLanguageId",
            "in": "path",
            "description": "The language Id for the alternative language.",
            "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 alternative language resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreAlternativeLanguages"
                }
              }
            }
          },
          "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-alternative-languages"
        ],
        "description": "Delete a store alternative language.",
        "operationId": "deleteStoreAlternativeLanguageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language Id for the requested language.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "altLanguageId",
            "in": "path",
            "description": "The language Id for the alternative language.",
            "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-alternative-languages"
        ],
        "description": "Update a store alternative language.",
        "operationId": "updateStoreAlternativeLanguageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "languageId",
            "in": "path",
            "description": "The language Id for the requested language.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "altLanguageId",
            "in": "path",
            "description": "The language Id for the alternative language.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "The store alternative language resource.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreAlternativeLanguage"
              }
            }
          },
          "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": "StoreAlternativeLanguage"
      }
    }
  },
  "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."
      },
      "StoreAlternativeLanguage": {
        "type": "object",
        "required": [
          "storeId",
          "altLanguageId"
        ],
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The language Id for the requested language.",
            "format": "int32"
          },
          "altLanguageId": {
            "type": "integer",
            "description": "The language Id for the alternative language.",
            "format": "int32"
          },
          "sequence": {
            "type": "number",
            "description": "When the requested language is supported (see the store-languages resource) but information is not available in that language, each alternative language is tried in ascending order of SEQUENCE. A store may override the SEQUENCE specified for its StoreGroup.",
            "format": "double"
          }
        },
        "description": "The store alternative language resource."
      },
      "StoreAlternativeLanguages": {
        "type": "object",
        "required": [
          "storeId",
          "altLanguageId"
        ],
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The store Id for this relationship. The alternative language relationships of a store include the alternative language relationships for its StoreGroup.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The language Id for the requested language.",
            "format": "int32"
          },
          "altLanguageId": {
            "type": "integer",
            "description": "The language Id for the alternative language.",
            "format": "int32"
          },
          "sequence": {
            "type": "number",
            "description": "When the requested language is supported (see the store-languages resource) but information is not available in that language, each alternative language is tried in ascending order of SEQUENCE. A store may override the SEQUENCE specified for its StoreGroup.",
            "format": "double"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "The store alternative language resource."
      },
      "StoreAlternativeLanguageCollection": {
        "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/StoreAlternativeLanguages"
            }
          }
        },
        "description": "A collection of store alternative languages relationship."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}