API reference
- Getting Started with Your API
- SDKs and Toolkits
- Subscriptions Overview
- POSTAdd Subscription Item
- PUTApply Coupon
- PUTChange Pricelist On Subscription
- PUTConvert To Order
- PUTDelete Subscription Draft
- PUTDelete Subscription Item
- GETGet Available Shipment Methods
- GETGet Reasons
- GETGet Subscription Attributes
- PUTUpdate Subscription Attribute
- POSTCreate Subscription Attributes
- GETGet Subscription Data
- GETGet Subscription Item Data
- GETGet Subscriptions
- POSTCreates Subscription
- GETGets Subscription
- PUTUpdate Subscription
- PUTOrder Now
- PUTOrder Partial Subscription
- PUTPerform Subscription Action
- PUTRemove Coupons
- PUTSkip Subscription
- POSTUpdate Adjustments
- PUTUpdate Fulfillment Info
- PUTUpdate Installment plan
- PUTUpdate Item Fulfillment
- PUTUpdate Item Quantity
- PUTUpdate Next Order Date
- PUTUpdate Payment
- PUTUpdate Subscription Data
- DELDelete Subscription Data
- PUTUpdate Subscription Frequency
- PUTUpdate Subscription Item Data
- DELDelete Subscription Item Data
- PUTUpsert Inventory Tags
Error
A valid request URL is required to generate request examples[
{
"currencyCode": "<string>",
"price": 123,
"data": {},
"fulfillmentMethod": "<string>",
"isValid": true,
"messages": [
"<string>"
],
"shippingItemRates": [
{
"amount": 123,
"itemId": "<string>",
"quantity": 123
}
],
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingZoneCode": "<string>"
}
]Get Available Shipment Methods
Gets valid shipping methods for subscription
GET
/
commerce
/
subscriptions
/
{subscriptionId}
/
shipments
/
methods
Error
A valid request URL is required to generate request examples[
{
"currencyCode": "<string>",
"price": 123,
"data": {},
"fulfillmentMethod": "<string>",
"isValid": true,
"messages": [
"<string>"
],
"shippingItemRates": [
{
"amount": 123,
"itemId": "<string>",
"quantity": 123
}
],
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingZoneCode": "<string>"
}
]Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Query Parameters
limits which fields are returned in the response body
Response
Success
ISO currency code such as US dollars. Currently, only USD is supported.
How much the customer pays for shipping which includes any shipping discounts that the merchant offers.
Custom data returned by the shipping service.
Fulfillment method of the shipping rate. eg) Ship or Delivery
If true, the shipping rate is valid.
Messages and detail about why the shipping rate may be invalid.
Show child attributes
Show child attributes
Code that uniquely identifies the selected shipping method.
Shipping Method Name
The shipping zone to which this rate applies.
⌘I