Retrieves all valid delivery methods available for a specific subscription contract. Returns shipping profiles and delivery options based on the contract’s delivery address and product characteristics.
Delivery Information Returned:
Filtering Behavior: By default, returns only delivery methods valid for the contract:
Include All Methods:
Use header X-Include-All-Methods: true to return all delivery methods regardless of eligibility. Useful for admin UIs where you want to show all options.
Use Cases:
Common Scenarios:
Customer Portal - Change Delivery Speed:
Subscription Creation - Delivery Selection:
Important Notes:
Authentication: Requires X-API-Key header
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/data/contract-delivery-options[
{
"profileId": 12345,
"profileName": "Standard Shipping",
"methods": [
{
"id": "method_123",
"name": "Standard Delivery (5-7 days)",
"code": "STANDARD",
"price": "5.99",
"currency": "USD"
},
{
"id": "method_124",
"name": "Express Delivery (2-3 days)",
"code": "EXPRESS",
"price": "12.99",
"currency": "USD"
}
]
}
]Documentation Index
Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/data/contract-delivery-options[
{
"profileId": 12345,
"profileName": "Standard Shipping",
"methods": [
{
"id": "method_123",
"name": "Standard Delivery (5-7 days)",
"code": "STANDARD",
"price": "5.99",
"currency": "USD"
},
{
"id": "method_124",
"name": "Express Delivery (2-3 days)",
"code": "EXPRESS",
"price": "12.99",
"currency": "USD"
}
]
}
]