{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipping Jurisdiction Calculation Rules",
    "version": "9.1.20.0",
    "description": "Create and administer jurisdiction calculation rules for shipping.",
    "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": {
    "/shipping-jurisdiction-calculation-rules": {
      "get": {
        "tags": [
          "shipping-jurisdiction-calculation-rules"
        ],
        "description": "Get a collection of shipping jurisdiction calculation rule.",
        "operationId": "getShippingJurisdictionCalculationRules",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The shipping jurisdiction calculation rule ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "precedence",
            "in": "query",
            "description": "When a shipping address falls within more than one of the specified ShippingJurisdictionGroups, for the same FulfillmentCenter and ShippingMode, only the CalculationRule with the highest SHPJCRULE.PRECEDENCE value qualifies.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "calculationRuleId",
            "in": "query",
            "description": "The calculation rule ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "jurisdictionGroupId",
            "in": "query",
            "description": "The jurisdiction group ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fulfillmentCenterId",
            "in": "query",
            "description": "The fulfillment center ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "shippingModeId",
            "in": "query",
            "description": "The shipping mode ID.",
            "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 shipping jurisdiction calculation rule.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingJurisdictionCalculationRuleCollection"
                }
              }
            }
          },
          "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": [
          "shipping-jurisdiction-calculation-rules"
        ],
        "description": "Create a shipping jurisdiction calculation rule.",
        "operationId": "createShippingJurisdictionCalculationRule",
        "requestBody": {
          "description": "A Shipping jurisdiction calculation rule.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShippingJurisdictionCalculationRule"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {}
          },
          "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": "ShippingJurisdictionCalculationRule"
      }
    },
    "/shipping-jurisdiction-calculation-rules/{id}": {
      "get": {
        "tags": [
          "shipping-jurisdiction-calculation-rules"
        ],
        "description": "Get a shipping jurisdiction calculation rule.",
        "operationId": "getShippingJurisdictionCalculationRuleById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The shipping jurisdiction calculation rule ID.",
            "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 Shipping jurisdiction calculation rule.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingJurisdictionCalculationRule"
                }
              }
            }
          },
          "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": [
          "shipping-jurisdiction-calculation-rules"
        ],
        "description": "Delete a shipping jurisdiction calculation rule.",
        "operationId": "deleteShippingJurisdictionCalculationRuleById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The shipping jurisdiction calculation rule ID.",
            "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": [
          "shipping-jurisdiction-calculation-rules"
        ],
        "description": "Update a shipping jurisdiction calculation rule.",
        "operationId": "updateShippingJurisdictionCalculationRuleById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The shipping jurisdiction calculation rule ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A Shipping jurisdiction calculation rule.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShippingJurisdictionCalculationRule"
              }
            }
          },
          "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": "ShippingJurisdictionCalculationRule"
      }
    }
  },
  "components": {
    "schemas": {
      "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."
      },
      "ShippingJurisdictionCalculationRule": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The shipping jurisdiction calculation rule ID.",
            "format": "int32"
          },
          "precedence": {
            "type": "number",
            "description": "When a shipping address falls within more than one of the specified ShippingJurisdictionGroups, for the same FulfillmentCenter and ShippingMode, only the CalculationRule with the highest SHPJCRULE.PRECEDENCE value qualifies.",
            "format": "double"
          },
          "calculationRuleId": {
            "type": "integer",
            "description": "The calculation rule ID.",
            "format": "int32"
          },
          "jurisdictionGroupId": {
            "type": "integer",
            "description": "The jurisdiction group ID.",
            "format": "int32"
          },
          "fulfillmentCenterId": {
            "type": "integer",
            "description": "The fulfillment center ID.",
            "format": "int32"
          },
          "shippingModeId": {
            "type": "integer",
            "description": "The shipping mode ID.",
            "format": "int32"
          }
        },
        "description": "A Shipping jurisdiction calculation rule."
      },
      "ShippingJurisdictionCalculationRuleCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/ShippingJurisdictionCalculationRule"
            }
          }
        },
        "description": "A collection of shipping jurisdiction calculation rule."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}