Get FR Store Cluster Local Rate(s)
1 min
GET
https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}
Path Parameters
- locationIdstringrequiredDescription
Header Parameters
- x-upstart-tenantstringrequiredDescription
- x-upstart-sitestringDescription
Responses
200
- FRStoreClusterLocationLocalRateResponse[]Description
- locationIdstringrequired
- ratesFRStoreClusterLocalRate[]requiredDescription
- siteIdstringrequiredDescription
- storeIdstringrequiredDescriptionMin Length1
- isActivebooleanDescription
- storeLocalDeliveryRateobjectrequired
- baseDistancenumber<double>requiredDescriptionFormatdoubleMinimum0Maximum9999
- maximumDistancenumber<double>requiredDescriptionFormatdoubleMinimum0Maximum9999
- baseMinimumCostnumberrequiredDescriptionMinimum0Maximum999999
- baseMaximumCostnumberrequiredDescriptionMinimum0Maximum999999
- percentageSubtotalnumberrequiredDescriptionMinimum0Maximum100
- perMileCostnumberrequiredDescriptionMinimum0Maximum9999
- basicRateUpperSubtotalLimitnumberrequiredDescriptionMinimum0Maximum999999
- basicRatePromotionalSubtotalLimitnumberDescriptionMinimum0Maximum999999
- premiumDeliveryChargesnumberrequiredDescriptionMinimum0Maximum9999
- basicDeliveryChargesnumberrequiredDescriptionMinimum0Maximum9999
- basicConfigurationsEnabledbooleanrequiredDescription
- premiumConfigurationsEnabledbooleanrequiredDescription
401
- ErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
curl
curl --request GET \
--url https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId} \
--header 'accept: application/json' \
--header 'x-upstart-tenant: string'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-store-cluster-local-rate/location-rates/{locationId}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-upstart-tenant': 'string'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK-the rate(s) are successfully returned.
[
{
"locationId": "",
"rates": [
{
"siteId": "",
"storeId": "",
"isActive": false,
"storeLocalDeliveryRate": {
"baseDistance": "",
"maximumDistance": "",
"baseMinimumCost": 0,
"baseMaximumCost": 0,
"percentageSubtotal": 0,
"perMileCost": 0,
"basicRateUpperSubtotalLimit": 0,
"basicRatePromotionalSubtotalLimit": 0,
"premiumDeliveryCharges": 0,
"basicDeliveryCharges": 0,
"basicConfigurationsEnabled": false,
"premiumConfigurationsEnabled": false
}
}
]
}
]401
// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}