--- title: Add Exclusion List slug: api-documentation/add-exclusion-list createdAt: 2026-08-27T16:55:41.659Z --- { "id": "bFe7cRaRCtJaR-ikIsRA_", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/dmcshippingcalc/exclusion-list", "servers": [ { "url": "https://api.upstartcommerce.com/v1/dmcshippingcalc/exclusion-list" } ], "name": "Add Exclusion List", "description": "

Endpoint to create an exclusion list.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Some body", "customType": "ExclusionListRequest", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "filter", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "key", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "" } ], "modelRef": "#/components/schemas/ExclusionListRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "subExamples": [], "schema": [ { "kind": "optional", "type": "object", "description": "

An exclusion list as held, with the filters that select its items.

", "customType": "ExclusionListResponse", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "filter", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "key", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "" } ], "modelRef": "#/components/schemas/ExclusionListResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "path", "kind": "optional", "type": "string", "description": "" }, { "name": "errors", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.

", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/dmcshippingcalc/exclusion-list \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"siteIds\": [],\n \"name\": \"\",\n \"filter\": [\n {\n \"key\": \"\",\n \"value\": []\n }\n ]\n }'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"siteIds\": [],\n \"name\": \"\",\n \"filter\": [\n {\n \"key\": \"\",\n \"value\": []\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/dmcshippingcalc/exclusion-list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/dmcshippingcalc/exclusion-list\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"siteIds\": [],\n \"name\": \"\",\n \"filter\": [\n {\n \"key\": \"\",\n \"value\": []\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/dmcshippingcalc/exclusion-list\"\n\npayload = json.dumps({\n \"siteIds\": [],\n \"name\": \"\",\n \"filter\": [\n {\n \"key\": \"\",\n \"value\": []\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// OK\n{\n \"id\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"filter\": [\n {\n \"key\": \"\",\n \"value\": [\n \"\"\n ]\n }\n ],\n \"isActive\": false\n}", "subExamples": [ { "label": "GENERATED", "code": "// OK\n{\n \"id\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"filter\": [\n {\n \"key\": \"\",\n \"value\": [\n \"\"\n ]\n }\n ],\n \"isActive\": false\n}" } ] }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": [\n {\n \"path\": \"\",\n \"errors\": [\n {\n \"id\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ]\n}" }, { "id": "response-2-401", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }