{
  "openapi": "3.0.1",
  "info": {
    "title": "Item Specifications",
    "description": "Create and administer collection of item specifications.",
    "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 Specifications",
      "description": "Provide RESTful services to manage item specifications."
    }
  ],
  "paths": {
    "/item-specifications": {
      "get": {
        "tags": [
          "Item Specifications"
        ],
        "description": "Get a collection of item specifications.",
        "operationId": "getItemSpecifications",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the item specification.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "organizationId",
            "in": "query",
            "description": "The organization ID of the item specification.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "baseItemId",
            "in": "query",
            "description": "The base item of this item specification associated with.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "markForDelete",
            "in": "query",
            "description": "Indicates if the specified item is marked for deletion, 0 = No, it may be ordered. 1 = Marked for deletion and cannot be ordered or backordered.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "partNumber",
            "in": "query",
            "description": "Uniquely identifies an item for a particular owner.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "updatedDateTime",
            "in": "query",
            "description": "The last time this item specification was updated.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "discontinued",
            "in": "query",
            "description": "Y = This item specification has been discontinued. It can be ordered if there is sufficient inventory but it cannot be backordered. N = This item specification is active and may be backordered if out of stock.",
            "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 item specifications.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemSpecificationCollection"
                }
              }
            }
          },
          "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 Specifications"
        ],
        "description": "Create an item specification.",
        "operationId": "createItemSpecification",
        "requestBody": {
          "description": "The item specifications.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ItemSpecifications"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Base Items.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetItemSpecificationsById": {
                "operationRef": "#/paths/~1item-specifications~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 /item-specifications/{id}`.\n"
              },
              "DeleteItemSpecificationsById": {
                "operationRef": "#/paths/~1item-specifications~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 /item-specifications/{id}`.\n"
              },
              "UpdateItemSpecificationsById": {
                "operationRef": "#/paths/~1item-specifications~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 /item-specifications/{id}`. \n"
              },
              "GetItemFullfillmentCentersByItemSpecificationsId": {
                "operationRef": "#/paths/~1item-specifications~1{id}~1item-fulfillment-centers/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /item-specifications/{id}/item-fulfillment-centers`.\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": "ItemSpecification"
      }
    },
    "/item-specifications/{id}": {
      "get": {
        "tags": [
          "Item Specifications"
        ],
        "description": "Get an item specification.",
        "operationId": "getItemSpecificationById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying 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 specifications.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemSpecification"
                }
              }
            }
          },
          "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 Specifications"
        ],
        "description": "Delete an item specifications.",
        "operationId": "deleteItemSpecificationById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying 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 Specifications"
        ],
        "description": "Update an item specification.",
        "operationId": "updateItemSpecificationById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the item specification.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "The item specifications.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ItemSpecifications"
              }
            }
          },
          "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": "ItemSpecification"
      }
    },
    "/item-specifications/{id}/item-fulfillment-centers": {
      "get": {
        "tags": [
          "Item Specifications"
        ],
        "description": "Finds item fulfillment center attached to the specified item.",
        "operationId": "getItemFulfillmentCentersOfItemSpecification",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the item specification.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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"
                }
              }
            }
          }
        }
      }
    }
  },
  "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."
      },
      "ItemSpecifications": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the item specification.",
            "format": "int64"
          },
          "organizationId": {
            "type": "integer",
            "description": "The organization ID of the item specification.",
            "format": "int64"
          },
          "baseItemId": {
            "type": "integer",
            "description": "The base item of this item specification associated with.",
            "format": "int64"
          },
          "markForDelete": {
            "type": "integer",
            "description": "Indicates if the specified item is marked for deletion, 0 = No, it may be ordered. 1 = Marked for deletion and cannot be ordered or backordered.",
            "format": "int32"
          },
          "partNumber": {
            "type": "string",
            "description": "Uniquely identifies an item for a particular owner."
          },
          "updatedDateTime": {
            "type": "string",
            "description": "The last time this item specification was updated.",
            "format": "date-time"
          },
          "discontinued": {
            "type": "string",
            "description": "Y = This item specification has been discontinued. It can be ordered if there is sufficient inventory but it cannot be backordered. N = This item specification is active and may be backordered if out of stock."
          }
        }
      },
      "ItemSpecification": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the item specification.",
            "format": "int64"
          },
          "organizationId": {
            "type": "integer",
            "description": "The organization ID of the item specification.",
            "format": "int64"
          },
          "baseItemId": {
            "type": "integer",
            "description": "The base item of this item specification associated with.",
            "format": "int64"
          },
          "markForDelete": {
            "type": "integer",
            "description": "Indicates if the specified item is marked for deletion, 0 = No, it may be ordered. 1 = Marked for deletion and cannot be ordered or backordered.",
            "format": "int32"
          },
          "partNumber": {
            "type": "string",
            "description": "Uniquely identifies an item for a particular owner."
          },
          "updatedDateTime": {
            "type": "string",
            "description": "The last time this item specification was updated.",
            "format": "date-time"
          },
          "discontinued": {
            "type": "string",
            "description": "Y = This item specification has been discontinued. It can be ordered if there is sufficient inventory but it cannot be backordered. N = This item specification is active and may be backordered if out of stock."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "item-fulfillment-centers": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The item fulfillment center attached to the specified item."
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "The item specifications."
      },
      "ItemSpecificationCollection": {
        "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/ItemSpecification"
            }
          }
        },
        "description": "A collection of item specifications."
      },
      "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"
          }
        },
        "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": []
    }
  ]
}