Skip to content

Methods

Manage the shipping methods a shopper can select.

Fields

idstringUnique identifier of the resource.
namestring
typeenumregular · express · sameDay · pickup · localDelivery
currencystring
displayNamestring
isActiveboolean
sortOrderinteger
minOrderAmountnumber
See all 27 fields
maxOrderAmountnumber
minWeightnumber
maxWeightnumber
allowSplitFulfillmentboolean
availableDaysarray<enum>
basePricenumber
estimatedDeliveryDaysinteger
estimatedDeliveryHoursinteger
metadataobject
ratesarray<object>
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
baseLanguagestring
translationsobject
storeIdstring
sellerIdstring
shippingProfileIdstring
connectionIdstring
pickupPointIdsarray<string>

Operations

MethodEndpointOperation
POST/v1/shipping/methodsCreate shipping method
GET/v1/shipping/methodsList shipping methods
GET/v1/shipping/methods/{id}Get shipping method
PUT/v1/shipping/methods/{id}Update shipping method
DELETE/v1/shipping/methods/{id}Delete shipping method
GET/v1/shipping/methods/{id}/ratesList shipping method rates

Last updated: