Jump to Content
Guides
API Reference
Changelog
Back to QPilot.cloud
API Reference
Back to QPilot.cloud
Guides
API Reference
Changelog
/SecretKeys/{userId}/SecretKeys
JUMP TO
QPilot API
Getting started
Quick Start Guide
What's new in 2.0
ScheduledOrders
/find-in-queue
get
Get Scheduled Orders
get
Create Scheduled Order
post
Get Scheduled Order By Id
get
Update Scheduled Order
put
Delete Scheduled Order
del
Upsert Scheduled Order
post
Get Next Scheduled Order
get
Get Scheduled Order Processing Cycles
get
Change Scheduled Order Status
put
Bulk Change Scheduled Orders Status
put
Update Scheduled Order Frequency
put
Safe Activate Scheduled Order
put
Calculate Next Occurrence
get
Update Scheduled Order Next Occurrence
put
Update Scheduled Order Estimated Delivery Date With Nextime Integration
put
Change Scheduled Order Payment Method
patch
Switch Customer in Scheduled Order
patch
Retry Processing
post
Bulk Processing
post
/Sites/{siteId}/ScheduledOrders/{id}/Retry/{tokenJWT}
post
/Sites/{siteId}/ScheduledOrders/{scheduledOrderId}/RetryUpdateOrder
post
/Sites/{siteId}/ScheduledOrders/Export
get
/Sites/{siteId}/ScheduledOrdersByProduct
get
/Sites/{siteId}/ScheduledOrdersByProduct/Count
get
/Sites/{siteId}/ScheduledOrdersByProduct/Export
get
/Sites/{siteId}/ScheduledOrdersHistory/ExportElastic
get
/Sites/{siteId}/ScheduledOrdersHistory/Export
get
/Sites/{siteId}/ScheduledOrdersHistoryyElastic
get
/Sites/{siteId}/ScheduledOrdersHistory
get
Get Scheduled Orders Processed to be charged
get
Get Scheduled Orders (V3 - Lightweight Response)
get
ScheduledOrderItems
Get Scheduled Order Item
get
Update Scheduled Order Item
put
Delete Scheduled Order Item
del
Create Scheduled Order Items
post
Customers
Get Customer
get
Edit Customer
put
Delete Customer
del
Create Customer
post
Get Customers
get
/Sites/{siteId}/Customers/Upsert
post
Get Customer Scheduled Orders
get
Get Customer Payment Methods
get
Get Customers Summaries
get
Get Customer Event Logs
get
Get Customer revenue metrics
get
Products
Get Product
get
Update Product
put
DeleteByExternalId Product
del
Create Product
post
Get Products
get
Upserts a batch of Products by Ids
post
Get Products By Ids
get
Get Scheduled Orders that use the Product
get
/Sites/{siteId}/Products/ProductsAndProductGroup
get
/Sites/{siteId}/Products/Forecasting
get
AccessTokens
/AccessTokens/Login
post
/Sites/{siteId}/AccessTokens/CustomerLogin
post
/Sites/{siteId}/AccessTokens/Generate
post
AdminNotifications
/admin/Notifications/{siteId}/ExecuteUpcomingSchedueldOrderNotifications
post
/admin/Notifications/{siteId}/ExecuteScheduledOrderLockNotifications
post
Bundles
/Sites/{siteId}/Bundles/{bundleId}/Settings
get
/Sites/{siteId}/Bundles/{bundleId}/Calculate
post
ChurnReports
/Sites/{siteId}/Reports/CohortReport/{periodInMonths}/{status}
get
/Sites/{siteId}/Reports/ScheduledOrdersChurn/{periodInMonths}
get
/Sites/{siteId}/Reports/ScheduledOrdersByCycles/{periodInMonths}
get
Coupons
Get Coupons
get
Create Coupon
post
Update Coupon
put
Delete Coupon
del
Get Coupon By Identifier
get
Get Coupon By Code
get
Validate Coupons
post
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}/Subscribe
post
/Notifications/ScheduledOrders/{id}/Unsubscribe
post
/Notifications/ScheduledOrders/{id}/NotifyProcessingStatusChanged
post
PaymentIntegrations
Get Payment Integrations
get
Create Payment Integration
post
Get Payment Integration
get
Update Payment Integration
put
Delete Payment Integration
del
PaymentMethods
Get Payment Methods
get
Create Payment Method
post
Get Payment Method
get
Update Payment Method
put
Delete Payment Method
del
Upsert Payment Method
post
Get Scheduled Orders that use the Payment Method
get
Get a customer's other payment methods from the payment gateway
get
ProcessingCycles
Get Processing Cycle Processing Logs
get
/Sites/{siteId}/ProcessingCycles/{processingCycleId}
put
Get Processing Cycle Processing Logs
get
ProductGroups
Get Product Groups
get
Create Product Group
post
Get Product Group
get
Update Product Group
put
Delete Product Group
del
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}/SecretKeys
get
/SecretKeys
post
ShippingAddresses
Get Shipping Addresses
get
Create Shipping Address
post
Get Shipping Address
get
Update Shipping Address
put
Delete Shipping Address
del
ShippingIntegrations
Get Shipping Integrations
get
Create Shipping Integration
post
Get Shipping Integration
get
Update Shipping Integration
put
Delete Shipping Integration
del
ShippingRates
Get Shipping Rates
get
Create Shipping Rate
post
/Sites/{siteId}/ShippingRates/Nextime
get
Sync Nextime Delivery Dates for a Scheduled Order
post
Get Shipping Rate
get
Update Shipping Rate
put
Delete Shipping Rate
del
ShopifyWebhooks
/ShopifyWebhooks
get
/ShopifyWebhooks
del
/ShopifyWebhooks/Shop
del
Sites
Get Site
get
Get Sites
get
Create Site
post
Get Sites
get
Update Site
put
Delete Site
del
/Sites/{siteId}/Metadata
put
/Sites/{siteId}/MigrateV3
post
Get Site Integration Status
get
Get Site customers revenue metrics
get
/Sites/{siteId}/Pause
put
/Sites/{siteId}/Resume
put
SitesConfigurations
/SitesConfigurations/{siteId}/tier
get
UsersPermissions
/UsersPermissions/Page/{pageUrl}/{siteId}
get
/UsersPermissions/{siteId}
get
/UsersPermissions/PagesAllowed
get
/UsersPermissions
post
VersionChecker
/Sites/VersionChecker/VersionNumber
get
Webhooks
Creates a Webhook
post
Get Webhooks
get
Get Webhook
get
Update Webhook
put
Delete Webhook
del
/Sites/{siteId}/Webhooks/Sample/{webhookEventType}
get
/Sites/{siteId}/Webhooks/PollingSample/{webhookEventType}
get
Powered by
/SecretKeys/{userId}/SecretKeys
Ask AI
get
https://example.com/SecretKeys/
{userId}
/SecretKeys
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
Response
Click
Try It!
to start a request and see the response here!
