The QPilot Developer Hub

Welcome to the QPilot developer hub. You'll find comprehensive guides and documentation to help you start working with QPilot as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Site Settings And Options

QPilot Site Menu

From QPilot Merchant Center > Site Menu, you can select from the following options:

  • Dashboard: Navigate to the QPilot Site's Dashboard to view Scheduled Orders, edit notifications, manage Integrations, and more within the QPilot Site.
  • Edit: Manage the General Settings, Options and Customer Notifications for the QPilot Site
  • Pause / Resume Processing: "Pause Processing" to disable the automatic processing of all Scheduled Orders for the QPilot Site. "Resume Processing" to enable processing (see here for more information).
  • Delete Site: Delete the QPilot Site from your QPilot Merchant Account.
    • Important Note:

Edit Site Settings

When you "Edit" your site, you will see three tabs. See below for more information on each of these tabs.

  • General Settings
  • Options
  • Customer Notifications

General Settings

  • Name

    • The name of the site.
    • Required (but may be set automatically).
    • Default: The connected site's Name.
  • URL

    • The URL of the site.
    • Set automatically.
    • This must match the URL of the site that you connected to QPilot.
    • Important: Always connect secure URL's (https) to avoid API connectivity issues.
  • Site Type

    • Set automatically.
    • Options: WooCommerce or Custom.
    • Important: Do not change this setting unless instructed to do so.
  • Environment

    • Default: Test Environment
    • Test Environment
      • Used to connect test/staging sites.
      • Cannot be changed unless the QPilot Merchant Account is activated with a Trial or Active Subscription Plan.
      • Limitations on Payment Settings (Test Mode Only) for Automated Processing.
    • Live Environment
      • Used for websites in Production.
      • Enables full control of Payment Settings (toggle on/off Test Mode) for Automated Processing.
  • Email

    • The primary email contact(s) for the QPilot Site.
    • Email(s) will receive admin notifications from the QPilot Site about any issues regarding Scheduled Order Processing Errors as well as direct notifications from QPilot Customer Success.
    • Multiple emails can be entered here as comma-separated values.
  • Phone Number

  • API Consumer Key

    • Set automatically.
    • The connected site's REST API Consumer Key.
    • Important: Do not change this setting unless instructed to do so.
  • API Consumer Secret

    • Set automatically.
    • The connected site's REST API Consumer Secret.
    • Important: Do not change this setting unless instructed to do so.
  • Customer Facing Scheduled Orders URL for the Site

    • Defaults to the URL of the site "https://mysite.com/my-account/scheduled-orders".
    • If you would like to change the default value, please input a relative URL (e.g. /my-account/scheduled-orders) that is the specific destination for customers to view their Scheduled Orders.

Options

  • Postal Code

    • The Postal Code (aka "ZIP Code") from which your Products are shipped.
  • Timezone

    • Select a timezone for the QPilot Site.
    • If no Time is selected, the default is GMT time (UTC 0).
  • Default Unit of Weight

    • Default is "Pound".
    • Select a value to control the unit you will define Product Weights in:
      • Pound, Ounce, Kilogram, Gram.
    • Suggestion: This should match the Weight Unit selected on your connected site.
  • Default Unit of Length

    • Default is "Inch".
    • Select a value to control the unit you will define Product Lengths in:
      • Inch, Foot, Yard, Millimeter, Centimeter, Meter.
    • Suggestion: This should match the Length Unit selected on your connected site.
  • Order Processing Start Time

    • Select a time for your QPilot Site to begin processing Scheduled Orders each day.
    • If no start time is defined, Scheduled Orders will process relative to the time they were last updated.
    • Learn more about Scheduled Order Processing Time.
  • Scheduled Order Offset Processing

    • Set a number of days prior to the Next Occurrence Date you want the Scheduled Order to process.
    • Learn more about Offset Processing Scheduled Orders.
    • Note: Your customer will see the Next Occurrence Date without the offset processing adjustment.
  • Lock Duration (Days)

    • Define a number for how many days prior to processing will customers be unable to alter their order. Leave blank to disable Scheduled Order locking.
    • Learn more about Locking Scheduled Orders.
  • Enable Customers to Update Order Notes on Scheduled Orders

    • Enable this setting to include Order Notes (optional) entered by customers during checkout in the created Scheduled Orders.
    • Enable customer to add notes when managing their Scheduled Orders.
    • Merchants can always edit Order Notes within Scheduled Orders. This setting enables the option to be customer-facing as well.
  • Enable Customers to use QPilot coupons on Scheduled Orders

    • Enable this setting to display a Coupons field on Scheduled Orders that your customers can use to add/remove Coupons.
    • Merchants can always edit the Coupons applied to Scheduled Orders. This setting allows customers to add (QPilot) coupon codes (provided by merchants) to their Scheduled Orders.
    • Learn more about QPilot Coupons.

Customer Notifications

Example of how Customer Notifications may be configuredExample of how Customer Notifications may be configured

Example of how Customer Notifications may be configured

Learn more about Customer Notifications here.

  • Email Delivery Address

    • The sender email address you want to appear when sending emails. Leaving this blank will default to: [email protected]
    • You should not use "no-reply" addresses. They hurt reputation over email servers and can result on emails flagged as Spam.
    • Suggestion: Use your customer support email address so customers can easily reach out with questions regarding the notification(s) they received.
  • Scheduled Order Errors

    • Enable each Scheduled Order Error email that you want your QPilot Site to automatically send to your customers.
    • Enabling an Error Email will result in notifying a customer of the error that caused their Scheduled Order to Fail.
    • Send a BCC of Error Emails
      • Enable this option to include an admin BCC email address(es) whenever a Scheduled Order Error email is sent to a customer.
      • Error Emails BCC Address
        • If left blank, the Email for the QPilot Site will be used by default.
        • Multiple emails can be entered here as comma-separated values.
  • Upcoming Scheduled Orders

    • Enable each Upcoming Scheduled Order email that you want your QPilot Site to automatically send to your customers.
    • Enabling an Upcoming Scheduled Order email will result in notifying a customer of their Scheduled Order ahead of their next occurrence date.
  • Lock Duration Warning (Days)

    • How many days prior to the beginning of the Lock Duration that customers will be notified that their scheduled order will begin processing. Leave blank to disable the lock duration warning email.
    • Important: If you define a Lock Duration for your QPilot Site, we strongly suggest enabling the Lock Duration Warning email at least 2-3 days in advance of the Lock Duration.

Updated 21 days ago

Site Settings And Options


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.