| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://www.sendowl.com/api/v1 | link | — | — | — |
Actions (43)
Orders · 11
- Cancel subscriptionPUT /api/v1/orders/{order_id}/cancel_subscription
Cancel a subscription-based order.
documented - Create orderPOST /api/v1/orders
Issue an order for a single item (bulk orders are not supported).
documented - Get orderGET /api/v1/orders/{order_id}
Retrieve a single order by ID.
documented - Get order (v1_3)GET /api/v1_3/orders/{order_id}
Legacy v1_3 single order retrieval.
documented - Grant access (v1_3)POST /api/v1_3/orders/{order_id}/access
Grant access to a previously revoked order (v1_3)
documented - List ordersGET /api/v1/orders
Return all orders.
documented - List orders (v1_3)GET /api/v1_3/orders
Legacy v1_3 orders API.
documented - Override order countryPUT /api/v1/orders/{order_id}/override_country
Override the buyer country for an order.
documented - Refund orderPOST /api/v1/orders/{order_id}/refund
Refund a completed order (optionally cancelling a subscription at the gateway).
documented - Resend order emailPOST /api/v1/orders/{order_id}/resend_email
Resend notifications related to this order.
documented - Reset download restrictionsPUT /api/v1/orders/{order_id}/download_restrictions
Reset download restrictions for an order.
documented
Bundles · 8
- Create bundlePOST /api/v1/packages
Create a new bundle (package) composed of products.
documented - Delete bundleDELETE /api/v1/packages/{package_id}
Delete a bundle.
documented - Get bundleGET /api/v1/packages/{package_id}
Retrieve a single bundle by ID.
documented - Issue bundlePOST /api/v1/packages/{package_id}/issue
Issue an order for a bundle via the API for gateway support.
documented - List bundlesGET /api/v1/packages
Return all bundles (packages) available in the account.
documented - Search bundles by nameGET /api/v1/packages/search?term={term}
Find bundles by name.
documented - Shopify lookup by variant IDGET /api/v1/packages/shopify_lookup?variant_id={variant_id}
Find a bundle by Shopify variant ID.
documented - Update bundlePUT /api/v1/packages/{package_id}
Update a bundle's details.
documented
Products · 8
- Create productPOST /api/v1/products
Create a new product (multipart form for attachments when uploading files).
documented - Delete productDELETE /api/v1/products/{product_id}
Delete a product from SendOwl.
documented - Get productGET /api/v1/products/{product_id}
Retrieve a single product by its ID.
documented - Issue productPOST /api/v1/products/{product_id}/issue
Issue an order for this product via the API for fulfillment through external gateways.
documented - List productsGET /api/v1/products
Return all products in the account.
documented - Search products by nameGET /api/v1/products/search?term={term}
Search for products by name.
documented - Shopify lookup by variant IDGET /api/v1/products/shopify_lookup?variant_id={variant_id}
Find a product by its Shopify variant ID.
documented - Update productPUT /api/v1/products/{product_id}
Update the attributes of an existing product.
documented
Subscriptions · 7
- Create subscriptionPOST /api/v1/subscriptions
Create a new subscription.
documented - Delete subscriptionDELETE /api/v1/subscriptions/{subscription_id}
Delete a subscription.
documented - Get subscriptionGET /api/v1/subscriptions/{subscription_id}
Retrieve a single subscription by ID.
documented - Issue subscriptionPOST /api/v1/subscriptions/{subscription_id}/issue
Issue a subscription order via the API.
documented - List subscriptionsGET /api/v1/subscriptions
Return all subscriptions.
documented - Search subscriptions by nameGET /api/v1/subscriptions/search?term={term}
Find subscriptions by name.
documented - Update subscriptionPUT /api/v1/subscriptions/{subscription_id}
Update a subscription.
documented
Drip Items · 5
- Add drip items to productPOST /api/v1/products/{product_id}/drip_items
Associate drip items with a product (used to release content over time).
documented - Add drip items to productPOST /api/v1/products/{product_id}/drip_items
Create drip items associated with a product.
documented - Add drip items to subscriptionPOST /api/v1/subscriptions/{subscription_id}/drip_items
Create drip items associated with a subscription.
documented - Delete drip itemDELETE /api/v1/drip_items/{drip_item_id}
Delete a drip item.
documented - Update drip itemPUT /api/v1/drip_items/{drip_item_id}
Update a drip item.
documented
Licenses · 4
- Check license validityGET /api/v1/products/{product_id}/licenses/check_valid?key={key}
Check if a license key is valid for a given product.
documented - Create licenses for productPOST /api/v1/products/{product_id}/licenses
Create licenses for a given product.
documented - List licenses for orderGET /api/v1/orders/{order_id}/licenses
Return all licenses associated with a specific order.
documented - List licenses for productGET /api/v1/products/{product_id}/licenses
Return all licenses associated with a specific product.
documented