--- title: Get FR Store Cluster Local Rate(s) slug: api-documentation/get-fr-store-cluster-local-rates docTags: createdAt: 2026-08-27T16:55:41.659Z --- { "id": "ha0RHLF-S_r10zYF4i6ai", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}", "servers": [ { "url": "https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}" } ], "name": "Get FR Store Cluster Local Rate(s)", "description": "

This endpoint is used to get all or some specific store distance rates for FR.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "optional", "name": "locationId", "type": "string", "description": "The store id of the stored record which is to be deleted." } ], "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." }, { "kind": "optional", "name": "x-upstart-site", "type": "string", "description": "Unique identifier for the site." } ], "queryParameters": [], "bodyDataParameters": [], "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 rate(s) are successfully returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "FRStoreClusterLocationLocalRateResponse[]", "schema": [ { "name": "locationId", "kind": "required", "type": "string", "description": "" }, { "name": "rates", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/FRStoreClusterLocalRate", "customType": "FRStoreClusterLocalRate[]", "schema": [ { "name": "siteId", "kind": "required", "type": "string", "description": "Configuration's site identifier." }, { "name": "storeId", "kind": "required", "type": "string", "description": "The store ID 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": "storeLocalDeliveryRate", "kind": "required", "type": "object", "description": "", "example": "", "schema": [ { "name": "baseDistance", "kind": "required", "type": "number", "description": "Store's minimum delivery distance.", "format": "double", "minimum": 0, "maximum": 9999 }, { "name": "maximumDistance", "kind": "required", "type": "number", "description": "Store's maximum delivery distance.", "format": "double", "minimum": 0, "maximum": 9999 }, { "name": "baseMinimumCost", "kind": "required", "type": "number", "description": "Minimum threshold of sum price of all products bought by the customer for premium rates.", "minimum": 0, "maximum": 999999 }, { "name": "baseMaximumCost", "kind": "required", "type": "number", "description": "Maximum threshold of sum price of all products bought by the customer for premium rates.", "minimum": 0, "maximum": 999999 }, { "name": "percentageSubtotal", "kind": "required", "type": "number", "description": "The percentage applied to the subtotal amount to calculate the premium rates.", "minimum": 0, "maximum": 100 }, { "name": "perMileCost", "kind": "required", "type": "number", "description": "The cost of each mile the parcel has to travel to reach the destination outside Base Rate Distance Delivery but within the Maximum Distance Delivery area.", "minimum": 0, "maximum": 9999 }, { "name": "basicRateUpperSubtotalLimit", "kind": "required", "type": "number", "description": "The upper threshold level of subtotal for Basic Rate to be applicable.", "minimum": 0, "maximum": 999999 }, { "name": "basicRatePromotionalSubtotalLimit", "kind": "optional", "type": "number", "description": "

The upper limit of promotional subtotal, for free basic delivery.

", "minimum": 0, "maximum": 999999 }, { "name": "premiumDeliveryCharges", "kind": "required", "type": "number", "description": "Premium service charges.", "minimum": 0, "maximum": 9999 }, { "name": "basicDeliveryCharges", "kind": "required", "type": "number", "description": "Basic service charges.", "minimum": 0, "maximum": 9999 }, { "name": "basicConfigurationsEnabled", "kind": "required", "type": "boolean", "description": "A flag that tells whether basic rate configuration is active or not." }, { "name": "premiumConfigurationsEnabled", "kind": "required", "type": "boolean", "description": "A flag that tells whether premium rate configuration is active or not." } ] } ] } ], "modelRef": "#/components/schemas/FRStoreClusterLocationLocalRateResponse", "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": "wboXiUyGGA6Ir_-4wOEpN", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId} \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "AZsl9-5MjyxyYtN8M2Mwk", "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 requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "xWXtQvqMkO2BHB_ALoBE-", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "h4neGzmHTAbcKF3ioBj7H", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "wboXiUyGGA6Ir_-4wOEpN" }, "results": { "languages": [ { "id": "d16j7aYYQiVYGWFHEGc_I", "language": "200", "code": "// OK-the rate(s) are successfully returned.\n[\n {\n \"locationId\": \"\",\n \"rates\": [\n {\n \"siteId\": \"\",\n \"storeId\": \"\",\n \"isActive\": false,\n \"storeLocalDeliveryRate\": {\n \"baseDistance\": \"\",\n \"maximumDistance\": \"\",\n \"baseMinimumCost\": 0,\n \"baseMaximumCost\": 0,\n \"percentageSubtotal\": 0,\n \"perMileCost\": 0,\n \"basicRateUpperSubtotalLimit\": 0,\n \"basicRatePromotionalSubtotalLimit\": 0,\n \"premiumDeliveryCharges\": 0,\n \"basicDeliveryCharges\": 0,\n \"basicConfigurationsEnabled\": false,\n \"premiumConfigurationsEnabled\": false\n }\n }\n ]\n }\n]" }, { "id": "8kSJnWACPmrEerJg6L4on", "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": "d16j7aYYQiVYGWFHEGc_I" } }, "children": [ { "text": "" } ] }