API reference
- Getting Started with Your API
- SDKs and Toolkits
- Subscriptions Overview
- GETGet Subscription Attributes
- PUTUpdate Subscription Attribute
- POSTCreate Subscription Attributes
- GETGet Subscriptions
- POSTCreates Subscription
- GETGets Subscription
- PUTUpdate Subscription
- PUTPerform Subscription Action
- GETGet Reasons
- PUTOrder Now
- PUTSkip Subscription
- PUTUpdate Fulfillment Info
- GETGet Available Shipment Methods
- PUTConvert To Order
- PUTUpdate Subscription Frequency
- PUTUpdate Next Order Date
- PUTApply Coupon
- POSTUpdate Adjustments
- PUTUpdate Payment
- PUTUpdate Installment plan
- PUTChange Pricelist On Subscription
- PUTRemove Coupons
- PUTDelete Subscription Draft
- PUTOrder Partial Subscription
- GETGet Subscription Data
- GETGet Subscription Item Data
- PUTUpdate Subscription Data
- DELDelete Subscription Data
- PUTUpdate Subscription Item Data
- DELDelete Subscription Item Data
- POSTAdd Subscription Item
- PUTUpdate Item Quantity
- PUTDelete Subscription Item
- PUTUpsert Inventory Tags
- PUTUpdate Item Fulfillment
- GET
Error
Copy
Ask AI
A valid request URL is required to generate request examplesCopy
Ask AI
[
{
"currencyCode": "<string>",
"price": 123,
"fulfillmentMethod": "<string>",
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingZoneCode": "<string>",
"isValid": true,
"messages": [
"<string>"
],
"data": {},
"shippingItemRates": [
{
"itemId": "<string>",
"quantity": 123,
"amount": 123
}
]
}
]Get Available Shipment Methods
Gets valid shipping methods for subscription
GET
/
commerce
/
subscriptions
/
{subscriptionId}
/
shipments
/
methods
Error
Copy
Ask AI
A valid request URL is required to generate request examplesCopy
Ask AI
[
{
"currencyCode": "<string>",
"price": 123,
"fulfillmentMethod": "<string>",
"shippingMethodCode": "<string>",
"shippingMethodName": "<string>",
"shippingZoneCode": "<string>",
"isValid": true,
"messages": [
"<string>"
],
"data": {},
"shippingItemRates": [
{
"itemId": "<string>",
"quantity": 123,
"amount": 123
}
]
}
]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.
Fulfillment method of the shipping rate. eg) Ship or Delivery
Code that uniquely identifies the selected shipping method.
Shipping Method Name
The shipping zone to which this rate applies.
If true, the shipping rate is valid.
Messages and detail about why the shipping rate may be invalid.
Custom data returned by the shipping service.
Show child attributes
Show child attributes
⌘I