{
  "openapi": "3.0.1",
  "info": {
    "title": "Item Fulfillment Centers",
    "description": "Create and administer collection of item fulfillment centers.",
    "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": "Item Fulfillment Centers",
      "description": "Provide RESTful services to manage item fulfillment centers."
    }
  ],
  "paths": {
    "/item-fulfillment-centers": {
      "get": {
        "tags": [
          "Item Fulfillment Centers"
        ],
        "description": "Get a collection of item fulfillment centers.",
        "operationId": "getItemFulfillmentCenters",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The reference ID of the store this fulfillment center associated with.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "ffmCenterId",
            "in": "query",
            "description": "The fulfillment center.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "itemSpcId",
            "in": "query",
            "description": "The item specification.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "qtyBackOrdered",
            "in": "query",
            "description": "The quantity of this item backordered for this store and fulfillment center.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "qtyAllocBackOrder",
            "in": "query",
            "description": "Amount of in stock inventory allocated to a backorder.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "updatedDateTime",
            "in": "query",
            "description": "The updated date and time of this fulfillment center.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "qtyReserved",
            "in": "query",
            "description": "Reserved amount, may be used for auctions or other purposes.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "restockTime",
            "in": "query",
            "description": "Next planned restock time.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "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 item fulfillment centers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemFulfillmentCenterCollection"
                }
              }
            }
          },
          "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": [
          "Item Fulfillment Centers"
        ],
        "description": "Create a item fulfillment center.",
        "operationId": "createItemFulfillmentCenter",
        "requestBody": {
          "description": "The item fulfillment center.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ItemFulfillmentCenters"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Store item fulfillment centers.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetItemFulfillmentCenterByStoreIdAndFfmCenterIdAndItemSpcId": {
                "operationRef": "#/paths/~1item-fulfillment-centers~1storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}/get",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "ffmCenterId": "$request.body#/ffmCenterId",
                  "itemSpcId": "$request.body#/itemSpcId"
                },
                "description": "The `storeId` , `ffmCenterId` and `itemSpcId` value used in the request body can be used as the `storeId` and `ffmCenterId` and `itemSpcId` parameter in `GET /item-fulfillment-centers/storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}`.\n"
              },
              "DeleteItemFulfillmentCenterByStoreIdAndFfmCenterIdAndItemSpcId": {
                "operationRef": "#/paths/~1item-fulfillment-centers~1storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}/delete",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "ffmCenterId": "$request.body#/ffmCenterId",
                  "itemSpcId": "$request.body#/itemSpcId"
                },
                "description": "The `storeId` ,`ffmCenterId` and `itemSpcId` value used in the request body can be used as the `storeId` and `ffmCenterId` and `itemSpcId` parameter in `DELETE /item-fulfillment-centers/storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}`.\n"
              },
              "UpdateItemFulfillmentCenterByStoreIdAndFfmCenterIdAndItemSpcId": {
                "operationRef": "#/paths/~1item-fulfillment-centers~1storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}/patch",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "ffmCenterId": "$request.body#/ffmCenterId",
                  "itemSpcId": "$request.body#/itemSpcId"
                },
                "description": "The `storeId` ,`ffmCenterId` and `itemSpcId` value used in the request body can be used as the `storeId` and `ffmCenterId` and `itemSpcId` parameter in `PATCH /item-fulfillment-centers/storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}`.  \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": "ItemFulfillmentCenter"
      }
    },
    "/item-fulfillment-centers/storeId:{storeId},ffmCenterId:{ffmCenterId},itemSpcId:{itemSpcId}": {
      "get": {
        "tags": [
          "Item Fulfillment Centers"
        ],
        "description": "Get a item fulfillment center.",
        "operationId": "getItemFulfillmentCenterById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this fulfillment center associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "ffmCenterId",
            "in": "path",
            "description": "The fulfillment center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "itemSpcId",
            "in": "path",
            "description": "The item specification.",
            "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"
            }
          },
          {
            "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 item fulfillment center.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemFulfillmentCenter"
                }
              }
            }
          },
          "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": [
          "Item Fulfillment Centers"
        ],
        "description": "Delete a item fulfillment center.",
        "operationId": "deleteItemFulfillmentCenterById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this fulfillment center associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "ffmCenterId",
            "in": "path",
            "description": "The fulfillment center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "itemSpcId",
            "in": "path",
            "description": "The item specification.",
            "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": [
          "Item Fulfillment Centers"
        ],
        "description": "Update a item fulfillment center.",
        "operationId": "updateItemFulfillmentCenterById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The reference ID of the store this fulfillment center associated with.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "ffmCenterId",
            "in": "path",
            "description": "The fulfillment center.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "itemSpcId",
            "in": "path",
            "description": "The item specification.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "The item fulfillment center.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ItemFulfillmentCenters"
              }
            }
          },
          "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": "ItemFulfillmentCenter"
      }
    }
  },
  "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."
      },
      "ItemFulfillmentCenters": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this fulfillment center associated with.",
            "format": "int32"
          },
          "ffmCenterId": {
            "type": "integer",
            "description": "The fulfillment center.",
            "format": "int32"
          },
          "itemSpcId": {
            "type": "integer",
            "description": "The item specification.",
            "format": "int64"
          },
          "qtyBackOrdered": {
            "type": "integer",
            "description": "The quantity of this item backordered for this store and fulfillment center.",
            "format": "int32"
          },
          "qtyAllocBackOrder": {
            "type": "integer",
            "description": "Amount of in stock inventory allocated to a backorder.",
            "format": "int32"
          },
          "updatedDateTime": {
            "type": "string",
            "description": "The updated date and time of this fulfillment center.",
            "format": "date-time"
          },
          "qtyReserved": {
            "type": "integer",
            "description": "Reserved amount, may be used for auctions or other purposes.",
            "format": "int32"
          },
          "restockTime": {
            "type": "string",
            "description": "Next planned restock time.",
            "format": "date-time"
          }
        }
      },
      "ItemFulfillmentCenter": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The reference ID of the store this fulfillment center associated with.",
            "format": "int32"
          },
          "ffmCenterId": {
            "type": "integer",
            "description": "The fulfillment center.",
            "format": "int32"
          },
          "itemSpcId": {
            "type": "integer",
            "description": "The item specification.",
            "format": "int64"
          },
          "qtyBackOrdered": {
            "type": "integer",
            "description": "The quantity of this item backordered for this store and fulfillment center.",
            "format": "int32"
          },
          "qtyAllocBackOrder": {
            "type": "integer",
            "description": "Amount of in stock inventory allocated to a backorder.",
            "format": "int32"
          },
          "updatedDateTime": {
            "type": "string",
            "description": "The updated date and time of this fulfillment center.",
            "format": "date-time"
          },
          "qtyReserved": {
            "type": "integer",
            "description": "Reserved amount, may be used for auctions or other purposes.",
            "format": "int32"
          },
          "restockTime": {
            "type": "string",
            "description": "Next planned restock time.",
            "format": "date-time"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The item fulfillment center."
      },
      "ItemFulfillmentCenterCollection": {
        "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/ItemFulfillmentCenter"
            }
          }
        },
        "description": "A collection of item fulfillment centers."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}