{
  "openapi": "3.0.1",
  "info": {
    "title": "Store Entity Calculation Usages",
    "version": "9.1.20.0",
    "description": "Create and administer store entity calculation usages.",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "paths": {
    "/store-entity-calculation-usages": {
      "get": {
        "tags": [
          "store-entity-calculation-usages"
        ],
        "description": "Get a collection of Store Entity Calculation Usages.",
        "operationId": "getStoreEntityCalculationUsages",
        "parameters": [
          {
            "name": "storeId",
            "in": "query",
            "description": "The store entity id.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "usageFlags",
            "in": "query",
            "description": "Bit flags to control how the OrderPrepare command uses this CalculationUsage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "sequence",
            "in": "query",
            "description": "The OrderPrepare command uses CalculationUsage in ascending order of this Sequence attribute.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "calculationCodeId",
            "in": "query",
            "description": "The default CalculationCode, of the specified CalculationUsage, for the StoreEntity.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "calculationUsageId",
            "in": "query",
            "description": "The CalculationUsage.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "activeCalculationCodeCombineMethodId",
            "in": "query",
            "description": "The CalculationCodeCombineMethod for the StoreEntity and CalculationUsage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "activeCalculationRuleCombineMethodId",
            "in": "query",
            "description": "The CalculationRuleCombineMethod for the StoreEntity and CalculationUsage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "applyCalculationUsageMethodId",
            "in": "query",
            "description": "The ApplyCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "summarizeCalculationUsageMethodId",
            "in": "query",
            "description": "The SummarizeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "initializeCalculationUsageMethodId",
            "in": "query",
            "description": "The InitializeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "finalizeCalculationUsageMethodId",
            "in": "query",
            "description": "The FinalizeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "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 Store Entity Calculation Usages.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreEntityCalculationUsageCollection"
                },
                "example": {
                  "href": "https://10.190.66.10:8000/rest/admin/v2/store-entity-calculation-usages",
                  "items": [
                    {
                      "storeId": "-1,",
                      "usageFlags": "1,",
                      "sequence": "0.0,",
                      "calculationCodeId": "null,",
                      "calculationUsageId": "-5,",
                      "activeCalculationCodeCombineMethodId": "-5001,",
                      "activeCalculationRuleCombineMethodId": "-5005,",
                      "applyCalculationUsageMethodId": "-5232,",
                      "summarizeCalculationUsageMethodId": "-5233,",
                      "initializeCalculationUsageMethodId": "-5231,",
                      "finalizeCalculationUsageMethodId": "-5234,",
                      "links": {
                        "self": {
                          "href": "https://10.190.66.10:8000/rest/admin/v2/store-entity-calculation-usages/storeId:-1,calculationUsageId:-5"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "store-entity-calculation-usages"
        ],
        "description": "Create a Store Entity Calculation Usage.",
        "operationId": "createStoreEntityCalculationUsage",
        "requestBody": {
          "description": "A Store Entity Calculation Usage.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreEntityCalculationUsages"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Store Entity Calculation Usages.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetStoreEntityCalculationUsagesByStoreIdAndCalculationUsageId": {
                "operationRef": "#/paths/~1store-entity-calculation-usages~1storeId:{storeId},calculationUsageId:{calculationUsageId}/get",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "calculationUsageId": "$request.body#/calculationUsageId"
                },
                "description": "The `storeId` value used in the request body can be used as the `storeId` parameter in `GET /store-entity-calculation-usages/storeId:{storeId},calculationUsageId:{calculationUsageId}`.\n"
              },
              "DeleteStoreEntityCalculationUsagesByStoreIdAndCalculationUsageId": {
                "operationRef": "#/paths/~1store-entity-calculation-usages~1storeId:{storeId},calculationUsageId:{calculationUsageId}/delete",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "calculationUsageId": "$request.body#/calculationUsageId"
                },
                "description": "The `storeId` value used in the request body can be used as the `storeId` parameter in `DELETE /store-entity-calculation-usages/storeId:{storeId},calculationUsageId:{calculationUsageId}`.\n"
              },
              "UpdateStoreEntityCalculationUsagesByStoreIdAndCalculationUsageId": {
                "operationRef": "#/paths/~1store-entity-calculation-usages~1storeId:{storeId},calculationUsageId:{calculationUsageId}/patch",
                "parameters": {
                  "storeId": "$request.body#/storeId",
                  "calculationUsageId": "$request.body#/calculationUsageId"
                },
                "description": "The `storeId` value used in the request body can be used as the `stroeId` parameter in `PATCH /store-entity-calculation-usages/storeId:{storeId},calculationUsageId:{calculationUsageId}`.\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": "StoreEntityCalculationUsage"
      }
    },
    "/store-entity-calculation-usages/storeId:{storeId},calculationUsageId:{calculationUsageId}": {
      "get": {
        "tags": [
          "store-entity-calculation-usages"
        ],
        "description": "Get a Store Entity Calculation Usage.",
        "operationId": "getStoreEntityCalculationUsageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store entity id.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "calculationUsageId",
            "in": "path",
            "description": "The CalculationUsage.",
            "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": "A Store Entity Calculation Usage.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreEntityCalculationUsage"
                },
                "example": {
                  "storeId": "-1,",
                  "usageFlags": "1,",
                  "sequence": "3.0,",
                  "calculationCodeId": "null,",
                  "calculationUsageId": "-3,",
                  "activeCalculationCodeCombineMethodId": "-41,",
                  "activeCalculationRuleCombineMethodId": "-45,",
                  "applyCalculationUsageMethodId": "-222,",
                  "summarizeCalculationUsageMethodId": "-223,",
                  "initializeCalculationUsageMethodId": "-221,",
                  "finalizeCalculationUsageMethodId": "null,",
                  "links": {
                    "self": {
                      "href": "https://10.190.66.10:8000/rest/admin/v2/store-entity-calculation-usages/storeId:-1,calculationUsageId:-3"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "store-entity-calculation-usages"
        ],
        "description": "Delete a Store Entity Calculation Usage.",
        "operationId": "deleteStoreEntityCalculationUsageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store entity id.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "calculationUsageId",
            "in": "path",
            "description": "The CalculationUsage.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "store-entity-calculation-usages"
        ],
        "description": "Update a Store Entity Calculation Usage.",
        "operationId": "updateStoreEntityCalculationUsageById",
        "parameters": [
          {
            "name": "storeId",
            "in": "path",
            "description": "The store entity id.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "calculationUsageId",
            "in": "path",
            "description": "The CalculationUsage.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A Store Entity Calculation Usage.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreEntityCalculationUsages"
              },
              "example": {
                "storeId": "-1",
                "usageFlags": "1",
                "sequence": "3.0",
                "calculationCodeId": null,
                "calculationUsageId": "-3",
                "activeCalculationCodeCombineMethodId": "-41",
                "activeCalculationRuleCombineMethodId": "-45",
                "applyCalculationUsageMethodId": "-222",
                "summarizeCalculationUsageMethodId": "-223",
                "initializeCalculationUsageMethodId": "-221",
                "finalizeCalculationUsageMethodId": null
              }
            }
          },
          "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": "StoreEntityCalculationUsage"
      }
    }
  },
  "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."
      },
      "StoreEntityCalculationUsage": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The store entity id.",
            "format": "int32"
          },
          "usageFlags": {
            "type": "integer",
            "description": "Bit flags to control how the OrderPrepare command uses this CalculationUsage.",
            "format": "int32"
          },
          "sequence": {
            "type": "number",
            "description": "The OrderPrepare command uses CalculationUsage in ascending order of this Sequence attribute.",
            "format": "double"
          },
          "calculationCodeId": {
            "type": "integer",
            "nullable": true,
            "description": "The default CalculationCode, of the specified CalculationUsage, for the StoreEntity.",
            "format": "int32"
          },
          "calculationUsageId": {
            "type": "integer",
            "description": "The CalculationUsage.",
            "format": "int32"
          },
          "activeCalculationCodeCombineMethodId": {
            "type": "integer",
            "description": "The CalculationCodeCombineMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "activeCalculationRuleCombineMethodId": {
            "type": "integer",
            "description": "The CalculationRuleCombineMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "applyCalculationUsageMethodId": {
            "type": "integer",
            "description": "The ApplyCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "summarizeCalculationUsageMethodId": {
            "type": "integer",
            "description": "The SummarizeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "initializeCalculationUsageMethodId": {
            "type": "integer",
            "description": "The InitializeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "finalizeCalculationUsageMethodId": {
            "type": "integer",
            "description": "The FinalizeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The self link."
              }
            }
          }
        },
        "description": "A Store Entity Calculation Usage."
      },
      "StoreEntityCalculationUsages": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "integer",
            "description": "The store entity id.",
            "format": "int32"
          },
          "usageFlags": {
            "type": "integer",
            "description": "Bit flags to control how the OrderPrepare command uses this CalculationUsage.",
            "format": "int32"
          },
          "sequence": {
            "type": "number",
            "description": "The OrderPrepare command uses CalculationUsage in ascending order of this Sequence attribute.",
            "format": "double"
          },
          "calculationCodeId": {
            "type": "integer",
            "nullable": true,
            "description": "The default CalculationCode, of the specified CalculationUsage, for the StoreEntity.",
            "format": "int32"
          },
          "calculationUsageId": {
            "type": "integer",
            "description": "The CalculationUsage.",
            "format": "int32"
          },
          "activeCalculationCodeCombineMethodId": {
            "type": "integer",
            "description": "The CalculationCodeCombineMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "activeCalculationRuleCombineMethodId": {
            "type": "integer",
            "description": "The CalculationRuleCombineMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "applyCalculationUsageMethodId": {
            "type": "integer",
            "description": "The ApplyCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "summarizeCalculationUsageMethodId": {
            "type": "integer",
            "description": "The SummarizeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "initializeCalculationUsageMethodId": {
            "type": "integer",
            "description": "The InitializeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          },
          "finalizeCalculationUsageMethodId": {
            "type": "integer",
            "description": "The FinalizeCalculationUsageMethod for the StoreEntity and CalculationUsage.",
            "format": "int32"
          }
        }
      },
      "StoreEntityCalculationUsageCollection": {
        "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/StoreEntityCalculationUsage"
            }
          }
        },
        "description": "A collection of Store Entity Calculation Usages."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}