--- title: Add DMC State Rate slug: api-documentation/add-dmc-state-rate docTags: createdAt: 2026-08-27T16:55:41.659Z --- { "id": "XSLLj5xd39LWMyOzKdWmu", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-state-rate", "servers": [ { "url": "https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-state-rate" } ], "name": "Add DMC State Rate", "description": "

This endpoint is used to configure state rates for DMC.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." }, { "kind": "optional", "name": "x-upstart-site", "type": "string", "description": "Unique identifier for the site." } ], "queryParameters": [ { "kind": "optional", "name": "stateCode", "type": "string", "description": "The state code of the stored record which is to be updated." } ], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "array", "description": "", "minItems": 1, "uniqueItems": true, "customType": "DMCStateOverrideRateRequest[]", "schema": [ { "name": "siteIds", "kind": "required", "type": "array", "description": "Site identifiers for which this configuration is added.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "state", "kind": "required", "type": "string", "description": "The state code for which the rates are specified.", "minLength": 1 }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "A flag that tells whether this configuration is active or not." }, { "name": "freightDeliveryRateRequest", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/FreightDeliveryRateRequest", "customType": "FreightDeliveryRateRequest", "schema": [ { "name": "dropOff", "kind": "required", "type": "number", "description": "Drop off service charges." }, { "name": "dropOffPercentage", "kind": "required", "type": "number", "description": "Percentage applied on drop off charges after quantity surpass." }, { "name": "whiteGlove", "kind": "required", "type": "number", "description": "White glove service charges." }, { "name": "whiteGlovePercentage", "kind": "required", "type": "number", "description": "Percentage applied on white glove charges after quantity surpass." }, { "name": "whiteGlovePlus", "kind": "required", "type": "number", "description": "White glove plus service charges." }, { "name": "whiteGlovePlusPercentage", "kind": "required", "type": "number", "description": "Percentage applied on white glove plus charges after quantity surpass." }, { "name": "quantity", "kind": "required", "type": "number", "description": "Quantity for which these configurations are applicable." }, { "name": "haulAwayEnabled", "kind": "optional", "type": "boolean", "description": "Is Haul Away Allowed for this entry" } ] } ], "modelRef": "#/components/schemas/DMCStateOverrideRateRequest", "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-the state rates are added successfully.

", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "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": "", "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": "s5OVLTouxkxwpaFByDc3Y", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-state-rate \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '[\n {\n \"siteIds\": [],\n \"state\": \"\",\n \"freightDeliveryRateRequest\": {\n \"dropOff\": \"\",\n \"dropOffPercentage\": \"\",\n \"whiteGlove\": \"\",\n \"whiteGlovePercentage\": \"\",\n \"whiteGlovePlus\": \"\",\n \"whiteGlovePlusPercentage\": \"\",\n \"quantity\": \"\"\n }\n }\n ]'" }, { "id": "Fuy-2BOkC8tqIMzAOy1PR", "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 {\n \"siteIds\": [],\n \"state\": \"\",\n \"freightDeliveryRateRequest\": {\n \"dropOff\": \"\",\n \"dropOffPercentage\": \"\",\n \"whiteGlove\": \"\",\n \"whiteGlovePercentage\": \"\",\n \"whiteGlovePlus\": \"\",\n \"whiteGlovePlusPercentage\": \"\",\n \"quantity\": \"\"\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/dmc-state-rate\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "URfklOlbqEf8cNq5NnYRe", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-state-rate\")\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 {\n \"siteIds\": [],\n \"state\": \"\",\n \"freightDeliveryRateRequest\": {\n \"dropOff\": \"\",\n \"dropOffPercentage\": \"\",\n \"whiteGlove\": \"\",\n \"whiteGlovePercentage\": \"\",\n \"whiteGlovePlus\": \"\",\n \"whiteGlovePlusPercentage\": \"\",\n \"quantity\": \"\"\n }\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "Lf2waQtu-vgyWmPmE5ZWg", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-state-rate\"\n\npayload = json.dumps([\n {\n \"siteIds\": [],\n \"state\": \"\",\n \"freightDeliveryRateRequest\": {\n \"dropOff\": \"\",\n \"dropOffPercentage\": \"\",\n \"whiteGlove\": \"\",\n \"whiteGlovePercentage\": \"\",\n \"whiteGlovePlus\": \"\",\n \"whiteGlovePlusPercentage\": \"\",\n \"quantity\": \"\"\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": "s5OVLTouxkxwpaFByDc3Y" }, "results": { "languages": [ { "id": "A7vRplN53K7NVnJQ3eH8Z", "language": "200", "code": "// OK-the state rates are added successfully.\n" }, { "id": "p3pqfVdtjcjB6k9HC14f7", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "oHlCTr-GE9tX91Ebt7jPz", "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": "A7vRplN53K7NVnJQ3eH8Z" } }, "children": [ { "text": "" } ] }