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

This endpoint is used to configure store distance 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": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "array", "description": "", "minItems": 1, "uniqueItems": true, "customType": "DMCStoreOverrideDistanceRate[]", "schema": [ { "name": "siteIds", "kind": "required", "type": "array", "description": "Configuration's site identifiers.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "locationId", "kind": "required", "type": "string", "description": "The store ID for which the rates are specified.", "minLength": 1 }, { "name": "distance", "kind": "required", "type": "number", "description": "The distance relative to the provided Store ID for which the rates are specified." }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "A flag that tells whether this configuration is active or not." }, { "name": "storeLocalDeliveryRate", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "distance", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "dropOff", "kind": "optional", "type": "number", "description": "Drop off service rate." }, { "name": "whiteGlove", "kind": "optional", "type": "number", "description": "White glove service rate." }, { "name": "whiteGlovePlus", "kind": "optional", "type": "number", "description": "White glove plus service rate." }, { "name": "dropOffExtraCharges", "kind": "optional", "type": "number", "description": "Drop off service rate after including extra products." }, { "name": "whiteGloveExtraCharges", "kind": "optional", "type": "number", "description": "White glove service rate after including extra products." }, { "name": "whiteGlovePlusExtraCharges", "kind": "optional", "type": "number", "description": "White glove plus service rate after including extra products." }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Quantity for which these configurations are applicable." }, { "name": "maxDistance", "kind": "required", "type": "number", "description": "

The store's base/maximum distance till which it provides delivery.

" }, { "name": "perMileRate", "kind": "optional", "type": "number", "description": "

Per mile rate applied on base/max distance.

" }, { "name": "haulAwayEnabled", "kind": "optional", "type": "boolean", "description": "Is Haul Away Allowed for this entry" } ] } ], "modelRef": "#/components/schemas/DMCStoreOverrideDistanceRate", "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 store distance 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": "5enkjc2X-bt7mtMY05xi9", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-store-distance-rate/location-rates \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '[\n {\n \"siteIds\": [],\n \"locationId\": \"\",\n \"distance\": \"\",\n \"storeLocalDeliveryRate\": {\n \"maxDistance\": \"\"\n }\n }\n ]'" }, { "id": "EO42NOLwCpIQlApalnB7f", "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 \"locationId\": \"\",\n \"distance\": \"\",\n \"storeLocalDeliveryRate\": {\n \"maxDistance\": \"\"\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-store-distance-rate/location-rates\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Ncy3cx-Falj85D9zJq-ys", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-store-distance-rate/location-rates\")\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 \"locationId\": \"\",\n \"distance\": \"\",\n \"storeLocalDeliveryRate\": {\n \"maxDistance\": \"\"\n }\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "rpjVvT1xwil-dRIflWD7d", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/dmcshippingcalc/dmc-store-distance-rate/location-rates\"\n\npayload = json.dumps([\n {\n \"siteIds\": [],\n \"locationId\": \"\",\n \"distance\": \"\",\n \"storeLocalDeliveryRate\": {\n \"maxDistance\": \"\"\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": "5enkjc2X-bt7mtMY05xi9" }, "results": { "languages": [ { "id": "YnEgCreB9gcl-fbj_jeU3", "language": "200", "code": "// OK-the store distance rates are added successfully.\n" }, { "id": "A6P-0Jf8DYCgcN_VKOMQD", "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": "F4XybXF6Orzy3gHyW_C9u", "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": "YnEgCreB9gcl-fbj_jeU3" } }, "children": [ { "text": "" } ] }