Skip to content

Rates

Manage shipping rates and their charging conditions.

Fields

idstringUnique identifier of the resource.
typeenumflat · priceRange · postalCode · tableCost · freeShipping · weightBased
pricenumber
currencystring
minOrderPricenumber
maxOrderPricenumber
postalCodesarray<string>
isActiveboolean
See all 28 fields
descriptionstring
discountPercentagenumber
zoneCodestring
minWeightnumber
maxWeightnumber
minValuenumber
maxValuenumber
basePricenumber
pricePerKgnumber
pricePerUnitnumber
taxIncludedboolean
surchargenumber
metadataobject
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
baseLanguagestring
translationsobject
storeIdstring
sellerIdstring
shippingMethodIdstring

Operations

MethodEndpointOperation
POST/v1/shipping/ratesCreate shipping rate
GET/v1/shipping/ratesList shipping rates
POST/v1/shipping/rates/batchCreate or update shipping rates in a batch
POST/v1/shipping/rates/live-quotesGet live shipping quotes
GET/v1/shipping/rates/{id}Get shipping rate
PUT/v1/shipping/rates/{id}Update shipping rate
DELETE/v1/shipping/rates/{id}Delete shipping rate
POST/v1/shipping/rates/exportsExport shipping rates
POST/v1/shipping/rates/importsImport shipping rates

Last updated: