{
  "openapi": "3.0.1",
  "info": {
    "title": "Inventory Availabilities",
    "description": "Create and administer collection of inventory record.",
    "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"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Inventory Availabilities",
      "description": "Provide RESTful services to manage inventory availabilities."
    }
  ],
  "paths": {
    "/inventory-availabilities": {
      "get": {
        "tags": [
          "Inventory Availabilities"
        ],
        "description": "Get a collection of inventory records.",
        "operationId": "getInventoryAvailabilities",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The available inventory ID.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "availableQuantity",
            "in": "query",
            "description": "The available quantity of the item at the location specified.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "availabilityDate",
            "in": "query",
            "description": "The availability date of the item at the location specified.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "availabilityOffset",
            "in": "query",
            "description": "The number of seconds from the time when the inventory checking is performed to the time when the product is available.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "updatedDate",
            "in": "query",
            "description": "The time this record was last updated.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "field3",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "catalogEntryId",
            "in": "query",
            "description": "The catalog entry ID.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The online store ID. Either this or the physical store ID must be specified, but not both.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeLocationId",
            "in": "query",
            "description": "The physical store ID. Either this or the online store ID must be specified, but not both.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "quantityUnit",
            "in": "query",
            "description": "The unit of measure of the quantity above. Default value is C62.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "inventoryStatus",
            "in": "query",
            "description": "The inventory status of the item at the location specified. Predefined values include, AVL = Available, BA = Backorderable, UAVL = Unavailable.",
            "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 DOM inventory records.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryAvailabilityCollection"
                }
              }
            }
          },
          "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": [
          "Inventory Availabilities"
        ],
        "description": "Create an inventory record.",
        "operationId": "createInventoryAvailability",
        "requestBody": {
          "description": "DOM inventory.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InventoryAvailabilitys"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Inventory Availabilities.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetInventoryAvailabilityById": {
                "operationRef": "#/paths/~1inventory-availabilities~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /inventory-availabilities/{id}`.\n"
              },
              "DeleteInventoryAvailabilityById": {
                "operationRef": "#/paths/~1inventory-availabilities~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /inventory-availabilities/{id}`.\n"
              },
              "UpdateInventoryAvailabilityById": {
                "operationRef": "#/paths/~1inventory-availabilities~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /inventory-availabilities/{id}`.  \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": "InventoryAvailability"
      }
    },
    "/inventory-availabilities/{id}": {
      "get": {
        "tags": [
          "Inventory Availabilities"
        ],
        "description": "Get an inventory record.",
        "operationId": "getInventoryAvailabilityById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The available inventory ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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": "DOM inventory.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryAvailability"
                }
              }
            }
          },
          "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": [
          "Inventory Availabilities"
        ],
        "description": "Delete an inventory record.",
        "operationId": "deleteInventoryAvailabilityById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The available inventory ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "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": [
          "Inventory Availabilities"
        ],
        "description": "Update an inventory record.",
        "operationId": "updateInventoryAvailabilityById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The available inventory ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "DOM inventory.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InventoryAvailabilitys"
              }
            }
          },
          "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": "InventoryAvailability"
      }
    }
  },
  "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."
      },
      "InventoryAvailabilitys": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The available inventory ID.",
            "format": "int64"
          },
          "availableQuantity": {
            "type": "number",
            "description": "The available quantity of the item at the location specified.",
            "format": "double"
          },
          "availabilityDate": {
            "type": "string",
            "description": "The availability date of the item at the location specified.",
            "format": "date-time"
          },
          "availabilityOffset": {
            "type": "integer",
            "description": "The number of seconds from the time when the inventory checking is performed to the time when the product is available.",
            "format": "int32"
          },
          "updatedDate": {
            "type": "string",
            "description": "The time this record was last updated.",
            "format": "date-time"
          },
          "field1": {
            "type": "integer",
            "description": "Customizable.",
            "format": "int32"
          },
          "field2": {
            "type": "number",
            "description": "Customizable.",
            "format": "double"
          },
          "field3": {
            "type": "string",
            "description": "Customizable."
          },
          "catalogEntryId": {
            "type": "integer",
            "description": "The catalog entry ID.",
            "format": "int64"
          },
          "storeId": {
            "type": "integer",
            "description": "The online store ID. Either this or the physical store ID must be specified, but not both.",
            "format": "int32"
          },
          "storeLocationId": {
            "type": "integer",
            "description": "The physical store ID. Either this or the online store ID must be specified, but not both.",
            "format": "int32"
          },
          "quantityUnit": {
            "type": "string",
            "description": "The unit of measure of the quantity above. Default value is C62."
          },
          "inventoryStatus": {
            "type": "string",
            "description": "The inventory status of the item at the location specified. Predefined values include, AVL = Available, BA = Backorderable, UAVL = Unavailable."
          }
        }
      },
      "InventoryAvailability": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The available inventory ID.",
            "format": "int64"
          },
          "availableQuantity": {
            "type": "number",
            "description": "The available quantity of the item at the location specified.",
            "format": "double"
          },
          "availabilityDate": {
            "type": "string",
            "description": "The availability date of the item at the location specified.",
            "format": "date-time"
          },
          "availabilityOffset": {
            "type": "integer",
            "description": "The number of seconds from the time when the inventory checking is performed to the time when the product is available.",
            "format": "int32"
          },
          "updatedDate": {
            "type": "string",
            "description": "The time this record was last updated.",
            "format": "date-time"
          },
          "field1": {
            "type": "integer",
            "description": "Customizable.",
            "format": "int32"
          },
          "field2": {
            "type": "number",
            "description": "Customizable.",
            "format": "double"
          },
          "field3": {
            "type": "string",
            "description": "Customizable."
          },
          "catalogEntryId": {
            "type": "integer",
            "description": "The catalog entry ID.",
            "format": "int64"
          },
          "storeId": {
            "type": "integer",
            "description": "The online store ID. Either this or the physical store ID must be specified, but not both.",
            "format": "int32"
          },
          "storeLocationId": {
            "type": "integer",
            "description": "The physical store ID. Either this or the online store ID must be specified, but not both.",
            "format": "int32"
          },
          "quantityUnit": {
            "type": "string",
            "description": "The unit of measure of the quantity above. Default value is C62."
          },
          "inventoryStatus": {
            "type": "string",
            "description": "The inventory status of the item at the location specified. Predefined values include, AVL = Available, BA = Backorderable, UAVL = Unavailable."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "DOM inventory."
      },
      "InventoryAvailabilityCollection": {
        "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/InventoryAvailability"
            }
          }
        },
        "description": "A collection of DOM inventory records."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}