{
  "openapi": "3.0.1",
  "info": {
    "title": "Inventories",
    "description": "Create and administer a collection of inventory.",
    "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": "Inventories",
      "description": "Provide RESTful services to manage inventories."
    }
  ],
  "paths": {
    "/inventories": {
      "get": {
        "tags": [
          "Inventories"
        ],
        "description": "Get a collection of inventory records.",
        "operationId": "getInventories",
        "parameters": [
          {
            "name": "catalogEntryId",
            "in": "query",
            "description": "The catalog entry identifier.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "quantity",
            "in": "query",
            "description": "The quantity amount, in units indicated by the quantity measure.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "quantityMeasure",
            "in": "query",
            "description": "The unit of measurement for quantity.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "inventoryFlags",
            "in": "query",
            "description": "Bit flags, from low to high order, indicating how QUANTITY is used - \\n1 = noUpdate. The default UpdateInventory task command does not update quantity. \\n2 = noCheck. The default CheckInventory and UpdateInventory task commands do not check quantity.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The store identifier.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fulfillmentCenterId",
            "in": "query",
            "description": "The fulfillment center identifier.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "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 non-ATP inventory records.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryCollection"
                }
              }
            }
          },
          "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": [
          "Inventories"
        ],
        "description": "Create an inventory record.",
        "operationId": "createInventory",
        "requestBody": {
          "description": "Non-ATP inventory.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Inventory"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the inventories .",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetInventoriesByCatalogEntryIdAndfulfillmentCenterIdAndStoreId": {
                "operationRef": "#/paths/~1inventories~1catalogEntryId:{catalogEntryId},fulfillmentCenterId:{fulfillmentCenterId},storeId:{storeId}/get",
                "parameters": {
                  "catalogEntryId": "$request.body#/catalogEntryId",
                  "fulfillmentCenterId": "$request.body#/fulfillmentCenterId",
                  "storeId": "$request.body#/storeId"
                },
                "description": "The `catalogEntryId` And `fulfillmentCenterId` And `storeId` value used in the request body can be used as the `catalogEntryId` And `fulfillmentCenterId` And `storeId` parameter in `GET /inventories/catalogEntryId:{catalogEntryId},fulfillmentCenterId:{fulfillmentCenterId},storeId:{storeId}`.\n"
              },
              "DeleteInventoriesByCatalogEntryIdAndfulfillmentCenterIdAndStoreId": {
                "operationRef": "#/paths/~1inventories~1catalogEntryId:{catalogEntryId},fulfillmentCenterId:{fulfillmentCenterId},storeId:{storeId}/delete",
                "parameters": {
                  "catalogEntryId": "$request.body#/catalogEntryId",
                  "fulfillmentCenterId": "$request.body#/fulfillmentCenterId",
                  "storeId": "$request.body#/storeId"
                },
                "description": "The `catalogEntryId` And `fulfillmentCenterId` And `storeId` value used in the request body can be used as the `catalogEntryId` And `fulfillmentCenterId` And `storeId` parameter in `DELETE /inventories/catalogEntryId:{catalogEntryId},fulfillmentCenterId:{fulfillmentCenterId},storeId:{storeId}`.\n"
              },
              "UpdateInventoriesByCatalogEntryIdAndfulfillmentCenterIdAndStoreId": {
                "operationRef": "#/paths/~1inventories~1catalogEntryId:{catalogEntryId},fulfillmentCenterId:{fulfillmentCenterId},storeId:{storeId}/patch",
                "parameters": {
                  "catalogEntryId": "$request.body#/catalogEntryId",
                  "fulfillmentCenterId": "$request.body#/fulfillmentCenterId",
                  "storeId": "$request.body#/storeId"
                },
                "description": "The `catalogEntryId` And `fulfillmentCenterId` And `storeId` value used in the request body can be used as the `catalogEntryId` And `fulfillmentCenterId` And `storeId` parameter in `PATCH /inventories/catalogEntryId:{catalogEntryId},fulfillmentCenterId:{fulfillmentCenterId},storeId:{storeId}`.\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": "Inventory"
      }
    },
    "/inventories/catalogEntryId:{catalogEntryId},fulfillmentCenterId:{fulfillmentCenterId},storeId:{storeId}": {
      "get": {
        "tags": [
          "Inventories"
        ],
        "description": "Get an inventory record.",
        "operationId": "getInventoryById",
        "parameters": [
          {
            "name": "catalogEntryId",
            "in": "path",
            "description": "The catalog entry identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fulfillmentCenterId",
            "in": "path",
            "description": "The fulfillment center identifier.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "path",
            "description": "The store identifier.",
            "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": "Non-ATP inventory.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Inventory"
                }
              }
            }
          },
          "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": [
          "Inventories"
        ],
        "description": "Delete an inventory record.",
        "operationId": "deleteInventoryById",
        "parameters": [
          {
            "name": "catalogEntryId",
            "in": "path",
            "description": "The catalog entry identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fulfillmentCenterId",
            "in": "path",
            "description": "The fulfillment center identifier.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "path",
            "description": "The store identifier.",
            "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": [
          "Inventories"
        ],
        "description": "Update an inventory record.",
        "operationId": "updateInventoryById",
        "parameters": [
          {
            "name": "catalogEntryId",
            "in": "path",
            "description": "The catalog entry identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fulfillmentCenterId",
            "in": "path",
            "description": "The fulfillment center identifier.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "storeId",
            "in": "path",
            "description": "The store identifier.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Non-ATP inventory.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Inventory"
              }
            }
          },
          "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": "Inventory"
      }
    }
  },
  "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."
      },
      "Inventory": {
        "required": [
          "catalogEntryId",
          "storeId",
          "fulfillmentCenterId"
        ],
        "type": "object",
        "properties": {
          "catalogEntryId": {
            "type": "string",
            "description": "The catalog entry identifier."
          },
          "quantity": {
            "type": "number",
            "description": "The quantity amount, in units indicated by the quantity measure.",
            "format": "double"
          },
          "quantityMeasure": {
            "type": "string",
            "description": "The unit of measurement for quantity."
          },
          "inventoryFlags": {
            "type": "integer",
            "description": "Bit flags, from low to high order, indicating how QUANTITY is used - \\n1 = noUpdate. The default UpdateInventory task command does not update quantity. \\n2 = noCheck. The default CheckInventory and UpdateInventory task commands do not check quantity.",
            "format": "int32"
          },
          "storeId": {
            "type": "integer",
            "description": "The store identifier.",
            "format": "int32"
          },
          "fulfillmentCenterId": {
            "type": "integer",
            "description": "The fulfillment center identifier.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "Non-ATP inventory."
      },
      "InventoryCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int32"
          },
          "href": {
            "type": "string"
          },
          "next": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/Inventory"
            }
          }
        },
        "description": "A collection of non-ATP inventory records."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}