Jump to Content
Guides
API Reference
Changelog
Back to QPilot.cloud
API Reference
Back to QPilot.cloud
Guides
API Reference
Changelog
Get Product
Search
JUMP TO
QPilot API
Getting started
Quick Start Guide
What's new in 2.0
ScheduledOrders
Retry Processing
post
Retry Last Processing Cycle
post
/Sites/{siteId}/ScheduledOrders/{id}/Retry/{tokenJWT}
post
/Sites/{siteId}/ScheduledOrders/{scheduledOrderId}/RetryUpdateOrder
post
Get Scheduled Orders
get
Create Scheduled Order
post
Get Scheduled Order By Id
get
Update Scheduled Order
put
Delete Scheduled Order
delete
Upsert Scheduled Order
post
Get Next Scheduled Order
get
Get Scheduled Order Processing Cycles
get
Change Scheduled Order Status
put
Change Scheduled Order Payment Method
patch
Calculate Next Occurrence
get
Update Scheduled Order Next Occurrence
put
Update Scheduled Order Frequency
put
Safe Activate Scheduled Order
put
ScheduledOrderItems
Get Scheduled Order Item
get
Update Scheduled Order Item
put
Delete Scheduled Order Item
delete
Create Scheduled Order Items
post
Customers
Get Customers
get
Create Customer
post
Get Customers Summaries
get
Get Customer Event Logs
get
Get Customer revenue metrics
get
Get Customer
get
Edit Customer
put
Delete Customer
delete
Get Customer Scheduled Orders
get
Get Customer Payment Methods
get
Products
Get Product
get
Update Product
put
Delete Product
delete
Get Products
get
Create Product
post
Upserts a batch of Products by Ids
post
Get Products By Ids
post
Get Scheduled Orders that use the Product
get
/Sites/{siteId}/Products/ProductsAndProductGroup
get
AccessTokens
/AccessTokens/Login
post
/Sites/{siteId}/AccessTokens/CustomerLogin
post
/Sites/{siteId}/AccessTokens/Generate
post
Coupons
Get Coupons
get
Create Coupon
post
Get Coupon By Identifier
get
Update Coupon
put
Delete Coupon
delete
Get Coupon By Code
get
Validate Coupons
post
/Sites/Coupons/GetProductGroup
get
ImportFile
/importFiles/upload
post
/importFiles/get-validation-file/{guid}
get
/importFiles/find-in-queue
get
/importFiles/deleteImportFiles/{id}
delete
/importFiles/rollBackImportFiles/{id}
delete
LogExpiration
/log-expiration/upsert-log-expiration
post
/log-expiration/find-all-log-expiration
get
Notifications
/Notifications/ScheduledOrders/{id}/Subscribe
post
/Notifications/ScheduledOrders/{id}/Unsubscribe
post
/Notifications/ScheduledOrders/{id}/NotifyProcessingStatusChanged
post
/Notifications/ScheduledOrders/{id}/NotifyProcessingLogStep
post
PaymentIntegrations
Get Payment Integrations
get
Create Payment Integration
post
Get Payment Integration
get
Update Payment Integration
put
Delete Payment Integration
delete
PaymentMethods
Get Payment Methods
get
Create Payment Method
post
Get Payment Method
get
Update Payment Method
put
Delete Payment Method
delete
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
Load Braintree Payment Methods
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
delete
ShippingAddresses
Get Shipping Addresses
get
Create Shipping Address
post
Get Shipping Address
get
Update Shipping Address
put
Delete Shipping Address
delete
ShippingIntegrations
Get Shipping Integrations
get
Create Shipping Integration
post
Get Shipping Integration
get
Update Shipping Integration
put
Delete Shipping Integration
delete
ShippingRates
Get Shipping Rates
get
Create Shipping Rate
post
Get Shipping Rate
get
Update Shipping Rate
put
Delete Shipping Rate
delete
/ShippingRates
post
ShopifyWebhooks
/ShopifyWebhooks/Shop
delete
/ShopifyWebhooks
get
/ShopifyWebhooks
delete
Annex A: Updating Entities
Annex B: Working with Metadata
Annex C: Shipping
Annex D: Working with Webhooks
Annex E: Site Integrations
Sites
Get Site
get
Update Site
put
Delete Site
delete
Get Sites
get
Create Site
post
Get Sites
get
/Sites/{siteId}/Metadata
put
/Sites/{siteId}/MigrateV3
post
Get Site Lock Window
get
/Sites/{siteId}/ShowNotes
get
Get Site Settings
get
Get Site Integration Status
get
Get Resume Checks
get
Resume Processing
put
Pause Site Processing
put
Get Site Action Webhooks
get
Get Site Event Webhooks
get
Get Site customers revenue metrics
get
Get Site customers revenue metrics
get
Get Site customers revenue metrics as a csv file
get
Get Site customers revenue metrics as a csv file
get
Get Event Logs
get
/Sites/{siteId}/EventLogs/Count
get
TaxRates
Get Tax Rates
get
Create Tax Rate
post
Get Tax Rate
get
Update Tax Rate
put
Delete Tax Rate
delete
UsersPermissions
/UsersPermissions/Page/{pageUrl}
get
/UsersPermissions/{siteId}
get
/UsersPermissions/PagesAllowed
get
/UsersPermissions
post
VersionChecker
/VersionChecker
get
Webhooks
Get Webhooks
get
Creates a Webhook
post
Get Webhook
get
Update Webhook
put
Delete Webhook
delete
Powered by
Get Product
get
https://api.qpilot.cloud/Sites/
{siteId}
/Products/
{id}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
