Jump to Content
QPilot - The Most Flexible Subscription Delivery Platform
GuidesAPI ReferenceChangelog
Back to QPilot.cloudQPilot - The Most Flexible Subscription Delivery Platform
API Reference
Back to QPilot.cloud
GuidesAPI ReferenceChangelog

QPilot API

  • Getting started
  • Quick Start Guide
  • What's new in 2.0
  • ScheduledOrders
    • /find-in-queueget
    • Get Scheduled Ordersget
    • Create Scheduled Orderpost
    • Get Scheduled Order By Idget
    • Update Scheduled Orderput
    • Delete Scheduled Orderdel
    • Upsert Scheduled Orderpost
    • Get Next Scheduled Orderget
    • Get Scheduled Order Processing Cyclesget
    • Change Scheduled Order Statusput
    • Bulk Change Scheduled Orders Statusput
    • Update Scheduled Order Frequencyput
    • Safe Activate Scheduled Orderput
    • Calculate Next Occurrenceget
    • Update Scheduled Order Next Occurrenceput
    • Update Scheduled Order Estimated Delivery Date With Nextime Integrationput
    • Change Scheduled Order Payment Methodpatch
    • Switch Customer in Scheduled Orderpatch
    • Retry Processingpost
    • Bulk Processingpost
    • /Sites/{siteId}/ScheduledOrders/{id}/Retry/{tokenJWT}post
    • /Sites/{siteId}/ScheduledOrders/{scheduledOrderId}/RetryUpdateOrderpost
    • /Sites/{siteId}/ScheduledOrders/Exportget
    • /Sites/{siteId}/ScheduledOrdersByProductget
    • /Sites/{siteId}/ScheduledOrdersByProduct/Countget
    • /Sites/{siteId}/ScheduledOrdersByProduct/Exportget
    • /Sites/{siteId}/ScheduledOrdersHistory/ExportElasticget
    • /Sites/{siteId}/ScheduledOrdersHistory/Exportget
    • /Sites/{siteId}/ScheduledOrdersHistoryyElasticget
    • /Sites/{siteId}/ScheduledOrdersHistoryget
    • Get Scheduled Orders Processed to be chargedget
    • Get Scheduled Orders (V3 - Lightweight Response)get
  • ScheduledOrderItems
    • Get Scheduled Order Itemget
    • Update Scheduled Order Itemput
    • Delete Scheduled Order Itemdel
    • Create Scheduled Order Itemspost
  • Customers
    • Get Customerget
    • Edit Customerput
    • Delete Customerdel
    • Create Customerpost
    • Get Customersget
    • /Sites/{siteId}/Customers/Upsertpost
    • Get Customer Scheduled Ordersget
    • Get Customer Payment Methodsget
    • Get Customers Summariesget
    • Get Customer Event Logsget
    • Get Customer revenue metricsget
  • Products
    • Get Productget
    • Update Productput
    • DeleteByExternalId Productdel
    • Create Productpost
    • Get Productsget
    • Upserts a batch of Products by Idspost
    • Get Products By Idsget
    • Get Scheduled Orders that use the Productget
    • /Sites/{siteId}/Products/ProductsAndProductGroupget
    • /Sites/{siteId}/Products/Forecastingget
  • AccessTokens
    • /AccessTokens/Loginpost
    • /Sites/{siteId}/AccessTokens/CustomerLoginpost
    • /Sites/{siteId}/AccessTokens/Generatepost
  • AdminNotifications
    • /admin/Notifications/{siteId}/ExecuteUpcomingSchedueldOrderNotificationspost
    • /admin/Notifications/{siteId}/ExecuteScheduledOrderLockNotificationspost
  • Bundles
    • /Sites/{siteId}/Bundles/{bundleId}/Settingsget
    • /Sites/{siteId}/Bundles/{bundleId}/Calculatepost
  • ChurnReports
    • /Sites/{siteId}/Reports/CohortReport/{periodInMonths}/{status}get
    • /Sites/{siteId}/Reports/ScheduledOrdersChurn/{periodInMonths}get
    • /Sites/{siteId}/Reports/ScheduledOrdersByCycles/{periodInMonths}get
  • Coupons
    • Get Couponsget
    • Create Couponpost
    • Update Couponput
    • Delete Coupondel
    • Get Coupon By Identifierget
    • Get Coupon By Codeget
    • Validate Couponspost
  • Dashboard
    • /Sites/{siteId}/dashboard/SOsCreatedByMonth/{periodInMonths}get
    • /Sites/{siteId}/dashboard/SOsDeletedByMonth/{periodInMonths}get
    • /Sites/{siteId}/dashboard/SOsErrorCodeCounts/{periodInMonths}get
    • /Sites/{siteId}/dashboard/SOsProcessedByMonth/{periodInMonths}get
    • /Sites/{siteId}/dashboard/MonthlyReportByCurrency/{periodInMonths}get
  • EmailPreview
    • Sends a test email preview to specified email addresses for a given site.post
    • Gets the latest scheduled orders for email preview purposes for a given site.get
  • Notifications
    • /Notifications/ScheduledOrders/{id}/Subscribepost
    • /Notifications/ScheduledOrders/{id}/Unsubscribepost
    • /Notifications/ScheduledOrders/{id}/NotifyProcessingStatusChangedpost
  • PaymentIntegrations
    • Get Payment Integrationsget
    • Create Payment Integrationpost
    • Get Payment Integrationget
    • Update Payment Integrationput
    • Delete Payment Integrationdel
  • PaymentMethods
    • Get Payment Methodsget
    • Create Payment Methodpost
    • Get Payment Methodget
    • Update Payment Methodput
    • Delete Payment Methoddel
    • Upsert Payment Methodpost
    • Get Scheduled Orders that use the Payment Methodget
    • Get a customer's other payment methods from the payment gatewayget
  • ProcessingCycles
    • Get Processing Cycle Processing Logsget
    • /Sites/{siteId}/ProcessingCycles/{processingCycleId}put
    • Get Processing Cycle Processing Logsget
  • ProductGroups
    • Get Product Groupsget
    • Create Product Grouppost
    • Get Product Groupget
    • Update Product Groupput
    • Delete Product Groupdel
  • QuickLinks
    • Retrieves a paginated list of QuickLinks for a specific site with optional filtering, search, and sorting.get
    • Creates a new QuickLink for a site.post
    • Retrieves a single QuickLink by its unique identifier.get
    • Updates an existing QuickLink's properties.put
    • Deletes a QuickLink. By default performs a soft delete (sets status to Deleted). Use permanent=true to permanently remove the QuickLink and all related data.del
    • Updates only the status of a QuickLink (enabled/disabled/deleted).patch
    • Verifies if a QuickLink can be consumed by checking validity, status, expiration, usage limits, and permissions.post
    • Records the usage of a QuickLink after the associated action has been performed.post
    • Retrieves usage analytics and metrics for a QuickLink.get
    • Generates a secure single-use token for a QuickLink tied to a specific scheduled order.post
    • Converts text to a URL-friendly slug and checks if it's available for use.post
    • Get QuickLink settings for a site (auto-creates with default values if not exists).get
    • Update QuickLink settings for a site.put
  • Annex A: Updating Entities
  • Annex B: Working with Metadata
  • Annex C: Shipping
  • Annex D: Working with Webhooks
  • Annex E: Site Integrations
  • SecretKeys
    • /SecretKeys/{id}get
    • /SecretKeys/{id}del
    • /SecretKeys/{userId}/SecretKeysget
    • /SecretKeyspost
  • ShippingAddresses
    • Get Shipping Addressesget
    • Create Shipping Addresspost
    • Get Shipping Addressget
    • Update Shipping Addressput
    • Delete Shipping Addressdel
  • ShippingIntegrations
    • Get Shipping Integrationsget
    • Create Shipping Integrationpost
    • Get Shipping Integrationget
    • Update Shipping Integrationput
    • Delete Shipping Integrationdel
  • ShippingRates
    • Get Shipping Ratesget
    • Create Shipping Ratepost
    • /Sites/{siteId}/ShippingRates/Nextimeget
    • Sync Nextime Delivery Dates for a Scheduled Orderpost
    • Get Shipping Rateget
    • Update Shipping Rateput
    • Delete Shipping Ratedel
  • ShopifyWebhooks
    • /ShopifyWebhooksget
    • /ShopifyWebhooksdel
    • /ShopifyWebhooks/Shopdel
  • Sites
    • Get Siteget
    • Get Sitesget
    • Create Sitepost
    • Get Sitesget
    • Update Siteput
    • Delete Sitedel
    • /Sites/{siteId}/Metadataput
    • /Sites/{siteId}/MigrateV3post
    • Get Site Integration Statusget
    • Get Site customers revenue metricsget
    • /Sites/{siteId}/Pauseput
    • /Sites/{siteId}/Resumeput
  • SitesConfigurations
    • /SitesConfigurations/{siteId}/tierget
  • UsersPermissions
    • /UsersPermissions/Page/{pageUrl}/{siteId}get
    • /UsersPermissions/{siteId}get
    • /UsersPermissions/PagesAllowedget
    • /UsersPermissionspost
  • VersionChecker
    • /Sites/VersionChecker/VersionNumberget
  • Webhooks
    • Creates a Webhookpost
    • Get Webhooksget
    • Get Webhookget
    • Update Webhookput
    • Delete Webhookdel
    • /Sites/{siteId}/Webhooks/Sample/{webhookEventType}get
    • /Sites/{siteId}/Webhooks/PollingSample/{webhookEventType}get
Powered by 

Annex E: Site Integrations

WooCommerce Integration

QPilot supports connected Sites and managing Scheduled Orders with WooCommerce using the free Wordpress plugin: Autoship Cloud powered by QPilot™.

If you are running a WooCommerce store, visit the Autoship Cloud help site and use the Install & Launch Guide to get started.