Get Rate for Item
1 min
POST
https://api.upstartcommerce.com/v1/shipping-method/rate/catalog-item
Header Parameters
- x-upstart-tenantstringrequiredDescription
- x-upstart-sitestringDescription
Body Parameters
- bodyCatalogItemShippingRatesRequestrequiredDescription
- catalogItemIdstringrequiredExampleDescription
- countrystringrequiredExampleDescription
- currencystringrequiredExampleDescription
- locationToIdstringExampleDescription
- postalCodestringrequiredExampleDescription
- productItemSkuIdstringrequiredExampleDescription
- quantityintegerrequiredExampleDescriptionMinimum1
- shippingMethodIdsstring[]requiredDescription
- stateOrRegionstringExampleDescription
Responses
200
- CatalogItemShippingRatesResponseDescription
- catalogItemIdstringrequiredExampleDescription
- currencystringrequiredExampleDescriptionPattern^[A-Z]{3}$
- errorsErrorMessage[]requiredDescription
- levelstring<INFO | WARN | ERROR>requiredExampleDescriptionAllowedINFOWARNERROR
- codestringrequiredExampleDescription
- messagestringExampleDescription
- detailstringExampleDescription
- itemsCatalogItemShippingItem[]requiredDescription
- countrystringrequiredExampleDescription
- errorsErrorMessage[]requiredDescription
- levelstring<INFO | WARN | ERROR>requiredExampleDescriptionAllowedINFOWARNERROR
- codestringrequiredExampleDescription
- messagestringExampleDescription
- detailstringExampleDescription
- locationFromIdstringExampleDescriptionDefault
- locationToIdstringExampleDescriptionDefault
- packagesShippingPackage[]requiredDescription
- dimensionsDimensionsDescription
- widthnumber<double>requiredExampleDescriptionFormatdouble
- lengthnumber<double>requiredExampleDescriptionFormatdouble
- heightnumber<double>requiredExampleDescriptionFormatdouble
- unitstring<cm | m | in | mm>requiredExampleDescriptionAllowedcmminmm
- insuredValuenumberExampleDescriptionDefault0
- packageCodestringExampleDescriptionDefault
- weightWeightrequiredDescription
- valuenumber<double>requiredExampleDescriptionFormatdouble
- unitstring<g | kg | lb>requiredExampleDescriptionAllowedgkglb
- postalCodestringrequiredExampleDescription
- rateServiceCodestringExampleDescriptionDefault
- rateVariantsShippingRate[]requiredDescription
- carrierCodestringrequiredExampleDescription
- carrierDeliveryDatesstringrequiredDescription
- carrierIdstringrequiredExampleDescription
- deliveryDaysinteger<int32>ExampleDescriptionFormatint32
- estimatedDeliveryDatestring<date-time>ExampleDescriptionFormatdate-time
- packageTypestringExampleDescription
- pricingShippingRatePricingrequiredDescription
- confirmationnumberExampleDescription
- insurancenumberExampleDescription
- othernumberExampleDescription
- shippingnumberrequiredExampleDescription
- feenumberExampleDescription
- rateIdstringrequiredExampleDescription
- serviceCodestringrequiredExampleDescription
- serviceTypestringrequiredExampleDescription
- shipDatestring<date-time>ExampleDescriptionFormatdate-time
- shippingMethodIdstring<uuid>requiredDescriptionFormatuuid
- shippingMethodNamestringrequiredExampleDescriptionDefault
- productItemSkuIdstringrequiredExampleDescriptionDefault
400
- ValidationErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstring
- reasonstring
401
- ErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
curl
curl --request POST \
--url https://api.upstartcommerce.com/v1/shipping-method/rate/catalog-item \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-upstart-tenant: string' \
--data '{
"catalogItemId": "item1",
"country": "USA",
"currency": "USD",
"postalCode": "43234",
"productItemSkuId": "SKU_item1",
"quantity": 1,
"shippingMethodIds": []
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");
var raw = JSON.stringify({
"catalogItemId": "item1",
"country": "USA",
"currency": "USD",
"postalCode": "43234",
"productItemSkuId": "SKU_item1",
"quantity": 1,
"shippingMethodIds": []
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/v1/shipping-method/rate/catalog-item", 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/shipping-method/rate/catalog-item")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
"catalogItemId": "item1",
"country": "USA",
"currency": "USD",
"postalCode": "43234",
"productItemSkuId": "SKU_item1",
"quantity": 1,
"shippingMethodIds": []
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/v1/shipping-method/rate/catalog-item"
payload = json.dumps({
"catalogItemId": "item1",
"country": "USA",
"currency": "USD",
"postalCode": "43234",
"productItemSkuId": "SKU_item1",
"quantity": 1,
"shippingMethodIds": []
})
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-upstart-tenant': 'string'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success-resulting shipping rate returned.
{
"catalogItemId": "item1",
"currency": "USD",
"errors": [
{
"level": "INFO",
"code": "ERR-123",
"message": "Something unexpected happened",
"detail": "Could not contact other service"
}
],
"items": [
{
"country": "USA",
"errors": [
{
"level": "INFO",
"code": "ERR-123",
"message": "Something unexpected happened",
"detail": "Could not contact other service"
}
],
"locationFromId": "locationFromId",
"locationToId": "locationToId",
"packages": [
{
"dimensions": {
"width": 10.5,
"length": 20,
"height": 15,
"unit": "cm"
},
"insuredValue": 100,
"packageCode": "PackageCode",
"weight": {
"value": 2.5,
"unit": "kg"
}
}
],
"postalCode": "43234",
"rateServiceCode": "rateServiceCode",
"rateVariants": [
{
"carrierCode": "carrierCode",
"carrierDeliveryDates": "",
"carrierId": "DHL",
"deliveryDays": 5,
"estimatedDeliveryDate": "2017-07-21T17:32:28Z",
"packageType": "packageType",
"pricing": {
"confirmation": 200,
"insurance": 100,
"other": 10,
"shipping": 100,
"fee": 20
},
"rateId": "rate1",
"serviceCode": "serviceCode",
"serviceType": "serviceType",
"shipDate": "2017-07-21T17:32:28Z"
}
],
"shippingMethodId": "",
"shippingMethodName": "Standard shipping"
}
],
"productItemSkuId": "SKU_item1"
}400
// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}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": ""
}