Get FR Postal Code Rate(s)
1 min
GET
https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-postal-code-rate
Query Parameters
- postalCodestringDescription
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/jsonapplication/xml
- x-upstart-tenantstringrequiredDescription
- x-upstart-sitestringDescription
Responses
200
- FRPostalCodeRate[]Examplesexample-1:
[ { "siteId": "201cb789-4198-488b-a5eb-4e7df0fb4bee", "postalCode": "123", "isActive": true, "frPostalRate": { "basicDeliveryCharges": 10, "basicRateUpperSubtotalLimit": 10, "basicRatePromotionalSubtotalLimit": 100, "premiumDeliveryCharges": 20, "baseMinimumCost": 50, "baseMaximumCost": 80, "percentageSubtotal": 7 } } ]Description- siteIdstringrequired
- postalCodestringrequiredMin Length1
- isActivebooleanDefaulttrue
- frPostalRateobjectrequired
- basicDeliveryChargesnumberrequiredMinimum0Maximum9999
- basicRateUpperSubtotalLimitnumberrequiredMinimum0Maximum999999
- basicRatePromotionalSubtotalLimitnumberMinimum0Maximum999999
- premiumDeliveryChargesnumberrequiredMinimum0Maximum9999
- baseMinimumCostnumberrequiredMinimum0Maximum999999
- baseMaximumCostnumberrequiredMinimum0Maximum999999
- percentageSubtotalnumberrequiredMinimum0Maximum100
400
- ValidationErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstring
401
- ErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
curl
curl --request GET \
--url https://api.upstartcommerce.com/v1/dmcshippingcalc/fr-postal-code-rate \
--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-postal-code-rate", 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-postal-code-rate")
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-postal-code-rate"
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
[
{
"siteId": "",
"postalCode": "",
"isActive": false,
"frPostalRate": {
"basicDeliveryCharges": 0,
"basicRateUpperSubtotalLimit": 0,
"basicRatePromotionalSubtotalLimit": 0,
"premiumDeliveryCharges": 0,
"baseMinimumCost": 0,
"baseMaximumCost": 0,
"percentageSubtotal": 0
}
}
]GENERATED
// OK
[
{
"siteId": "",
"postalCode": "",
"isActive": false,
"frPostalRate": {
"basicDeliveryCharges": 0,
"basicRateUpperSubtotalLimit": 0,
"basicRatePromotionalSubtotalLimit": 0,
"premiumDeliveryCharges": 0,
"baseMinimumCost": 0,
"baseMaximumCost": 0,
"percentageSubtotal": 0
}
}
]example-1
[
{
"siteId": "201cb789-4198-488b-a5eb-4e7df0fb4bee",
"postalCode": "123",
"isActive": true,
"frPostalRate": {
"basicDeliveryCharges": 10,
"basicRateUpperSubtotalLimit": 10,
"basicRatePromotionalSubtotalLimit": 100,
"premiumDeliveryCharges": 20,
"baseMinimumCost": 50,
"baseMaximumCost": 80,
"percentageSubtotal": 7
}
}
]400
// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
"name": "",
"code": "",
"detail": ""
}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": ""
}