{
  "openapi": "3.0.1",
  "info": {
    "title": "Jurisdiction Groups",
    "version": "9.1.20.0",
    "description": "Create and administer collection of jurisdiction groups.",
    "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": "Jurisdiction Groups",
      "description": "Provide RESTful services to manage jurisdiction groups."
    }
  ],
  "paths": {
    "/jurisdiction-groups": {
      "get": {
        "tags": [
          "Jurisdiction Groups"
        ],
        "description": "Get a collection of jurisdiction groups.",
        "operationId": "getJurisdictionGroups",
        "parameters": [
          {
            "name": "searchString",
            "in": "query",
            "description": "Limits search results to only include jurisdiction groups with a code that matches the value of this parameter. Searches are case-insensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "The unique ID for the jurisdiction group.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int32"
              }
            }
          },
          {
            "name": "code",
            "in": "query",
            "description": "A code which, together with its storeId and subclass, uniquely identifies this jurisdiction group.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The reference number of the store this jurisdiction associated with.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "subclass",
            "in": "query",
            "description": "Indicates the jurisdiction group subclass as follows: 1 = ShippingJurisdictionGroup. 2 = TaxJurisdictionGroup.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "A brief description of the jurisdiction group, suitable for display by a user interface that manages jurisdiction groups.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "markForDelete",
            "in": "query",
            "description": "Indicates if this jurisdiction group has been marked for deletion: 0 = No. 1 = Yes.",
            "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 jurisdiction groups.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JurisdictionGroupCollection"
                }
              }
            }
          },
          "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": [
          "Jurisdiction Groups"
        ],
        "description": "Create a jurisdiction group.",
        "operationId": "createJurisdictionGroup",
        "requestBody": {
          "description": "Provides RESTful services to manage jurisdiction groups. Jurisdiction groups are used for grouping of Jurisdictions.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JurisdictionGroup"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Jurisdiction-Group.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetJurisdictionGroupByJurisdictionGroupId": {
                "operationRef": "#/paths/~1jurisdiction-groups~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 /jurisdiction-groups/{id}`.\n"
              },
              "DeleteJurisdictionGroupByJurisdictionGroupId": {
                "operationRef": "#/paths/~1jurisdiction-groups~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 /jurisdiction-groups/{id}`.\n"
              },
              "UpdateJurisdictionGroupByJurisdictionGroupId": {
                "operationRef": "#/paths/~1jurisdiction-groups~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 /jurisdiction-groups/{id}`.\n"
              },
              "GetJurisdictionGroupRelationshipByJurisdictionGroupId": {
                "operationRef": "#/paths/~1jurisdiction-groups~1{id}~1jurisdiction-group-relationships/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /jurisdiction-groups/{id}/jurisdiction-group-relationships`.\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": "JurisdictionGroup"
      }
    },
    "/jurisdiction-groups/{id}": {
      "get": {
        "tags": [
          "Jurisdiction Groups"
        ],
        "description": "Get a jurisdiction group.",
        "operationId": "getJurisdictionGroupById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique ID for the jurisdiction group.",
            "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": "Provides RESTful services to manage jurisdiction groups. Jurisdiction groups are used for grouping of Jurisdictions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JurisdictionGroup"
                }
              }
            }
          },
          "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": [
          "Jurisdiction Groups"
        ],
        "description": "Delete a jurisdiction group.",
        "operationId": "deleteJurisdictionGroupById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique ID for the jurisdiction group.",
            "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": [
          "Jurisdiction Groups"
        ],
        "description": "Update a jurisdiction group.",
        "operationId": "updateJurisdictionGroupById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique ID for the jurisdiction group.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "Provides RESTful services to manage jurisdiction groups. Jurisdiction groups are used for grouping of Jurisdictions.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JurisdictionGroup"
              }
            }
          },
          "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": "JurisdictionGroup"
      }
    },
    "/jurisdiction-groups/{id}/jurisdiction-group-relationships": {
      "get": {
        "tags": [
          "Jurisdiction Groups"
        ],
        "description": "Finds jurisdiction group relationships of a jurisdiction group.",
        "operationId": "getJurisdictionGroupRelationshipsOfJurisdictionGroup",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique ID for the jurisdiction group.",
            "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"
            }
          },
          {
            "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 jurisdiction group to jurisdiction relationship.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JurisdictionGroupRelationshipCollection"
                }
              }
            }
          },
          "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."
      },
      "JurisdictionGroup": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "code": {
            "type": "string"
          },
          "storeId": {
            "type": "integer"
          },
          "subclass": {
            "type": "integer"
          },
          "description": {
            "type": "string"
          },
          "markForDelete": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "code",
          "storeId",
          "subclass",
          "description",
          "markForDelete",
          "links"
        ]
      },
      "JurisdictionGroupCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "code": {
                  "type": "string"
                },
                "storeId": {
                  "type": "integer"
                },
                "subclass": {
                  "type": "integer"
                },
                "description": {
                  "type": "string"
                },
                "markForDelete": {
                  "type": "integer"
                },
                "links": {
                  "type": "object",
                  "properties": {
                    "self": {
                      "type": "object",
                      "properties": {
                        "href": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "href"
                      ]
                    },
                    "jurisdiction-group-relationships": {
                      "type": "object",
                      "properties": {
                        "href": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "href"
                      ]
                    }
                  },
                  "required": [
                    "self",
                    "jurisdiction-group-relationships"
                  ]
                }
              },
              "required": [
                "id",
                "code",
                "storeId",
                "subclass",
                "description",
                "markForDelete",
                "links"
              ]
            }
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "href",
          "items",
          "count"
        ]
      },
      "JurisdictionGroupRelationship": {
        "type": "object",
        "properties": {
          "jurisdictionId": {
            "type": "integer",
            "description": "The unique ID for the jurisdiction.",
            "format": "int32"
          },
          "jurisdictionGroupId": {
            "type": "integer",
            "description": "The unique ID for the jurisdiction group.",
            "format": "int32"
          },
          "subclass": {
            "type": "integer",
            "description": "The subclass of the jurisdiction and of the jurisdiction group should match as follows: 1 = ShippingJurisdiction[Group]. 2 = TaxJurisdiction[Group].",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "group": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The jurisdiction group."
              },
              "jurisdiction": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": "The jurisdiction."
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "Relate jurisdiction groups to the jurisdictions that are inside them."
      },
      "JurisdictionGroupRelationshipCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "jurisdictionId": {
                  "type": "integer"
                },
                "jurisdictionGroupId": {
                  "type": "integer"
                },
                "subclass": {
                  "type": "integer"
                },
                "links": {
                  "type": "object",
                  "properties": {
                    "self": {
                      "type": "object",
                      "properties": {
                        "href": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "href"
                      ]
                    },
                    "jurisdiction-group": {
                      "type": "object",
                      "properties": {
                        "href": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "href"
                      ]
                    },
                    "jurisdiction": {
                      "type": "object",
                      "properties": {
                        "href": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "href"
                      ]
                    }
                  },
                  "required": [
                    "self",
                    "jurisdiction-group",
                    "jurisdiction"
                  ]
                }
              },
              "required": [
                "jurisdictionId",
                "jurisdictionGroupId",
                "subclass",
                "links"
              ]
            }
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "href",
          "items",
          "count"
        ]
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}