{
  "openapi": "3.0.1",
  "info": {
    "title": "Number Usages",
    "description": "Create and administer number usages.",
    "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": "Number Usages",
      "description": "Provide RESTful services to manage number usages."
    }
  ],
  "paths": {
    "/number-usages": {
      "get": {
        "tags": [
          "Number Usages"
        ],
        "description": "Get a collection of number usages.",
        "operationId": "getNumberUsages",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "code",
            "in": "query",
            "description": "Applications can specify this value to identify their application specific NumberUsages. It is suggested that Java package naming conventions be used to facilitate application integration. Values starting with \"com.ibm.\" are reserved for IBM.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of number usages.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberUsageCollection"
                }
              }
            }
          },
          "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": [
          "Number Usages"
        ],
        "description": "Create a number usage.",
        "operationId": "createNumberUsage",
        "requestBody": {
          "description": "Number usage description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NumberUsage.requestbody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Number Usages.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetNumberUsagesByNumberUsagesId": {
                "operationRef": "#/paths/~1number-usages~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 /number-usages/{id}`.\n"
              },
              "DeleteNumberUsagesByNumberUsagesId": {
                "operationRef": "#/paths/~1number-usages~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 /number-usages/{id}`.\n"
              },
              "UpdateNumberUsagesByNumberUsagesId": {
                "operationRef": "#/paths/~1number-usages~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 /number-usages/{id}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "NumberUsage"
      }
    },
    "/number-usages/{id}": {
      "get": {
        "tags": [
          "Number Usages"
        ],
        "description": "Get a number usage.",
        "operationId": "getNumberUsageById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "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"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Number usage description.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberUsage"
                }
              }
            }
          },
          "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": [
          "Number Usages"
        ],
        "description": "Delete a number usage.",
        "operationId": "deleteNumberUsageById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "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": [
          "Number Usages"
        ],
        "description": "Update a number usage.",
        "operationId": "updateNumberUsageById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Number usage description.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NumberUsage.requestbody"
              }
            }
          },
          "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": "NumberUsage"
      }
    },
    "/number-usages/{id}/currency-formats": {
      "get": {
        "tags": [
          "Number Usages"
        ],
        "description": "Finds the currency format relationships of a currency.",
        "operationId": "getCurrencyFormatsOfNumberUsage",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "required": true,
            "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"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of currency formats.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyFormatCollection"
                }
              }
            }
          },
          "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"
                }
              }
            }
          }
        }
      }
    },
    "/number-usages/{id}/number-usage-descriptions": {
      "get": {
        "tags": [
          "Number Usages"
        ],
        "description": "Finds the description relationships of a number usage.",
        "operationId": "getNumberUsageDescriptionsOfNumberUsage",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "required": true,
            "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"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of NumberUsage descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NumberUsageDescriptionCollection"
                }
              }
            }
          },
          "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."
      },
      "NumberUsage": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "format": "int32"
          },
          "code": {
            "type": "string",
            "description": "Applications can specify this value to identify their application specific NumberUsages. It is suggested that Java package naming conventions be used to facilitate application integration. Values starting with \"com.ibm.\" are reserved for IBM."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "currency-formats": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The currency format relationships of a currency."
              },
              "number-usage-descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The description relationships of a number usage ."
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "Number usage description."
      },
      "NumberUsage.requestbody": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "format": "int32"
          },
          "code": {
            "type": "string",
            "description": "Applications can specify this value to identify their application specific NumberUsages. It is suggested that Java package naming conventions be used to facilitate application integration. Values starting with \"com.ibm.\" are reserved for IBM."
          }
        },
        "description": "Number usage description."
      },
      "NumberUsageCollection": {
        "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/NumberUsage"
            }
          }
        },
        "description": "A collection of number usages."
      },
      "CurrencyFormat": {
        "type": "object",
        "properties": {
          "storeEntityId": {
            "type": "integer",
            "description": "The StoreEntity this formatting rule is part of.",
            "format": "int32"
          },
          "currency": {
            "type": "string",
            "description": "The currency. This is a currency code as per ISO 4217 standards."
          },
          "roundingMultiple": {
            "type": "integer",
            "description": "Rounding multiple according to national law or practice. For example, specify 5 to round dollars to the nearest five cent piece. The default value is 1.",
            "format": "int32"
          },
          "numberUsg": {
            "type": "integer",
            "description": "This currency formatting rule should be used when formatting monetary amounts for this usage.",
            "format": "int32"
          },
          "roundingMethod": {
            "type": "string",
            "description": "How to round to a multiple of ROUNDINGMULTIPLE R = round normally - up or down - to the nearest multiple T = truncate - round down for positive amounts, round up for negative amounts."
          },
          "decimalPlaces": {
            "type": "integer",
            "description": "The number of decimal places in a rounded or truncated monetary amount.",
            "format": "int32"
          },
          "minimumApproveAmount": {
            "type": "number",
            "description": "A small amount to be authorized when a backorder is initially submitted, to check that a successful authorization can be obtained. The full amount of the Order will not be authorized until sufficient inventory is allocated to release the backorder."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                }
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "Language-independent part of a currency formatting rule."
      },
      "CurrencyFormatCollection": {
        "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/CurrencyFormat"
            }
          }
        },
        "description": "A collection of currency formats."
      },
      "NumberUsageDescription": {
        "type": "object",
        "properties": {
          "numberUsageId": {
            "type": "integer",
            "description": "Generated unique key. Negative values are reserved for IBM. WebSphere Commerce defines and uses the following values:-1 = com.ibm.commerce.default, -2 = com.ibm.commerce.unitPrice, -3 = com.ibm.commerce.listPrice, -4 = com.ibm.commerce.text, -5 = com.ibm.commerce.textUnitPrice",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language used for the NumberUsage.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the NumberUsage, suitable for display by an administration user interface that works with NumberUsages."
          }
        },
        "description": "Language-dependent information for a NumberUsage."
      },
      "NumberUsageDescriptionCollection": {
        "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/NumberUsageDescription"
            }
          }
        },
        "description": "A collection of NumberUsage descriptions."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}