{ "openapi": "3.0.1", "info": { "title": "Jurisdictions", "version": "9.1.20.0", "description": "Create and administer collection of jurisdictions.", "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": "Jurisdictions", "description": "Provide RESTful services to manage jurisdictions." } ], "paths": { "/jurisdictions": { "get": { "tags": [ "Jurisdictions" ], "description": "Get a collection of jurisdictions.", "operationId": "getJurisdictions", "parameters": [ { "name": "searchString", "in": "query", "description": "Limits search results to only include jurisdictions that match the value of this parameter. Searches are case-insensitive.", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The unique ID for the jurisdiction.", "schema": { "type": "integer", "format": "int32" } }, { "name": "code", "in": "query", "description": "A code which, together with its storeId and subclass, uniquely identifies this jurisdiction.", "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 types as follows: 1 = ShippingJurisdiction. 2 = TaxJurisdiction.", "schema": { "type": "integer", "format": "int32" } }, { "name": "description", "in": "query", "description": "A brief description of the jurisdiction, suitable for display by a user interface that manages jurisdiction definitions.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "The country or region.", "schema": { "type": "string" } }, { "name": "countryAbbreviation", "in": "query", "description": "An optional ISO standard abbreviation code for the country or region.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "The state, province, or other equivalent region.", "schema": { "type": "string" } }, { "name": "stateAbbreviation", "in": "query", "description": "An optional country specific abbreviation code for the state or province.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "The city or an equivalent.", "schema": { "type": "string" } }, { "name": "district", "in": "query", "description": "The district or an equivalent.", "schema": { "type": "string" } }, { "name": "county", "in": "query", "description": "The county or an equivalent.", "schema": { "type": "string" } }, { "name": "zipcodeStart", "in": "query", "description": "The starting ZIP code or postal code of a range of ZIP codes or postal codes.", "schema": { "type": "string" } }, { "name": "zipcodeEnd", "in": "query", "description": "The ending ZIP code or postal code of a range of ZIP codes or postal codes.", "schema": { "type": "string" } }, { "name": "geoCode", "in": "query", "description": "A tax code that is based on geographic region. This code is used to support Taxware integration.", "schema": { "type": "string" } }, { "name": "markForDelete", "in": "query", "description": "Indicates if this jurisdiction 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 jurisdictions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JurisdictionCollection" } } } }, "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": [ "Jurisdictions" ], "description": "Create a jurisdiction.", "operationId": "createJurisdiction", "requestBody": { "description": "Provides RESTful services to manage jurisdictions. Jurisdictions are geographical regions or zones that represent a country, region, province, territory, or ZIP code range in which you sell goods.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Jurisdiction" } } }, "required": true }, "responses": { "201": { "description": "The operation was successful.", "content": {}, "headers": { "Location": { "description": "The URI of the Jurisdiction.", "schema": { "type": "string" } } }, "links": { "GetJurisdictionByJurisdictionId": { "operationRef": "#/paths/~1jurisdictions~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 /jurisdictions/{id}`.\n" }, "DeleteJurisdictionByJurisdictionId": { "operationRef": "#/paths/~1jurisdictions~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 /jurisdictions/{id}`.\n" }, "UpdateJurisdictionByJurisdictionId": { "operationRef": "#/paths/~1jurisdictions~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 /jurisdictions/{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": "Jurisdiction" } }, "/jurisdictions/{id}": { "get": { "tags": [ "Jurisdictions" ], "description": "Get a jurisdiction.", "operationId": "getJurisdictionById", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID for the jurisdiction.", "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 jurisdictions. Jurisdictions are geographical regions or zones that represent a country, region, province, territory, or ZIP code range in which you sell goods.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Jurisdiction" } } } }, "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": [ "Jurisdictions" ], "description": "Delete a jurisdiction.", "operationId": "deleteJurisdictionById", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID for the jurisdiction.", "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": [ "Jurisdictions" ], "description": "Update a jurisdiction.", "operationId": "updateJurisdictionById", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID for the jurisdiction.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Provides RESTful services to manage jurisdictions. Jurisdictions are geographical regions or zones that represent a country, region, province, territory, or ZIP code range in which you sell goods.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Jurisdiction" } } }, "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": "Jurisdiction" } } }, "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." }, "Jurisdiction": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "storeId": { "type": "integer" }, "subclass": { "type": "integer" }, "description": { "type": "string" }, "country": { "type": "string" }, "countryAbbreviation": { "type": "string" }, "state": { "type": "string" }, "stateAbbreviation": { "type": "string" }, "city": { "type": "string" }, "district": { "type": "string" }, "county": { "type": "string" }, "zipcodeStart": { "type": "string" }, "zipcodeEnd": { "type": "string" }, "geoCode": { "type": "string" }, "markForDelete": { "type": "integer" } }, "required": [ "id", "code", "storeId", "subclass", "description", "country", "countryAbbreviation", "state", "stateAbbreviation", "city", "district", "county", "zipcodeStart", "zipcodeEnd", "geoCode", "markForDelete", "links" ] }, "JurisdictionCollection": { "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" }, "country": { "type": "string" }, "countryAbbreviation": { "type": "string" }, "state": { "type": "string" }, "stateAbbreviation": { "type": "string" }, "city": { "type": "string" }, "district": { "type": "string" }, "county": { "type": "string" }, "zipcodeStart": { "type": "string" }, "zipcodeEnd": { "type": "string" }, "geoCode": { "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", "country", "countryAbbreviation", "state", "stateAbbreviation", "city", "district", "county", "zipcodeStart", "zipcodeEnd", "geoCode", "markForDelete", "links" ] } }, "count": { "type": "integer" } }, "required": [ "href", "items", "count" ] } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ] }