{
  "openapi": "3.0.1",
  "info": {
    "title": "Order Blocks",
    "description": "Provide access to order blocks.",
    "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": "Order Blocks",
      "description": "Provide RESTful services to manage order blocks."
    }
  ],
  "paths": {
    "/order-blocks": {
      "get": {
        "tags": [
          "Order Blocks"
        ],
        "description": "Get a collection of order blocks.",
        "operationId": "getOrderBlocks",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the blocked order.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "orderId",
            "in": "query",
            "description": "The unique numeric order ID whose block is being recorded.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "reasonCodeId",
            "in": "query",
            "description": "The reason code Id associated with this block. It identifies the reason for the block",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "resolved",
            "in": "query",
            "description": "Indicates if this block has been resolved. That is, if it is no longer blocking the Order. 0 indicates it is not resolved, 1 indicates it is resolved",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "updatedDateTime",
            "in": "query",
            "description": "The time the block was placed or last updated.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "comment",
            "in": "query",
            "description": "Comment field to record any comments pertaining to this block. The field can be updated as needed.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Field for customization.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Field for customization.",
            "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 order blocks.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderBlockCollection"
                }
              }
            }
          },
          "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"
                }
              }
            }
          }
        }
      }
    },
    "/order-blocks/{id}": {
      "get": {
        "tags": [
          "Order Blocks"
        ],
        "description": "Get an order block.",
        "operationId": "getOrderBlockById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the blocked order.",
            "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 order block.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderBlock"
                }
              }
            }
          },
          "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"
                }
              }
            }
          }
        }
      }
    }
  },
  "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."
      },
      "OrderBlock": {
        "type": "object",
        "required": [
          "id",
          "orderId",
          "reasonCodeId"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the blocked order.",
            "format": "int64"
          },
          "orderId": {
            "type": "integer",
            "description": "The unique numeric order ID whose block is being recorded.",
            "format": "int64"
          },
          "reasonCodeId": {
            "type": "integer",
            "description": "The reason code Id associated with this block. It identifies the reason for the block",
            "format": "int32"
          },
          "resolved": {
            "type": "number",
            "description": "Indicates if this block has been resolved. That is, if it is no longer blocking the Order. 0 indicates it is not resolved, 1 indicates it is resolved"
          },
          "updatedDateTime": {
            "type": "string",
            "description": "The time the block was placed or last updated.",
            "format": "date-time"
          },
          "comment": {
            "type": "string",
            "description": "Comment field to record any comments pertaining to this block. The field can be updated as needed."
          },
          "field1": {
            "type": "integer",
            "description": "Field for customization.",
            "format": "int32"
          },
          "field2": {
            "type": "string",
            "description": "Field for customization."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The order block."
      },
      "OrderBlockCollection": {
        "type": "object",
        "required": [
          "count"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "href": {
            "type": "string",
            "description": "The link decripation"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/OrderBlock"
            }
          }
        },
        "description": "A collection of order blocks."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}