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
Suggest Edits

Authorization

 
Suggest Edits

Log in.

Sending API requests

Requests to the API require HTTP Basic Authentication. Once you have received an Access Token, additional requests can be made by including the TokenAuth value in the Authorization header.

GET /api/ScheduledOrders HTTP/1.1
Authorization: Basic <TokenAuth>

Access Tokens

You must first get an Access Token to make calls to the API. An access token must specify Access Scope. There are two types of Access Scopes for an Access Token:

  1. Merchant
  2. Customer

Getting a Merchant Access Token

A Merchant Access Token grants access to all merchant features of the API. This token can be used to access all merchant data.

POST /api/AccessTokens/Login HTTP/1.1
{
  "Email": "<your account email address>",
  "Password": "<your account password>",
  "AccessScope": "Merchant"
}

Getting a Customer Access Token

A Customer Access Token grants limited access to a customer. This type of access token is intended to be given directly to a customer in order to make changes to Scheduled Orders. The CustomerId must be provided when requesting Customer Access Scope.

POST /api/AccessTokens/Login HTTP/1.1
{
  "Email": "<your account email address>",
  "Password": "<your account password>",
  "AccessScope": "Customer",
  "CustomerId": 000
}
 
posthttps://api.qpilot.cloud/api/AccessTokens/Login
curl --request POST \
  --url https://api.qpilot.cloud/api/AccessTokens/Login
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/AccessTokens/Login' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/AccessTokens/Login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/AccessTokens/Login");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/AccessTokens/Login"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Email
string
required
Password
string
required
AccessScope
string
required

AccessScope

CustomerId
int64

Response

Successful Operation

Idinteger

The unique Identifier for the Access Token.

UserIdinteger

The ID of the user who owns the Access Token.

TokenAuthstring

The token string to be used for Authorization.

AccessScopestring

AccessScope

CustomerIdinteger

Optional Customer ID used to restrict the Access Token.

CreatedUtcstring

UTC date string indicating when the Access Token was created.

UpdatedUtcstring

UTC date string indicating when the Access Token was updated.

ExpiresUtcstring

UTC date string indicating when the Access Token expires.

Bad Request

Forbidden - attempted to log in as a Customer which isn't yours

Suggest Edits

Generate Access Token.

Sending API requests

Requests to the API require HTTP Basic Authentication. Once you have received an Access Token, additional requests can be made by including the TokenAuth value in the Authorization header.

GET /api/ScheduledOrders HTTP/1.1
Authorization: Basic <TokenAuth>

Refreshing Tokens

Tokens have a limited duration (described by the ExpiresUTC field of the Access Token. You can request a refreshed token, if you still have an Access Token that isn't expired. By specifying the Access Scope and Customer ID (if the Token being refreshed is being used by a Customer), and calling this action, you will receive a new Access Token, with refreshed expiration date.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/AccessTokens/Generate
curl --request POST \
  --url https://api.qpilot.cloud/api/AccessTokens/Generate
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/AccessTokens/Generate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/AccessTokens/Generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/AccessTokens/Generate");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/AccessTokens/Generate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

AccessScope
string
required

AccessScope

CustomerId
int64

Response

Successful Operation

Idinteger

The unique Identifier for the Access Token.

UserIdinteger

The ID of the user who owns the Access Token.

TokenAuthstring

The token string to be used for Authorization.

AccessScopestring

AccessScope

CustomerIdinteger

Optional Customer ID used to restrict the Access Token.

CreatedUtcstring

UTC date string indicating when the Access Token was created.

UpdatedUtcstring

UTC date string indicating when the Access Token was updated.

ExpiresUtcstring

UTC date string indicating when the Access Token expires.

Bad Request

Forbidden - attemted refresh with bad token

Suggest Edits

ScheduledOrders

 
Suggest Edits

Get all Scheduled Orders

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ScheduledOrders
curl --request GET \
  --url https://api.qpilot.cloud/api/ScheduledOrders
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qpilot.cloud/api/ScheduledOrders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ScheduledOrders");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order.

CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

Customerobject
Customer.Idinteger

The unique Identifier for the Customer.

Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

Customer.Emailstring

The email address of the Customer.

Customer.FirstNamestring

The customer's first name.

Customer.LastNamestring

The customer's last name.

Customer.Createdstring

User-defined created date for the Customer from the external site.

Customer.ShippingFirstNamestring

Shipping First Name.

Customer.ShippingLastNamestring

Shipping Last Name.

Customer.ShippingStreet1string

Shipping Street 1.

Customer.ShippingStreet2string

Shipping Street 2.

Customer.ShippingCitystring

Shipping City.

Customer.ShippingStatestring

Shipping State.

Customer.ShippingPostcodestring

Shipping Postal Code.

Customer.ShippingCountrystring

Shipping Country.

Customer.BillingFirstNamestring

Billing First Name.

Customer.BillingLastNamestring

Billing Last Name.

Customer.BillingStreet1string

Billing Street 1.

Customer.BillingStreet2string

Billing Street 2.

Customer.BillingCitystring

Billing City.

Customer.BillingStatestring

Billing State.

Customer.BillingPostcodestring

Billing Postal Code.

Customer.BillingCountrystring

Billing Country.

Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
Cyclesinteger

The number of times the order has been processed.

CurrencyIsostring

The ISO code of the currency, such as USD.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

ShippingTotalinteger

The total shipping value of the order.

TaxTotalinteger

The total tax value of the order.

Totalinteger

The total value of the order.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shippping Postal Code.

ShippingCountrystring

Shipping Country.

ScheduledOrderItemsarray
CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

Note

When getting ALL Scheduled orders, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Create Scheduled Order

Scheduled Order Items

The items in the Scheduled Order can be submitted with the Scheduled Order. The Scheduled Order Items will be created with the Scheduled Order.

POST /api/ScheduledOrders HTTP/1.1
{
  ScheduledOrderItems: [ 
    {
      ProductId: 100,
      Quantity: 1
      // ...
    },
    {
      ProductId: 200,
      Quantity: 2
      // ...
    }
  ]
  // ...
}

A value of null for ScheduledOrderItems will be ignored.

POST /api/ScheduledOrders HTTP/1.1
{
  ScheduledOrderItems: null
  // ...
}
 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/ScheduledOrders
curl --request POST \
  --url https://api.qpilot.cloud/api/ScheduledOrders
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/ScheduledOrders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/ScheduledOrders");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

The unique Identifier for the Scheduled Order.

CustomerId
int64

The ID of the QPilot customer to which the Scheduled Order belongs.

Customer
object
 
Customer.Id
int64

The unique Identifier for the Customer.

Customer.SiteId
int64

The ID of the Site to which the Customer belongs.

Customer.ExternalId
string

The unique Identifier for the Customer from the external site.

Customer.Email
string

The email address of the Customer.

Customer.FirstName
string

The customer's first name.

Customer.LastName
string

The customer's last name.

Customer.Created
date-time

User-defined created date for the Customer from the external site.

Customer.ShippingFirstName
string

Shipping First Name.

Customer.ShippingLastName
string

Shipping Last Name.

Customer.ShippingStreet1
string

Shipping Street 1.

Customer.ShippingStreet2
string

Shipping Street 2.

Customer.ShippingCity
string

Shipping City.

Customer.ShippingState
string

Shipping State.

Customer.ShippingPostcode
string

Shipping Postal Code.

Customer.ShippingCountry
string

Shipping Country.

Customer.BillingFirstName
string

Billing First Name.

Customer.BillingLastName
string

Billing Last Name.

Customer.BillingStreet1
string

Billing Street 1.

Customer.BillingStreet2
string

Billing Street 2.

Customer.BillingCity
string

Billing City.

Customer.BillingState
string

Billing State.

Customer.BillingPostcode
string

Billing Postal Code.

Customer.BillingCountry
string

Billing Country.

Customer.CreatedUtc
date-time

UTC date string indicating when the Customer was created.

Customer.UpdatedUtc
date-time

UTC date string indicating when the Customer was updated.

LastOccurrenceUtc
date-time

UTC date string indicating the last time the order was processed.

NextOccurrenceUtc
date-time

UTC date string indicating the next time the order will be processed.

Status
string

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

FrequencyType
string

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

Frequency
int64

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
Cycles
int64

The number of times the order has been processed.

CurrencyIso
string

The ISO code of the currency, such as USD.

PaymentMethodType
string

The type of payment method. Can be [Stripe, AuthorizeNet]

PaymentMethodCustomerId
string

The unique Identifier for the customer record in the payment gateway.

PaymentMethodId
string

The unique Identifier for the payment method record in the payment gateway.

PaymentMethodDescription
string

A description of the payment method to be displayed to the customer.

ShippingTotal
int64

The total shipping value of the order.

TaxTotal
int64

The total tax value of the order.

Total
int64

The total value of the order.

ShippingFirstName
string

Shipping First Name.

ShippingLastName
string

Shipping Last Name.

ShippingStreet1
string

Shipping Street 1.

ShippingStreet2
string

Shipping Street 2.

ShippingCity
string

Shipping City.

ShippingState
string

Shipping State.

ShippingPostcode
string

Shippping Postal Code.

ShippingCountry
string

Shipping Country.

ScheduledOrderItems
array of objects
Id
ScheduledOrderId
ProductId
Product 
Price
SalePrice
Quantity
CreatedUtc
UpdatedUtc
CreatedUtc
date-time

UTC date string indicating when the Scheduled Order was created.

UpdatedUtc
date-time

UTC date string indicating when the Scheduled Order was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order.

CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

Customerobject
Customer.Idinteger

The unique Identifier for the Customer.

Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

Customer.Emailstring

The email address of the Customer.

Customer.FirstNamestring

The customer's first name.

Customer.LastNamestring

The customer's last name.

Customer.Createdstring

User-defined created date for the Customer from the external site.

Customer.ShippingFirstNamestring

Shipping First Name.

Customer.ShippingLastNamestring

Shipping Last Name.

Customer.ShippingStreet1string

Shipping Street 1.

Customer.ShippingStreet2string

Shipping Street 2.

Customer.ShippingCitystring

Shipping City.

Customer.ShippingStatestring

Shipping State.

Customer.ShippingPostcodestring

Shipping Postal Code.

Customer.ShippingCountrystring

Shipping Country.

Customer.BillingFirstNamestring

Billing First Name.

Customer.BillingLastNamestring

Billing Last Name.

Customer.BillingStreet1string

Billing Street 1.

Customer.BillingStreet2string

Billing Street 2.

Customer.BillingCitystring

Billing City.

Customer.BillingStatestring

Billing State.

Customer.BillingPostcodestring

Billing Postal Code.

Customer.BillingCountrystring

Billing Country.

Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
Cyclesinteger

The number of times the order has been processed.

CurrencyIsostring

The ISO code of the currency, such as USD.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

ShippingTotalinteger

The total shipping value of the order.

TaxTotalinteger

The total tax value of the order.

Totalinteger

The total value of the order.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shippping Postal Code.

ShippingCountrystring

Shipping Country.

ScheduledOrderItemsarray
CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

Bad Request

Forbidden - trying to create a Scheduled Order for which you do not have authorization

Suggest Edits

Update Scheduled Order

Scheduled Order Items

The items in the Scheduled Order can be submitted with the Scheduled Order. The Scheduled Order Items will be created with the Scheduled Order.

PUT /api/ScheduledOrders/100 HTTP/1.1
{
  ScheduledOrderItems: [ 
    {
      ProductId: 100,
      Quantity: 1
      // ...
    },
    {
      ProductId: 200,
      Quantity: 2
      // ...
    }
  ]
  // ...
}

A value of null for ScheduledOrderItems will be ignored.

PUT /api/ScheduledOrders/100 HTTP/1.1
{
  ScheduledOrderItems: null
  // ...
}
 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId
curl --request PUT \
  --url https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderId
int64
required

Scheduled Order ID

Body Params

Id
int64

The unique Identifier for the Scheduled Order.

CustomerId
int64

The ID of the QPilot customer to which the Scheduled Order belongs.

Customer
object
 
Customer.Id
int64

The unique Identifier for the Customer.

Customer.SiteId
int64

The ID of the Site to which the Customer belongs.

Customer.ExternalId
string

The unique Identifier for the Customer from the external site.

Customer.Email
string

The email address of the Customer.

Customer.FirstName
string

The customer's first name.

Customer.LastName
string

The customer's last name.

Customer.Created
date-time

User-defined created date for the Customer from the external site.

Customer.ShippingFirstName
string

Shipping First Name.

Customer.ShippingLastName
string

Shipping Last Name.

Customer.ShippingStreet1
string

Shipping Street 1.

Customer.ShippingStreet2
string

Shipping Street 2.

Customer.ShippingCity
string

Shipping City.

Customer.ShippingState
string

Shipping State.

Customer.ShippingPostcode
string

Shipping Postal Code.

Customer.ShippingCountry
string

Shipping Country.

Customer.BillingFirstName
string

Billing First Name.

Customer.BillingLastName
string

Billing Last Name.

Customer.BillingStreet1
string

Billing Street 1.

Customer.BillingStreet2
string

Billing Street 2.

Customer.BillingCity
string

Billing City.

Customer.BillingState
string

Billing State.

Customer.BillingPostcode
string

Billing Postal Code.

Customer.BillingCountry
string

Billing Country.

Customer.CreatedUtc
date-time

UTC date string indicating when the Customer was created.

Customer.UpdatedUtc
date-time

UTC date string indicating when the Customer was updated.

LastOccurrenceUtc
date-time

UTC date string indicating the last time the order was processed.

NextOccurrenceUtc
date-time

UTC date string indicating the next time the order will be processed.

Status
string

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

FrequencyType
string

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

Frequency
int64

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
Cycles
int64

The number of times the order has been processed.

CurrencyIso
string

The ISO code of the currency, such as USD.

PaymentMethodType
string

The type of payment method. Can be [Stripe, AuthorizeNet]

PaymentMethodCustomerId
string

The unique Identifier for the customer record in the payment gateway.

PaymentMethodId
string

The unique Identifier for the payment method record in the payment gateway.

PaymentMethodDescription
string

A description of the payment method to be displayed to the customer.

ShippingTotal
int64

The total shipping value of the order.

TaxTotal
int64

The total tax value of the order.

Total
int64

The total value of the order.

ShippingFirstName
string

Shipping First Name.

ShippingLastName
string

Shipping Last Name.

ShippingStreet1
string

Shipping Street 1.

ShippingStreet2
string

Shipping Street 2.

ShippingCity
string

Shipping City.

ShippingState
string

Shipping State.

ShippingPostcode
string

Shippping Postal Code.

ShippingCountry
string

Shipping Country.

ScheduledOrderItems
array of objects
Id
ScheduledOrderId
ProductId
Product 
Price
SalePrice
Quantity
CreatedUtc
UpdatedUtc
CreatedUtc
date-time

UTC date string indicating when the Scheduled Order was created.

UpdatedUtc
date-time

UTC date string indicating when the Scheduled Order was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order.

CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

Customerobject
Customer.Idinteger

The unique Identifier for the Customer.

Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

Customer.Emailstring

The email address of the Customer.

Customer.FirstNamestring

The customer's first name.

Customer.LastNamestring

The customer's last name.

Customer.Createdstring

User-defined created date for the Customer from the external site.

Customer.ShippingFirstNamestring

Shipping First Name.

Customer.ShippingLastNamestring

Shipping Last Name.

Customer.ShippingStreet1string

Shipping Street 1.

Customer.ShippingStreet2string

Shipping Street 2.

Customer.ShippingCitystring

Shipping City.

Customer.ShippingStatestring

Shipping State.

Customer.ShippingPostcodestring

Shipping Postal Code.

Customer.ShippingCountrystring

Shipping Country.

Customer.BillingFirstNamestring

Billing First Name.

Customer.BillingLastNamestring

Billing Last Name.

Customer.BillingStreet1string

Billing Street 1.

Customer.BillingStreet2string

Billing Street 2.

Customer.BillingCitystring

Billing City.

Customer.BillingStatestring

Billing State.

Customer.BillingPostcodestring

Billing Postal Code.

Customer.BillingCountrystring

Billing Country.

Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
Cyclesinteger

The number of times the order has been processed.

CurrencyIsostring

The ISO code of the currency, such as USD.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

ShippingTotalinteger

The total shipping value of the order.

TaxTotalinteger

The total tax value of the order.

Totalinteger

The total value of the order.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shippping Postal Code.

ShippingCountrystring

Shipping Country.

ScheduledOrderItemsarray
CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

Bad Request

Forbidden - trying to edit Scheduled Order for which you do not have authorization

Not Found - no Scheduled Order found for ID provided

Suggest Edits

Get Scheduled Order by ID

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId
curl --request GET \
  --url https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderId
int64
required

Scheduled Order ID

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order.

CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

Customerobject
Customer.Idinteger

The unique Identifier for the Customer.

Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

Customer.Emailstring

The email address of the Customer.

Customer.FirstNamestring

The customer's first name.

Customer.LastNamestring

The customer's last name.

Customer.Createdstring

User-defined created date for the Customer from the external site.

Customer.ShippingFirstNamestring

Shipping First Name.

Customer.ShippingLastNamestring

Shipping Last Name.

Customer.ShippingStreet1string

Shipping Street 1.

Customer.ShippingStreet2string

Shipping Street 2.

Customer.ShippingCitystring

Shipping City.

Customer.ShippingStatestring

Shipping State.

Customer.ShippingPostcodestring

Shipping Postal Code.

Customer.ShippingCountrystring

Shipping Country.

Customer.BillingFirstNamestring

Billing First Name.

Customer.BillingLastNamestring

Billing Last Name.

Customer.BillingStreet1string

Billing Street 1.

Customer.BillingStreet2string

Billing Street 2.

Customer.BillingCitystring

Billing City.

Customer.BillingStatestring

Billing State.

Customer.BillingPostcodestring

Billing Postal Code.

Customer.BillingCountrystring

Billing Country.

Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
Cyclesinteger

The number of times the order has been processed.

CurrencyIsostring

The ISO code of the currency, such as USD.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

ShippingTotalinteger

The total shipping value of the order.

TaxTotalinteger

The total tax value of the order.

Totalinteger

The total value of the order.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shippping Postal Code.

ShippingCountrystring

Shipping Country.

ScheduledOrderItemsarray
CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

Not Found - no Scheduled Order found for ID provided

Suggest Edits

Delete Scheduled Order

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderId
int64
required

Scheduled Order ID

Response

Successful Operation

Not Found - no Scheduled Order found for ID provided

Suggest Edits

Get the last 20 Action Logs for the specified Scheduled Order Id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ActionLogs
curl --request GET \
  --url https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ActionLogs
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ActionLogs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ActionLogs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ActionLogs");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ActionLogs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderId
int64
required

Scheduled Order Id

Response

Successful Operation

Idstring

Unique Identifier for the Action Log within QPilot

SiteIdinteger

Identifier of the Site related to this Action Log

ScheduledOrderIdinteger

Identifier of the Scheduled Order related to this Action Log

ActionTypestring
AccessTokenobject
AccessToken.Idinteger

The unique Identifier for the Access Token.

AccessToken.UserIdinteger

The ID of the user who owns the Access Token.

AccessToken.TokenAuthstring

The token string to be used for Authorization.

AccessToken.AccessScopestring

AccessScope

AccessToken.CustomerIdinteger

Optional Customer ID used to restrict the Access Token.

AccessToken.CreatedUtcstring

UTC date string indicating when the Access Token was created.

AccessToken.UpdatedUtcstring

UTC date string indicating when the Access Token was updated.

AccessToken.ExpiresUtcstring

UTC date string indicating when the Access Token expires.

PreviousScheduledOrderobject
PreviousScheduledOrder.Idinteger

The unique Identifier for the Scheduled Order.

PreviousScheduledOrder.CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

PreviousScheduledOrder.Customerobject
PreviousScheduledOrder.Customer.Idinteger

The unique Identifier for the Customer.

PreviousScheduledOrder.Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

PreviousScheduledOrder.Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

PreviousScheduledOrder.Customer.Emailstring

The email address of the Customer.

PreviousScheduledOrder.Customer.FirstNamestring

The customer's first name.

PreviousScheduledOrder.Customer.LastNamestring

The customer's last name.

PreviousScheduledOrder.Customer.Createdstring

User-defined created date for the Customer from the external site.

PreviousScheduledOrder.Customer.ShippingFirstNamestring

Shipping First Name.

PreviousScheduledOrder.Customer.ShippingLastNamestring

Shipping Last Name.

PreviousScheduledOrder.Customer.ShippingStreet1string

Shipping Street 1.

PreviousScheduledOrder.Customer.ShippingStreet2string

Shipping Street 2.

PreviousScheduledOrder.Customer.ShippingCitystring

Shipping City.

PreviousScheduledOrder.Customer.ShippingStatestring

Shipping State.

PreviousScheduledOrder.Customer.ShippingPostcodestring

Shipping Postal Code.

PreviousScheduledOrder.Customer.ShippingCountrystring

Shipping Country.

PreviousScheduledOrder.Customer.BillingFirstNamestring

Billing First Name.

PreviousScheduledOrder.Customer.BillingLastNamestring

Billing Last Name.

PreviousScheduledOrder.Customer.BillingStreet1string

Billing Street 1.

PreviousScheduledOrder.Customer.BillingStreet2string

Billing Street 2.

PreviousScheduledOrder.Customer.BillingCitystring

Billing City.

PreviousScheduledOrder.Customer.BillingStatestring

Billing State.

PreviousScheduledOrder.Customer.BillingPostcodestring

Billing Postal Code.

PreviousScheduledOrder.Customer.BillingCountrystring

Billing Country.

PreviousScheduledOrder.Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

PreviousScheduledOrder.Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

PreviousScheduledOrder.LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

PreviousScheduledOrder.NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

PreviousScheduledOrder.Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

PreviousScheduledOrder.FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

PreviousScheduledOrder.Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
PreviousScheduledOrder.Cyclesinteger

The number of times the order has been processed.

PreviousScheduledOrder.CurrencyIsostring

The ISO code of the currency, such as USD.

PreviousScheduledOrder.PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

PreviousScheduledOrder.PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

PreviousScheduledOrder.PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

PreviousScheduledOrder.PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

PreviousScheduledOrder.ShippingTotalinteger

The total shipping value of the order.

PreviousScheduledOrder.TaxTotalinteger

The total tax value of the order.

PreviousScheduledOrder.Totalinteger

The total value of the order.

PreviousScheduledOrder.ShippingFirstNamestring

Shipping First Name.

PreviousScheduledOrder.ShippingLastNamestring

Shipping Last Name.

PreviousScheduledOrder.ShippingStreet1string

Shipping Street 1.

PreviousScheduledOrder.ShippingStreet2string

Shipping Street 2.

PreviousScheduledOrder.ShippingCitystring

Shipping City.

PreviousScheduledOrder.ShippingStatestring

Shipping State.

PreviousScheduledOrder.ShippingPostcodestring

Shippping Postal Code.

PreviousScheduledOrder.ShippingCountrystring

Shipping Country.

PreviousScheduledOrder.ScheduledOrderItemsarray
PreviousScheduledOrder.CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

PreviousScheduledOrder.UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

NewScheduledOrderobject
NewScheduledOrder.Idinteger

The unique Identifier for the Scheduled Order.

NewScheduledOrder.CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

NewScheduledOrder.Customerobject
NewScheduledOrder.Customer.Idinteger

The unique Identifier for the Customer.

NewScheduledOrder.Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

NewScheduledOrder.Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

NewScheduledOrder.Customer.Emailstring

The email address of the Customer.

NewScheduledOrder.Customer.FirstNamestring

The customer's first name.

NewScheduledOrder.Customer.LastNamestring

The customer's last name.

NewScheduledOrder.Customer.Createdstring

User-defined created date for the Customer from the external site.

NewScheduledOrder.Customer.ShippingFirstNamestring

Shipping First Name.

NewScheduledOrder.Customer.ShippingLastNamestring

Shipping Last Name.

NewScheduledOrder.Customer.ShippingStreet1string

Shipping Street 1.

NewScheduledOrder.Customer.ShippingStreet2string

Shipping Street 2.

NewScheduledOrder.Customer.ShippingCitystring

Shipping City.

NewScheduledOrder.Customer.ShippingStatestring

Shipping State.

NewScheduledOrder.Customer.ShippingPostcodestring

Shipping Postal Code.

NewScheduledOrder.Customer.ShippingCountrystring

Shipping Country.

NewScheduledOrder.Customer.BillingFirstNamestring

Billing First Name.

NewScheduledOrder.Customer.BillingLastNamestring

Billing Last Name.

NewScheduledOrder.Customer.BillingStreet1string

Billing Street 1.

NewScheduledOrder.Customer.BillingStreet2string

Billing Street 2.

NewScheduledOrder.Customer.BillingCitystring

Billing City.

NewScheduledOrder.Customer.BillingStatestring

Billing State.

NewScheduledOrder.Customer.BillingPostcodestring

Billing Postal Code.

NewScheduledOrder.Customer.BillingCountrystring

Billing Country.

NewScheduledOrder.Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

NewScheduledOrder.Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

NewScheduledOrder.LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

NewScheduledOrder.NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

NewScheduledOrder.Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

NewScheduledOrder.FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

NewScheduledOrder.Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
NewScheduledOrder.Cyclesinteger

The number of times the order has been processed.

NewScheduledOrder.CurrencyIsostring

The ISO code of the currency, such as USD.

NewScheduledOrder.PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

NewScheduledOrder.PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

NewScheduledOrder.PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

NewScheduledOrder.PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

NewScheduledOrder.ShippingTotalinteger

The total shipping value of the order.

NewScheduledOrder.TaxTotalinteger

The total tax value of the order.

NewScheduledOrder.Totalinteger

The total value of the order.

NewScheduledOrder.ShippingFirstNamestring

Shipping First Name.

NewScheduledOrder.ShippingLastNamestring

Shipping Last Name.

NewScheduledOrder.ShippingStreet1string

Shipping Street 1.

NewScheduledOrder.ShippingStreet2string

Shipping Street 2.

NewScheduledOrder.ShippingCitystring

Shipping City.

NewScheduledOrder.ShippingStatestring

Shipping State.

NewScheduledOrder.ShippingPostcodestring

Shippping Postal Code.

NewScheduledOrder.ShippingCountrystring

Shipping Country.

NewScheduledOrder.ScheduledOrderItemsarray
NewScheduledOrder.CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

NewScheduledOrder.UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

Descriptionstring

Description of the Action Log

CreatedUtcstring

UTC date string indicating when the Shipping Rate was created.

UpdatedUtcstring

UTC date string indicating when the Shipping Rate was updated.

Forbidden - trying to get Action Logs for which you do not have authorization

Not Found - no Scheduled Order found for ID provided

Note

When getting Action Logs, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Get the last 20 Event Logs for the specified Scheduled Order Id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/EventLogs
curl --request GET \
  --url https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/EventLogs
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/EventLogs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/EventLogs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/EventLogs");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/EventLogs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderId
int64
required

Scheduled Order Id

Response

Successful Operation

Idstring

Unique Identifier for the Event Log within QPilot

SiteIdinteger

Identifier of the Site related to this Action Log

ScheduledOrderIdinteger

Identifier of the Scheduled Order related to this Action Log

EventTypestring
ScheduledOrderobject
ScheduledOrder.Idinteger

The unique Identifier for the Scheduled Order.

ScheduledOrder.CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

ScheduledOrder.Customerobject
ScheduledOrder.Customer.Idinteger

The unique Identifier for the Customer.

ScheduledOrder.Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

ScheduledOrder.Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

ScheduledOrder.Customer.Emailstring

The email address of the Customer.

ScheduledOrder.Customer.FirstNamestring

The customer's first name.

ScheduledOrder.Customer.LastNamestring

The customer's last name.

ScheduledOrder.Customer.Createdstring

User-defined created date for the Customer from the external site.

ScheduledOrder.Customer.ShippingFirstNamestring

Shipping First Name.

ScheduledOrder.Customer.ShippingLastNamestring

Shipping Last Name.

ScheduledOrder.Customer.ShippingStreet1string

Shipping Street 1.

ScheduledOrder.Customer.ShippingStreet2string

Shipping Street 2.

ScheduledOrder.Customer.ShippingCitystring

Shipping City.

ScheduledOrder.Customer.ShippingStatestring

Shipping State.

ScheduledOrder.Customer.ShippingPostcodestring

Shipping Postal Code.

ScheduledOrder.Customer.ShippingCountrystring

Shipping Country.

ScheduledOrder.Customer.BillingFirstNamestring

Billing First Name.

ScheduledOrder.Customer.BillingLastNamestring

Billing Last Name.

ScheduledOrder.Customer.BillingStreet1string

Billing Street 1.

ScheduledOrder.Customer.BillingStreet2string

Billing Street 2.

ScheduledOrder.Customer.BillingCitystring

Billing City.

ScheduledOrder.Customer.BillingStatestring

Billing State.

ScheduledOrder.Customer.BillingPostcodestring

Billing Postal Code.

ScheduledOrder.Customer.BillingCountrystring

Billing Country.

ScheduledOrder.Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

ScheduledOrder.Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

ScheduledOrder.LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

ScheduledOrder.NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

ScheduledOrder.Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

ScheduledOrder.FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

ScheduledOrder.Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
ScheduledOrder.Cyclesinteger

The number of times the order has been processed.

ScheduledOrder.CurrencyIsostring

The ISO code of the currency, such as USD.

ScheduledOrder.PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

ScheduledOrder.PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

ScheduledOrder.PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

ScheduledOrder.PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

ScheduledOrder.ShippingTotalinteger

The total shipping value of the order.

ScheduledOrder.TaxTotalinteger

The total tax value of the order.

ScheduledOrder.Totalinteger

The total value of the order.

ScheduledOrder.ShippingFirstNamestring

Shipping First Name.

ScheduledOrder.ShippingLastNamestring

Shipping Last Name.

ScheduledOrder.ShippingStreet1string

Shipping Street 1.

ScheduledOrder.ShippingStreet2string

Shipping Street 2.

ScheduledOrder.ShippingCitystring

Shipping City.

ScheduledOrder.ShippingStatestring

Shipping State.

ScheduledOrder.ShippingPostcodestring

Shippping Postal Code.

ScheduledOrder.ShippingCountrystring

Shipping Country.

ScheduledOrder.ScheduledOrderItemsarray
ScheduledOrder.CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

ScheduledOrder.UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

Descriptionstring

Description of the Action Log

CreatedUtcstring

UTC date string indicating when the Shipping Rate was created.

UpdatedUtcstring

UTC date string indicating when the Shipping Rate was updated.

Forbidden - trying to get Event Logs for which you do not have authorization

Not Found - no Scheduled Order found for ID provided

Note

When getting Event Logs, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Get the last 20 Error Logs for the specified Scheduled Order Id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ErrorLog
curl --request GET \
  --url https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ErrorLog
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ErrorLog' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ErrorLog")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ErrorLog");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrders/scheduledOrderId/ErrorLog"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderId
int64
required

Scheduled Order Id

Response

Successful Operation

Idstring

Unique Identifier for the Action Log within QPilot

SiteIdinteger

Identifier of the Site related to this Action Log

ScheduledOrderIdinteger

Identifier of the Scheduled Order related to this Action Log

ExceptionInfoobject

Exception information giving more in-depth information about error

ExceptionInfo.Messagestring

Error message

ExceptionInfo.InnerExceptionInfoobject

Exception information giving more in-depth information about error

ExceptionInfo.InnerExceptionInfo.Messagestring

Error message

ExceptionInfo.InnerExceptionInfo.InnerExceptionInfoobject

Exception information giving more in-depth information about error

ExceptionInfo.InnerExceptionInfo.InnerExceptionInfo.Messagestring

Error message

ExceptionInfo.InnerExceptionInfo.InnerExceptionInfo.InnerExceptionInfoobject

Exception information giving more in-depth information about error

Siteobject
Site.Idinteger

The unique Identifier for the Site.

Site.UserIdinteger

The ID of the User who owns the Site.

Site.Urlstring

The home URL to the site.

Site.Typestring

SiteType

Site.Namestring

A friendly name for the Site.

Site.Emailstring

The main contact email address for the Site.

Site.ApiKey1string

WooCommerce

API Consumer Key

Site.ApiKey2string

WooCommerce

API Consumer Secret

Site.ApiKey3string

WooCommerce

(Not used)

Site.CreatedUtcstring

UTC date string indicating when the Site was created.

Site.UpdatedUtcstring

UTC date string indicating when the Site was updated.

Entityobject

Entity causing the error

Descriptionstring

Description of the Action Log

CreatedUtcstring

UTC date string indicating when the Shipping Rate was created.

UpdatedUtcstring

UTC date string indicating when the Shipping Rate was updated.

Forbidden - trying to get Error Logs for which you do not have authorization

Not Found - no Scheduled Order found for ID provided

Note

When getting Error Logs, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

ScheduledOrderItems

 
Suggest Edits

Get Scheduled Order Items

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ScheduledOrderItems
curl --request GET \
  --url https://api.qpilot.cloud/api/ScheduledOrderItems
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qpilot.cloud/api/ScheduledOrderItems' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrderItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ScheduledOrderItems");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrderItems"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order Item.

ScheduledOrderIdinteger

The ID of the Scheduled Order to which the Scheduled Order Item belongs.

ProductIdinteger

The ID of the Product associated with the item.

Productobject
Product.Idinteger

The unqiue Identifier for the product.

Product.SiteIdinteger

The ID of the Site to which the Product belongs.

Product.ExternalIdstring

The ID of the Product from the external site.

Product.Availabilitystring
Product.StockLevelstring
Product.Typestring

The type of Product from the external site.

Product.Skustring

The SKU of the Product.

Product.Titlestring

The title of the Product.

Product.Descriptionstring

The description of the Product.

Product.Pricenumber

The regular price of the Product.

Product.SalePricenumber

The sale price of the Product (can be null).

Product.Lengthstring

The length of the Product.

Product.Widthstring

The width of the Product.

Product.Heightstring

The height of the Product.

Product.Weightstring

The weight of the Product.

Product.ShippingClassstring

The shipping class of the Product.

Product.TaxClassstring

The tax class of the Product.

Product.ImageUrlstring

The URL of the primary product image.

Product.ImageThumbUrlstring

The URL of the thumbnail product image.

Product.CreatedUtcstring

UTC date string indicating when the Product was created.

Product.UpdatedUtcstring

UTC date string indicating when the Product was updated.

Pricenumber

The regular price of the item.

SalePricenumber

The sale price of the item (can be null).

Quantityinteger

The quantity for this item.

CreatedUtcstring

UTC date string indicating when the Scheduled Order Item was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order Item was updated.

Note

When getting Scheduled Order Items, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Create Scheduled Order Item

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/ScheduledOrderItems
curl --request POST \
  --url https://api.qpilot.cloud/api/ScheduledOrderItems
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/ScheduledOrderItems' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrderItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/ScheduledOrderItems");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrderItems"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

The unique Identifier for the Scheduled Order Item.

ScheduledOrderId
int64

The ID of the Scheduled Order to which the Scheduled Order Item belongs.

ProductId
int64

The ID of the Product associated with the item.

Product
object
 
Product.Id
int64

The unqiue Identifier for the product.

Product.SiteId
int64

The ID of the Site to which the Product belongs.

Product.ExternalId
string

The ID of the Product from the external site.

Product.Availability
string
Product.StockLevel
string
Product.Type
string

The type of Product from the external site.

Product.Sku
string

The SKU of the Product.

Product.Title
string

The title of the Product.

Product.Description
string

The description of the Product.

Product.Price
float

The regular price of the Product.

Product.SalePrice
float

The sale price of the Product (can be null).

Product.Length
string

The length of the Product.

Product.Width
string

The width of the Product.

Product.Height
string

The height of the Product.

Product.Weight
string

The weight of the Product.

Product.ShippingClass
string

The shipping class of the Product.

Product.TaxClass
string

The tax class of the Product.

Product.ImageUrl
string

The URL of the primary product image.

Product.ImageThumbUrl
string

The URL of the thumbnail product image.

Product.CreatedUtc
date-time

UTC date string indicating when the Product was created.

Product.UpdatedUtc
date-time

UTC date string indicating when the Product was updated.

Price
float

The regular price of the item.

SalePrice
float

The sale price of the item (can be null).

Quantity
int64

The quantity for this item.

CreatedUtc
date-time

UTC date string indicating when the Scheduled Order Item was created.

UpdatedUtc
date-time

UTC date string indicating when the Scheduled Order Item was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order Item.

ScheduledOrderIdinteger

The ID of the Scheduled Order to which the Scheduled Order Item belongs.

ProductIdinteger

The ID of the Product associated with the item.

Productobject
Product.Idinteger

The unqiue Identifier for the product.

Product.SiteIdinteger

The ID of the Site to which the Product belongs.

Product.ExternalIdstring

The ID of the Product from the external site.

Product.Availabilitystring
Product.StockLevelstring
Product.Typestring

The type of Product from the external site.

Product.Skustring

The SKU of the Product.

Product.Titlestring

The title of the Product.

Product.Descriptionstring

The description of the Product.

Product.Pricenumber

The regular price of the Product.

Product.SalePricenumber

The sale price of the Product (can be null).

Product.Lengthstring

The length of the Product.

Product.Widthstring

The width of the Product.

Product.Heightstring

The height of the Product.

Product.Weightstring

The weight of the Product.

Product.ShippingClassstring

The shipping class of the Product.

Product.TaxClassstring

The tax class of the Product.

Product.ImageUrlstring

The URL of the primary product image.

Product.ImageThumbUrlstring

The URL of the thumbnail product image.

Product.CreatedUtcstring

UTC date string indicating when the Product was created.

Product.UpdatedUtcstring

UTC date string indicating when the Product was updated.

Pricenumber

The regular price of the item.

SalePricenumber

The sale price of the item (can be null).

Quantityinteger

The quantity for this item.

CreatedUtcstring

UTC date string indicating when the Scheduled Order Item was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order Item was updated.

Bad Request

Forbidden - trying to create a Scheduled Order Item for which you do not have authorization

Suggest Edits

Update Scheduled Order Item

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId
curl --request PUT \
  --url https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderItemId
int64
required

Scheduled Order Item ID

Body Params

Id
int64

The unique Identifier for the Scheduled Order Item.

ScheduledOrderId
int64

The ID of the Scheduled Order to which the Scheduled Order Item belongs.

ProductId
int64

The ID of the Product associated with the item.

Product
object
 
Product.Id
int64

The unqiue Identifier for the product.

Product.SiteId
int64

The ID of the Site to which the Product belongs.

Product.ExternalId
string

The ID of the Product from the external site.

Product.Availability
string
Product.StockLevel
string
Product.Type
string

The type of Product from the external site.

Product.Sku
string

The SKU of the Product.

Product.Title
string

The title of the Product.

Product.Description
string

The description of the Product.

Product.Price
float

The regular price of the Product.

Product.SalePrice
float

The sale price of the Product (can be null).

Product.Length
string

The length of the Product.

Product.Width
string

The width of the Product.

Product.Height
string

The height of the Product.

Product.Weight
string

The weight of the Product.

Product.ShippingClass
string

The shipping class of the Product.

Product.TaxClass
string

The tax class of the Product.

Product.ImageUrl
string

The URL of the primary product image.

Product.ImageThumbUrl
string

The URL of the thumbnail product image.

Product.CreatedUtc
date-time

UTC date string indicating when the Product was created.

Product.UpdatedUtc
date-time

UTC date string indicating when the Product was updated.

Price
float

The regular price of the item.

SalePrice
float

The sale price of the item (can be null).

Quantity
int64

The quantity for this item.

CreatedUtc
date-time

UTC date string indicating when the Scheduled Order Item was created.

UpdatedUtc
date-time

UTC date string indicating when the Scheduled Order Item was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order Item.

ScheduledOrderIdinteger

The ID of the Scheduled Order to which the Scheduled Order Item belongs.

ProductIdinteger

The ID of the Product associated with the item.

Productobject
Product.Idinteger

The unqiue Identifier for the product.

Product.SiteIdinteger

The ID of the Site to which the Product belongs.

Product.ExternalIdstring

The ID of the Product from the external site.

Product.Availabilitystring
Product.StockLevelstring
Product.Typestring

The type of Product from the external site.

Product.Skustring

The SKU of the Product.

Product.Titlestring

The title of the Product.

Product.Descriptionstring

The description of the Product.

Product.Pricenumber

The regular price of the Product.

Product.SalePricenumber

The sale price of the Product (can be null).

Product.Lengthstring

The length of the Product.

Product.Widthstring

The width of the Product.

Product.Heightstring

The height of the Product.

Product.Weightstring

The weight of the Product.

Product.ShippingClassstring

The shipping class of the Product.

Product.TaxClassstring

The tax class of the Product.

Product.ImageUrlstring

The URL of the primary product image.

Product.ImageThumbUrlstring

The URL of the thumbnail product image.

Product.CreatedUtcstring

UTC date string indicating when the Product was created.

Product.UpdatedUtcstring

UTC date string indicating when the Product was updated.

Pricenumber

The regular price of the item.

SalePricenumber

The sale price of the item (can be null).

Quantityinteger

The quantity for this item.

CreatedUtcstring

UTC date string indicating when the Scheduled Order Item was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order Item was updated.

Bad Request

Forbidden - trying to edit Scheduled Order Item for which you do not have authorization

Not Found - no Scheduled Order Item found for ID provided

Suggest Edits

Get Scheduled Order Item

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId
curl --request GET \
  --url https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderItemId
int64
required

Scheduled Order Item ID

Response

Successful Operation

Not Found - no Scheduled Order Item found for ID provided

Idinteger

The unique Identifier for the Scheduled Order Item.

ScheduledOrderIdinteger

The ID of the Scheduled Order to which the Scheduled Order Item belongs.

ProductIdinteger

The ID of the Product associated with the item.

Productobject
Product.Idinteger

The unqiue Identifier for the product.

Product.SiteIdinteger

The ID of the Site to which the Product belongs.

Product.ExternalIdstring

The ID of the Product from the external site.

Product.Availabilitystring
Product.StockLevelstring
Product.Typestring

The type of Product from the external site.

Product.Skustring

The SKU of the Product.

Product.Titlestring

The title of the Product.

Product.Descriptionstring

The description of the Product.

Product.Pricenumber

The regular price of the Product.

Product.SalePricenumber

The sale price of the Product (can be null).

Product.Lengthstring

The length of the Product.

Product.Widthstring

The width of the Product.

Product.Heightstring

The height of the Product.

Product.Weightstring

The weight of the Product.

Product.ShippingClassstring

The shipping class of the Product.

Product.TaxClassstring

The tax class of the Product.

Product.ImageUrlstring

The URL of the primary product image.

Product.ImageThumbUrlstring

The URL of the thumbnail product image.

Product.CreatedUtcstring

UTC date string indicating when the Product was created.

Product.UpdatedUtcstring

UTC date string indicating when the Product was updated.

Pricenumber

The regular price of the item.

SalePricenumber

The sale price of the item (can be null).

Quantityinteger

The quantity for this item.

CreatedUtcstring

UTC date string indicating when the Scheduled Order Item was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order Item was updated.

Suggest Edits

Delete Scheduled Order Item

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ScheduledOrderItems/scheduledOrderItemId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

scheduledOrderItemId
int64
required

Scheduled Order Item ID

Response

Successful Operation

Forbidden -trying to delete a Scheduled Order Item for which you do not have authorization

Not Found - no Scheduled Order found for ID provided

Suggest Edits

Customers

 
Suggest Edits

Create customer

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/Customers
curl --request POST \
  --url https://api.qpilot.cloud/api/Customers
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/Customers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/Customers");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

The unique Identifier for the Customer.

SiteId
int64

The ID of the Site to which the Customer belongs.

ExternalId
string

The unique Identifier for the Customer from the external site.

Email
string

The email address of the Customer.

FirstName
string

The customer's first name.

LastName
string

The customer's last name.

Created
date-time

User-defined created date for the Customer from the external site.

ShippingFirstName
string

Shipping First Name.

ShippingLastName
string

Shipping Last Name.

ShippingStreet1
string

Shipping Street 1.

ShippingStreet2
string

Shipping Street 2.

ShippingCity
string

Shipping City.

ShippingState
string

Shipping State.

ShippingPostcode
string

Shipping Postal Code.

ShippingCountry
string

Shipping Country.

BillingFirstName
string

Billing First Name.

BillingLastName
string

Billing Last Name.

BillingStreet1
string

Billing Street 1.

BillingStreet2
string

Billing Street 2.

BillingCity
string

Billing City.

BillingState
string

Billing State.

BillingPostcode
string

Billing Postal Code.

BillingCountry
string

Billing Country.

CreatedUtc
date-time

UTC date string indicating when the Customer was created.

UpdatedUtc
date-time

UTC date string indicating when the Customer was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Customer.

SiteIdinteger

The ID of the Site to which the Customer belongs.

ExternalIdstring

The unique Identifier for the Customer from the external site.

Emailstring

The email address of the Customer.

FirstNamestring

The customer's first name.

LastNamestring

The customer's last name.

Createdstring

User-defined created date for the Customer from the external site.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shipping Postal Code.

ShippingCountrystring

Shipping Country.

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC date string indicating when the Customer was created.

UpdatedUtcstring

UTC date string indicating when the Customer was updated.

Bad Request

Forbidden - trying to create a Customer for which you do not have authorization

Suggest Edits

Get customers

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Customers
curl --request GET \
  --url https://api.qpilot.cloud/api/Customers
var request = require("request");

var options = { method: 'GET', url: 'https://api.qpilot.cloud/api/Customers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Customers");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

page
int32

Which list page to display

Response

Successful Operation

Idinteger

The unique Identifier for the Customer.

SiteIdinteger

The ID of the Site to which the Customer belongs.

ExternalIdstring

The unique Identifier for the Customer from the external site.

Emailstring

The email address of the Customer.

FirstNamestring

The customer's first name.

LastNamestring

The customer's last name.

Createdstring

User-defined created date for the Customer from the external site.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shipping Postal Code.

ShippingCountrystring

Shipping Country.

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC date string indicating when the Customer was created.

UpdatedUtcstring

UTC date string indicating when the Customer was updated.

Note

When getting ALL customers, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Update customer

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/Customers/customerId
curl --request PUT \
  --url https://api.qpilot.cloud/api/Customers/customerId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/Customers/customerId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Body Params

Id
int64

The unique Identifier for the Customer.

SiteId
int64

The ID of the Site to which the Customer belongs.

ExternalId
string

The unique Identifier for the Customer from the external site.

Email
string

The email address of the Customer.

FirstName
string

The customer's first name.

LastName
string

The customer's last name.

Created
date-time

User-defined created date for the Customer from the external site.

ShippingFirstName
string

Shipping First Name.

ShippingLastName
string

Shipping Last Name.

ShippingStreet1
string

Shipping Street 1.

ShippingStreet2
string

Shipping Street 2.

ShippingCity
string

Shipping City.

ShippingState
string

Shipping State.

ShippingPostcode
string

Shipping Postal Code.

ShippingCountry
string

Shipping Country.

BillingFirstName
string

Billing First Name.

BillingLastName
string

Billing Last Name.

BillingStreet1
string

Billing Street 1.

BillingStreet2
string

Billing Street 2.

BillingCity
string

Billing City.

BillingState
string

Billing State.

BillingPostcode
string

Billing Postal Code.

BillingCountry
string

Billing Country.

CreatedUtc
date-time

UTC date string indicating when the Customer was created.

UpdatedUtc
date-time

UTC date string indicating when the Customer was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Customer.

SiteIdinteger

The ID of the Site to which the Customer belongs.

ExternalIdstring

The unique Identifier for the Customer from the external site.

Emailstring

The email address of the Customer.

FirstNamestring

The customer's first name.

LastNamestring

The customer's last name.

Createdstring

User-defined created date for the Customer from the external site.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shipping Postal Code.

ShippingCountrystring

Shipping Country.

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC date string indicating when the Customer was created.

UpdatedUtcstring

UTC date string indicating when the Customer was updated.

Bad Request

Forbidden - trying to edit Customer for which you do not have authorization

Not Found - no Customer found for ID provided

Suggest Edits

Get customer

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Customers/customerId
curl --request GET \
  --url https://api.qpilot.cloud/api/Customers/customerId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Customers/customerId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Response

Successful Operation

Idinteger

The unique Identifier for the Customer.

SiteIdinteger

The ID of the Site to which the Customer belongs.

ExternalIdstring

The unique Identifier for the Customer from the external site.

Emailstring

The email address of the Customer.

FirstNamestring

The customer's first name.

LastNamestring

The customer's last name.

Createdstring

User-defined created date for the Customer from the external site.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shipping Postal Code.

ShippingCountrystring

Shipping Country.

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC date string indicating when the Customer was created.

UpdatedUtcstring

UTC date string indicating when the Customer was updated.

Not Found - no Customer found for ID provided

Suggest Edits

Delete customer

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/Customers/customerId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/Customers/customerId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/Customers/customerId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Response

Successful Operation

Forbidden - trying to delete a Customer for which you do not have authorization

Not Found - no Customer found for ID provided

Suggest Edits

Get a Customer's Scheduled Orders

 
gethttps://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders
curl --request GET \
  --url https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Query Params

page
int32

Which list page to display

Response

Successful Operation

Idinteger

The unique Identifier for the Scheduled Order.

CustomerIdinteger

The ID of the QPilot customer to which the Scheduled Order belongs.

Customerobject
Customer.Idinteger

The unique Identifier for the Customer.

Customer.SiteIdinteger

The ID of the Site to which the Customer belongs.

Customer.ExternalIdstring

The unique Identifier for the Customer from the external site.

Customer.Emailstring

The email address of the Customer.

Customer.FirstNamestring

The customer's first name.

Customer.LastNamestring

The customer's last name.

Customer.Createdstring

User-defined created date for the Customer from the external site.

Customer.ShippingFirstNamestring

Shipping First Name.

Customer.ShippingLastNamestring

Shipping Last Name.

Customer.ShippingStreet1string

Shipping Street 1.

Customer.ShippingStreet2string

Shipping Street 2.

Customer.ShippingCitystring

Shipping City.

Customer.ShippingStatestring

Shipping State.

Customer.ShippingPostcodestring

Shipping Postal Code.

Customer.ShippingCountrystring

Shipping Country.

Customer.BillingFirstNamestring

Billing First Name.

Customer.BillingLastNamestring

Billing Last Name.

Customer.BillingStreet1string

Billing Street 1.

Customer.BillingStreet2string

Billing Street 2.

Customer.BillingCitystring

Billing City.

Customer.BillingStatestring

Billing State.

Customer.BillingPostcodestring

Billing Postal Code.

Customer.BillingCountrystring

Billing Country.

Customer.CreatedUtcstring

UTC date string indicating when the Customer was created.

Customer.UpdatedUtcstring

UTC date string indicating when the Customer was updated.

LastOccurrenceUtcstring

UTC date string indicating the last time the order was processed.

NextOccurrenceUtcstring

UTC date string indicating the next time the order will be processed.

Statusstring

Indicates the status of the Scheduled Order. Can be [Active, Pending, Paused].

FrequencyTypestring

The type of frequency. Can be [Days, Weeks, Months, DayOfTheWeek, DayOfTheMonth].

Frequencyinteger

The interval at which the order will be processed depending on the FrequencyType.

  • Days - The number of days.
  • DayOfTheWeek - Sun(1), Mon(2), Tue(3), Wed(4), Thu(5), Fri(6), Sat(7).
  • Weeks - The number of weeks.
  • Months - The number of months.
  • DayOfTheMonth - The calendar date of the month from 1 to 31.
Cyclesinteger

The number of times the order has been processed.

CurrencyIsostring

The ISO code of the currency, such as USD.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

PaymentMethodCustomerIdstring

The unique Identifier for the customer record in the payment gateway.

PaymentMethodIdstring

The unique Identifier for the payment method record in the payment gateway.

PaymentMethodDescriptionstring

A description of the payment method to be displayed to the customer.

ShippingTotalinteger

The total shipping value of the order.

TaxTotalinteger

The total tax value of the order.

Totalinteger

The total value of the order.

ShippingFirstNamestring

Shipping First Name.

ShippingLastNamestring

Shipping Last Name.

ShippingStreet1string

Shipping Street 1.

ShippingStreet2string

Shipping Street 2.

ShippingCitystring

Shipping City.

ShippingStatestring

Shipping State.

ShippingPostcodestring

Shippping Postal Code.

ShippingCountrystring

Shipping Country.

ScheduledOrderItemsarray
CreatedUtcstring

UTC date string indicating when the Scheduled Order was created.

UpdatedUtcstring

UTC date string indicating when the Scheduled Order was updated.

Bad Request

Note

When getting ALL Customer's Scheduled Orders, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Get the number of Customer's Scheduled Orders

 
gethttps://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders/PageCount
curl --request GET \
  --url https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders/PageCount
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders/PageCount' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders/PageCount")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders/PageCount");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId/ScheduledOrders/PageCount"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Response

Successful Operation

Suggest Edits

Get a Customer's Payment Methods

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Customers/customerId/PaymentMethods
curl --request GET \
  --url https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Query Params

page
int32

Which list page to display

Response

Successful Operation

Idinteger

Unique Identifier for the PaymentMethod within QPilot

CustomerIdinteger

ID of QPilot customer to which the PaymentMethod belongs

Typestring

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerIdstring

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentIdstring

Unique Identifier the PaymentMethod within the payment gateway

Descriptionstring

User friendly desciption for the PaymentMethod

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was last updated

Bad request

Note

When getting Customer's Payment Methods, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Get the number of Customer's Payment Methods

 
gethttps://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/PageCount
curl --request GET \
  --url https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/PageCount
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/PageCount' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/PageCount")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/PageCount");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/PageCount"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Response

Successful Operation

Suggest Edits

Search for a Customer's PaymentMethods

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/Search
curl --request GET \
  --url https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/Search
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/Search' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/Search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/Search");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Customers/customerId/PaymentMethods/Search"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customerId
int64
required

Customer ID

Query Params

type
string

PaymentMethodType

gatewayPaymentId
string

The ID of the payment record in the payment gateway

gatewayCustomerId
string

The ID of the user record in the payment gateway

Response

Successful Operation

Idinteger

Unique Identifier for the PaymentMethod within QPilot

CustomerIdinteger

ID of QPilot customer to which the PaymentMethod belongs

Typestring

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerIdstring

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentIdstring

Unique Identifier the PaymentMethod within the payment gateway

Descriptionstring

User friendly desciption for the PaymentMethod

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was last updated

Suggest Edits

Create Order

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/Orders
curl --request POST \
  --url https://api.qpilot.cloud/api/Orders
var request = require("request");

var options = { method: 'POST', url: 'https://api.qpilot.cloud/api/Orders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/Orders");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Orders"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

Unique Identifier for the Order within QPilot

ExternalId
string

Unique Identifier for the order within your eCommerce platform

OrderNumber
string

Order number within your eCommerce platform

CustomerId
int64

ID of QPilot customer for whom the order was made

DateCreated
date-time

UTC date string indicating the date the order was created

DateCompleted
date-time

UTC date string indicating the date the order was completed

DatePaid
date-time

UTC date string indicating the date the order was paid for

Subtotal
float

Subtotal for the order

Total
float

Total for order after all other fees

ShippingTotal
float

Total charged for shipping

TaxTotal
float

Total charged for taxes

IsRecurring
boolean

Whether or not the order is a recurring order

ShippingFirstName
string

First name on the shipping address

ShippingLastName
string

Last name on the shipping address

ShippingStreet1
string

Street address on the shipping address

ShippingStreet2
string

Apt. or Unit no. on shipping address

ShippingCity
string

City on the shipping address

ShippingState
string

State on the shipping address

ShippingPostcode
string

Postal code on the shipping address

ShippingCountry
string

Country on the shipping address

BillingFirstName
string

First name on the Billing address

BillingLastName
string

Last name on the Billing address

BillingStreet1
string

Street address on the Billing address

BillingStreet2
string

Apt. or Unit no. on Billing address

BillingCity
string

City on the Billing address

BillingState
string

State on the Billing address

BillingPostcode
string

Postal code on the Billing address

BillingCountry
string

Country on the Billing address

OrderItems
array of objects

List of items on the order

Id
OrderId
ProductId
Product 
Name
Subtotal
Total
TaxTotal
Quantity
IsRecurring
CreatedUtc
date-time

Date the order was created within QPilot

UpdatedUtc
date-time

Date the order was last updated within QPilot

Response

Successful Operation

Idinteger

Unique Identifier for the Order within QPilot

ExternalIdstring

Unique Identifier for the order within your eCommerce platform

OrderNumberstring

Order number within your eCommerce platform

CustomerIdinteger

ID of QPilot customer for whom the order was made

DateCreatedstring

UTC date string indicating the date the order was created

DateCompletedstring

UTC date string indicating the date the order was completed

DatePaidstring

UTC date string indicating the date the order was paid for

Subtotalnumber

Subtotal for the order

Totalnumber

Total for order after all other fees

ShippingTotalnumber

Total charged for shipping

TaxTotalnumber

Total charged for taxes

IsRecurringboolean

Whether or not the order is a recurring order

ShippingFirstNamestring

First name on the shipping address

ShippingLastNamestring

Last name on the shipping address

ShippingStreet1string

Street address on the shipping address

ShippingStreet2string

Apt. or Unit no. on shipping address

ShippingCitystring

City on the shipping address

ShippingStatestring

State on the shipping address

ShippingPostcodestring

Postal code on the shipping address

ShippingCountrystring

Country on the shipping address

BillingFirstNamestring

First name on the Billing address

BillingLastNamestring

Last name on the Billing address

BillingStreet1string

Street address on the Billing address

BillingStreet2string

Apt. or Unit no. on Billing address

BillingCitystring

City on the Billing address

BillingStatestring

State on the Billing address

BillingPostcodestring

Postal code on the Billing address

BillingCountrystring

Country on the Billing address

OrderItemsarray

List of items on the order

CreatedUtcstring

Date the order was created within QPilot

UpdatedUtcstring

Date the order was last updated within QPilot

Bad Request

Forbidden - trying to create Order for which you do not have authorization

Suggest Edits

Get Orders

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Orders
curl --request GET \
  --url https://api.qpilot.cloud/api/Orders
var request = require("request");

var options = { method: 'GET', url: 'https://api.qpilot.cloud/api/Orders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Orders");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Orders"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

Unique Identifier for the Order within QPilot

ExternalIdstring

Unique Identifier for the order within your eCommerce platform

OrderNumberstring

Order number within your eCommerce platform

CustomerIdinteger

ID of QPilot customer for whom the order was made

DateCreatedstring

UTC date string indicating the date the order was created

DateCompletedstring

UTC date string indicating the date the order was completed

DatePaidstring

UTC date string indicating the date the order was paid for

Subtotalnumber

Subtotal for the order

Totalnumber

Total for order after all other fees

ShippingTotalnumber

Total charged for shipping

TaxTotalnumber

Total charged for taxes

IsRecurringboolean

Whether or not the order is a recurring order

ShippingFirstNamestring

First name on the shipping address

ShippingLastNamestring

Last name on the shipping address

ShippingStreet1string

Street address on the shipping address

ShippingStreet2string

Apt. or Unit no. on shipping address

ShippingCitystring

City on the shipping address

ShippingStatestring

State on the shipping address

ShippingPostcodestring

Postal code on the shipping address

ShippingCountrystring

Country on the shipping address

BillingFirstNamestring

First name on the Billing address

BillingLastNamestring

Last name on the Billing address

BillingStreet1string

Street address on the Billing address

BillingStreet2string

Apt. or Unit no. on Billing address

BillingCitystring

City on the Billing address

BillingStatestring

State on the Billing address

BillingPostcodestring

Postal code on the Billing address

BillingCountrystring

Country on the Billing address

OrderItemsarray

List of items on the order

CreatedUtcstring

Date the order was created within QPilot

UpdatedUtcstring

Date the order was last updated within QPilot

Note

When getting Orders, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Update order

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/Orders/orderId
curl --request PUT \
  --url https://api.qpilot.cloud/api/Orders/orderId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/Orders/orderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Orders/orderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/Orders/orderId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Orders/orderId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required

Order ID

Body Params

Id
int64

Unique Identifier for the Order within QPilot

ExternalId
string

Unique Identifier for the order within your eCommerce platform

OrderNumber
string

Order number within your eCommerce platform

CustomerId
int64

ID of QPilot customer for whom the order was made

DateCreated
date-time

UTC date string indicating the date the order was created

DateCompleted
date-time

UTC date string indicating the date the order was completed

DatePaid
date-time

UTC date string indicating the date the order was paid for

Subtotal
float

Subtotal for the order

Total
float

Total for order after all other fees

ShippingTotal
float

Total charged for shipping

TaxTotal
float

Total charged for taxes

IsRecurring
boolean

Whether or not the order is a recurring order

ShippingFirstName
string

First name on the shipping address

ShippingLastName
string

Last name on the shipping address

ShippingStreet1
string

Street address on the shipping address

ShippingStreet2
string

Apt. or Unit no. on shipping address

ShippingCity
string

City on the shipping address

ShippingState
string

State on the shipping address

ShippingPostcode
string

Postal code on the shipping address

ShippingCountry
string

Country on the shipping address

BillingFirstName
string

First name on the Billing address

BillingLastName
string

Last name on the Billing address

BillingStreet1
string

Street address on the Billing address

BillingStreet2
string

Apt. or Unit no. on Billing address

BillingCity
string

City on the Billing address

BillingState
string

State on the Billing address

BillingPostcode
string

Postal code on the Billing address

BillingCountry
string

Country on the Billing address

OrderItems
array of objects

List of items on the order

Id
OrderId
ProductId
Product 
Name
Subtotal
Total
TaxTotal
Quantity
IsRecurring
CreatedUtc
date-time

Date the order was created within QPilot

UpdatedUtc
date-time

Date the order was last updated within QPilot

Response

Successful Operation

Idinteger

Unique Identifier for the Order within QPilot

ExternalIdstring

Unique Identifier for the order within your eCommerce platform

OrderNumberstring

Order number within your eCommerce platform

CustomerIdinteger

ID of QPilot customer for whom the order was made

DateCreatedstring

UTC date string indicating the date the order was created

DateCompletedstring

UTC date string indicating the date the order was completed

DatePaidstring

UTC date string indicating the date the order was paid for

Subtotalnumber

Subtotal for the order

Totalnumber

Total for order after all other fees

ShippingTotalnumber

Total charged for shipping

TaxTotalnumber

Total charged for taxes

IsRecurringboolean

Whether or not the order is a recurring order

ShippingFirstNamestring

First name on the shipping address

ShippingLastNamestring

Last name on the shipping address

ShippingStreet1string

Street address on the shipping address

ShippingStreet2string

Apt. or Unit no. on shipping address

ShippingCitystring

City on the shipping address

ShippingStatestring

State on the shipping address

ShippingPostcodestring

Postal code on the shipping address

ShippingCountrystring

Country on the shipping address

BillingFirstNamestring

First name on the Billing address

BillingLastNamestring

Last name on the Billing address

BillingStreet1string

Street address on the Billing address

BillingStreet2string

Apt. or Unit no. on Billing address

BillingCitystring

City on the Billing address

BillingStatestring

State on the Billing address

BillingPostcodestring

Postal code on the Billing address

BillingCountrystring

Country on the Billing address

OrderItemsarray

List of items on the order

CreatedUtcstring

Date the order was created within QPilot

UpdatedUtcstring

Date the order was last updated within QPilot

Bad Request

Forbidden - trying to edit Order for which you do not have authorization

Not Found - no Order found for ID provided

Suggest Edits

Get order

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Orders/orderId
curl --request GET \
  --url https://api.qpilot.cloud/api/Orders/orderId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Orders/orderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Orders/orderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Orders/orderId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Orders/orderId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
string
required

Order ID

Response

Successful Operation

Idinteger

Unique Identifier for the Order within QPilot

ExternalIdstring

Unique Identifier for the order within your eCommerce platform

OrderNumberstring

Order number within your eCommerce platform

CustomerIdinteger

ID of QPilot customer for whom the order was made

DateCreatedstring

UTC date string indicating the date the order was created

DateCompletedstring

UTC date string indicating the date the order was completed

DatePaidstring

UTC date string indicating the date the order was paid for

Subtotalnumber

Subtotal for the order

Totalnumber

Total for order after all other fees

ShippingTotalnumber

Total charged for shipping

TaxTotalnumber

Total charged for taxes

IsRecurringboolean

Whether or not the order is a recurring order

ShippingFirstNamestring

First name on the shipping address

ShippingLastNamestring

Last name on the shipping address

ShippingStreet1string

Street address on the shipping address

ShippingStreet2string

Apt. or Unit no. on shipping address

ShippingCitystring

City on the shipping address

ShippingStatestring

State on the shipping address

ShippingPostcodestring

Postal code on the shipping address

ShippingCountrystring

Country on the shipping address

BillingFirstNamestring

First name on the Billing address

BillingLastNamestring

Last name on the Billing address

BillingStreet1string

Street address on the Billing address

BillingStreet2string

Apt. or Unit no. on Billing address

BillingCitystring

City on the Billing address

BillingStatestring

State on the Billing address

BillingPostcodestring

Postal code on the Billing address

BillingCountrystring

Country on the Billing address

OrderItemsarray

List of items on the order

CreatedUtcstring

Date the order was created within QPilot

UpdatedUtcstring

Date the order was last updated within QPilot

Not Found - no Order found for ID provided

Suggest Edits

Delete order

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/Orders/orderId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/Orders/orderId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/Orders/orderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Orders/orderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/Orders/orderId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Orders/orderId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

orderId
int64
required

Order ID

Response

Successful Operation

Forbidden - trying to delete Order for which you do not have authorization

Not Found - no Order found for ID provided

 
Suggest Edits

Create product

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/Products
curl --request POST \
  --url https://api.qpilot.cloud/api/Products
var request = require("request");

var options = { method: 'POST', url: 'https://api.qpilot.cloud/api/Products' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/Products");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Products"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

The unqiue Identifier for the product.

SiteId
int64

The ID of the Site to which the Product belongs.

ExternalId
string

The ID of the Product from the external site.

Availability
string
StockLevel
string
Type
string

The type of Product from the external site.

Sku
string

The SKU of the Product.

Title
string

The title of the Product.

Description
string

The description of the Product.

Price
float

The regular price of the Product.

SalePrice
float

The sale price of the Product (can be null).

Length
string

The length of the Product.

Width
string

The width of the Product.

Height
string

The height of the Product.

Weight
string

The weight of the Product.

ShippingClass
string

The shipping class of the Product.

TaxClass
string

The tax class of the Product.

ImageUrl
string

The URL of the primary product image.

ImageThumbUrl
string

The URL of the thumbnail product image.

CreatedUtc
date-time

UTC date string indicating when the Product was created.

UpdatedUtc
date-time

UTC date string indicating when the Product was updated.

Response

Successful Operation

Idinteger

The unqiue Identifier for the product.

SiteIdinteger

The ID of the Site to which the Product belongs.

ExternalIdstring

The ID of the Product from the external site.

Availabilitystring
StockLevelstring
Typestring

The type of Product from the external site.

Skustring

The SKU of the Product.

Titlestring

The title of the Product.

Descriptionstring

The description of the Product.

Pricenumber

The regular price of the Product.

SalePricenumber

The sale price of the Product (can be null).

Lengthstring

The length of the Product.

Widthstring

The width of the Product.

Heightstring

The height of the Product.

Weightstring

The weight of the Product.

ShippingClassstring

The shipping class of the Product.

TaxClassstring

The tax class of the Product.

ImageUrlstring

The URL of the primary product image.

ImageThumbUrlstring

The URL of the thumbnail product image.

CreatedUtcstring

UTC date string indicating when the Product was created.

UpdatedUtcstring

UTC date string indicating when the Product was updated.

Bad Request

Forbidden - trying to create Product for which you do not have authorization

Suggest Edits

Get products

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Products
curl --request GET \
  --url https://api.qpilot.cloud/api/Products
var request = require("request");

var options = { method: 'GET', url: 'https://api.qpilot.cloud/api/Products' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Products");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Products"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

The unqiue Identifier for the product.

SiteIdinteger

The ID of the Site to which the Product belongs.

ExternalIdstring

The ID of the Product from the external site.

Availabilitystring
StockLevelstring
Typestring

The type of Product from the external site.

Skustring

The SKU of the Product.

Titlestring

The title of the Product.

Descriptionstring

The description of the Product.

Pricenumber

The regular price of the Product.

SalePricenumber

The sale price of the Product (can be null).

Lengthstring

The length of the Product.

Widthstring

The width of the Product.

Heightstring

The height of the Product.

Weightstring

The weight of the Product.

ShippingClassstring

The shipping class of the Product.

TaxClassstring

The tax class of the Product.

ImageUrlstring

The URL of the primary product image.

ImageThumbUrlstring

The URL of the thumbnail product image.

CreatedUtcstring

UTC date string indicating when the Product was created.

UpdatedUtcstring

UTC date string indicating when the Product was updated.

Note

When getting Products, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Update product

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/Products/productId
curl --request PUT \
  --url https://api.qpilot.cloud/api/Products/productId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/Products/productId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Products/productId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/Products/productId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Products/productId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

productId
int64
required

Product ID

Body Params

Id
int64

The unqiue Identifier for the product.

SiteId
int64

The ID of the Site to which the Product belongs.

ExternalId
string

The ID of the Product from the external site.

Availability
string
StockLevel
string
Type
string

The type of Product from the external site.

Sku
string

The SKU of the Product.

Title
string

The title of the Product.

Description
string

The description of the Product.

Price
float

The regular price of the Product.

SalePrice
float

The sale price of the Product (can be null).

Length
string

The length of the Product.

Width
string

The width of the Product.

Height
string

The height of the Product.

Weight
string

The weight of the Product.

ShippingClass
string

The shipping class of the Product.

TaxClass
string

The tax class of the Product.

ImageUrl
string

The URL of the primary product image.

ImageThumbUrl
string

The URL of the thumbnail product image.

CreatedUtc
date-time

UTC date string indicating when the Product was created.

UpdatedUtc
date-time

UTC date string indicating when the Product was updated.

Response

Successful Operation

Idinteger

The unqiue Identifier for the product.

SiteIdinteger

The ID of the Site to which the Product belongs.

ExternalIdstring

The ID of the Product from the external site.

Availabilitystring
StockLevelstring
Typestring

The type of Product from the external site.

Skustring

The SKU of the Product.

Titlestring

The title of the Product.

Descriptionstring

The description of the Product.

Pricenumber

The regular price of the Product.

SalePricenumber

The sale price of the Product (can be null).

Lengthstring

The length of the Product.

Widthstring

The width of the Product.

Heightstring

The height of the Product.

Weightstring

The weight of the Product.

ShippingClassstring

The shipping class of the Product.

TaxClassstring

The tax class of the Product.

ImageUrlstring

The URL of the primary product image.

ImageThumbUrlstring

The URL of the thumbnail product image.

CreatedUtcstring

UTC date string indicating when the Product was created.

UpdatedUtcstring

UTC date string indicating when the Product was updated.

Bad Request

Forbidden - trying to edit Product for which you do not have authorization

Not Found - no Product found for ID provided

Suggest Edits

Get product

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Products/productId
curl --request GET \
  --url https://api.qpilot.cloud/api/Products/productId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Products/productId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Products/productId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Products/productId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Products/productId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

productId
int64
required

Product ID

Response

Successful Operation

Idinteger

The unqiue Identifier for the product.

SiteIdinteger

The ID of the Site to which the Product belongs.

ExternalIdstring

The ID of the Product from the external site.

Availabilitystring
StockLevelstring
Typestring

The type of Product from the external site.

Skustring

The SKU of the Product.

Titlestring

The title of the Product.

Descriptionstring

The description of the Product.

Pricenumber

The regular price of the Product.

SalePricenumber

The sale price of the Product (can be null).

Lengthstring

The length of the Product.

Widthstring

The width of the Product.

Heightstring

The height of the Product.

Weightstring

The weight of the Product.

ShippingClassstring

The shipping class of the Product.

TaxClassstring

The tax class of the Product.

ImageUrlstring

The URL of the primary product image.

ImageThumbUrlstring

The URL of the thumbnail product image.

CreatedUtcstring

UTC date string indicating when the Product was created.

UpdatedUtcstring

UTC date string indicating when the Product was updated.

Not Found - no Product found for ID provided

Suggest Edits

Delete product

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/Products/productId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/Products/productId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/Products/productId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Products/productId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/Products/productId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Products/productId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

productId
int64
required

Product ID

Response

Successful Operation

Forbidden - trying to delete Product for which you do not have authorization

Not Found - no Product found for ID provided

Suggest Edits

ShippingRates

 
Suggest Edits

Create shipping rate

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/ShippingRates
curl --request POST \
  --url https://api.qpilot.cloud/api/ShippingRates
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/ShippingRates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ShippingRates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/ShippingRates");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ShippingRates"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

Unique Identifier for the ShippingRate within QPilot

SiteId
int64

ID of the QPilot site to which the ShippingRate belongs

ShippingClass
string

Shipping class to which the ShippingRate can be applied

Country
string

Country in which the ShippingRate is available

State
string

Country in which the ShippingRate is available (requires Country to be specified)

City
string

Country in which the ShippingRate is available (requires Country, State to be specified)

Postcode
string

Country in which the ShippingRate is available (requires Country, State, City to be specified)

PricePerUnit
float

The amount charged for shipping per unit on the order

BasePrice
float

The amount charged for shipping regardless of any other factors

MinUnits
int64

Minimum number of items on an order nessecary for the order to be eligible for the ShippingRate

MinCycles
int64

Number of times the ScheduledOrder must process before it becomes eligible for the ShippingRate

MinSubtotal
float

Minimum subtotal the ScheduledOrder must have to be eligible for the ShippingRate

Name
string

Display name for the ShippingRate

CreatedUtc
date-time

UTC date string indicating when the Shipping Rate was created.

UpdatedUtc
date-time

UTC date string indicating when the Shipping Rate was updated.

Response

Successful Operation

Idinteger

Unique Identifier for the ShippingRate within QPilot

SiteIdinteger

ID of the QPilot site to which the ShippingRate belongs

ShippingClassstring

Shipping class to which the ShippingRate can be applied

Countrystring

Country in which the ShippingRate is available

Statestring

Country in which the ShippingRate is available (requires Country to be specified)

Citystring

Country in which the ShippingRate is available (requires Country, State to be specified)

Postcodestring

Country in which the ShippingRate is available (requires Country, State, City to be specified)

PricePerUnitnumber

The amount charged for shipping per unit on the order

BasePricenumber

The amount charged for shipping regardless of any other factors

MinUnitsinteger

Minimum number of items on an order nessecary for the order to be eligible for the ShippingRate

MinCyclesinteger

Number of times the ScheduledOrder must process before it becomes eligible for the ShippingRate

MinSubtotalnumber

Minimum subtotal the ScheduledOrder must have to be eligible for the ShippingRate

Namestring

Display name for the ShippingRate

CreatedUtcstring

UTC date string indicating when the Shipping Rate was created.

UpdatedUtcstring

UTC date string indicating when the Shipping Rate was updated.

Bad Request

Forbidden - trying to create Shipping Rate for which you do not have authorization

Suggest Edits

Get shipping rates

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ShippingRates
curl --request GET \
  --url https://api.qpilot.cloud/api/ShippingRates
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qpilot.cloud/api/ShippingRates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ShippingRates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ShippingRates");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ShippingRates"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

Unique Identifier for the ShippingRate within QPilot

SiteIdinteger

ID of the QPilot site to which the ShippingRate belongs

ShippingClassstring

Shipping class to which the ShippingRate can be applied

Countrystring

Country in which the ShippingRate is available

Statestring

Country in which the ShippingRate is available (requires Country to be specified)

Citystring

Country in which the ShippingRate is available (requires Country, State to be specified)

Postcodestring

Country in which the ShippingRate is available (requires Country, State, City to be specified)

PricePerUnitnumber

The amount charged for shipping per unit on the order

BasePricenumber

The amount charged for shipping regardless of any other factors

MinUnitsinteger

Minimum number of items on an order nessecary for the order to be eligible for the ShippingRate

MinCyclesinteger

Number of times the ScheduledOrder must process before it becomes eligible for the ShippingRate

MinSubtotalnumber

Minimum subtotal the ScheduledOrder must have to be eligible for the ShippingRate

Namestring

Display name for the ShippingRate

CreatedUtcstring

UTC date string indicating when the Shipping Rate was created.

UpdatedUtcstring

UTC date string indicating when the Shipping Rate was updated.

Note

When getting Shipping Rates, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Update shipping rate

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/ShippingRate/shippingRateId
curl --request PUT \
  --url https://api.qpilot.cloud/api/ShippingRate/shippingRateId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/ShippingRate/shippingRateId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ShippingRate/shippingRateId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/ShippingRate/shippingRateId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ShippingRate/shippingRateId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

shippingRateId
int64
required

Shipping Rate ID

Body Params

Id
int64

Unique Identifier for the ShippingRate within QPilot

SiteId
int64

ID of the QPilot site to which the ShippingRate belongs

ShippingClass
string

Shipping class to which the ShippingRate can be applied

Country
string

Country in which the ShippingRate is available

State
string

Country in which the ShippingRate is available (requires Country to be specified)

City
string

Country in which the ShippingRate is available (requires Country, State to be specified)

Postcode
string

Country in which the ShippingRate is available (requires Country, State, City to be specified)

PricePerUnit
float

The amount charged for shipping per unit on the order

BasePrice
float

The amount charged for shipping regardless of any other factors

MinUnits
int64

Minimum number of items on an order nessecary for the order to be eligible for the ShippingRate

MinCycles
int64

Number of times the ScheduledOrder must process before it becomes eligible for the ShippingRate

MinSubtotal
float

Minimum subtotal the ScheduledOrder must have to be eligible for the ShippingRate

Name
string

Display name for the ShippingRate

CreatedUtc
date-time

UTC date string indicating when the Shipping Rate was created.

UpdatedUtc
date-time

UTC date string indicating when the Shipping Rate was updated.

Response

Successful Operation

Idinteger

Unique Identifier for the ShippingRate within QPilot

SiteIdinteger

ID of the QPilot site to which the ShippingRate belongs

ShippingClassstring

Shipping class to which the ShippingRate can be applied

Countrystring

Country in which the ShippingRate is available

Statestring

Country in which the ShippingRate is available (requires Country to be specified)

Citystring

Country in which the ShippingRate is available (requires Country, State to be specified)

Postcodestring

Country in which the ShippingRate is available (requires Country, State, City to be specified)

PricePerUnitnumber

The amount charged for shipping per unit on the order

BasePricenumber

The amount charged for shipping regardless of any other factors

MinUnitsinteger

Minimum number of items on an order nessecary for the order to be eligible for the ShippingRate

MinCyclesinteger

Number of times the ScheduledOrder must process before it becomes eligible for the ShippingRate

MinSubtotalnumber

Minimum subtotal the ScheduledOrder must have to be eligible for the ShippingRate

Namestring

Display name for the ShippingRate

CreatedUtcstring

UTC date string indicating when the Shipping Rate was created.

UpdatedUtcstring

UTC date string indicating when the Shipping Rate was updated.

Bad Request

Forbidden - trying to edit Shipping Rate for which you do not have authorization

Not Found - no Shipping Rate found for ID provided

Suggest Edits

Get shipping rate

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/ShippingRate/shippingRateId
curl --request GET \
  --url https://api.qpilot.cloud/api/ShippingRate/shippingRateId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/ShippingRate/shippingRateId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ShippingRate/shippingRateId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/ShippingRate/shippingRateId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ShippingRate/shippingRateId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

shippingRateId
int64
required

Shipping Rate ID

Response

Successful Operation

Idinteger

Unique Identifier for the ShippingRate within QPilot

SiteIdinteger

ID of the QPilot site to which the ShippingRate belongs

ShippingClassstring

Shipping class to which the ShippingRate can be applied

Countrystring

Country in which the ShippingRate is available

Statestring

Country in which the ShippingRate is available (requires Country to be specified)

Citystring

Country in which the ShippingRate is available (requires Country, State to be specified)

Postcodestring

Country in which the ShippingRate is available (requires Country, State, City to be specified)

PricePerUnitnumber

The amount charged for shipping per unit on the order

BasePricenumber

The amount charged for shipping regardless of any other factors

MinUnitsinteger

Minimum number of items on an order nessecary for the order to be eligible for the ShippingRate

MinCyclesinteger

Number of times the ScheduledOrder must process before it becomes eligible for the ShippingRate

MinSubtotalnumber

Minimum subtotal the ScheduledOrder must have to be eligible for the ShippingRate

Namestring

Display name for the ShippingRate

CreatedUtcstring

UTC date string indicating when the Shipping Rate was created.

UpdatedUtcstring

UTC date string indicating when the Shipping Rate was updated.

Not Found - no Scheduled Order found for ID provided

Suggest Edits

Delete shipping rate

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/ShippingRate/shippingRateId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/ShippingRate/shippingRateId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/ShippingRate/shippingRateId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/ShippingRate/shippingRateId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/ShippingRate/shippingRateId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/ShippingRate/shippingRateId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

shippingRateId
int64
required

Shipping Rate ID

Response

Successful Operation

Forbidden - trying to delete Shipping Rate for which you do not have authorization

Not Found - no Shipping rate found for ID provided

 
Suggest Edits

Create tax rate

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/TaxRates
curl --request POST \
  --url https://api.qpilot.cloud/api/TaxRates
var request = require("request");

var options = { method: 'POST', url: 'https://api.qpilot.cloud/api/TaxRates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/TaxRates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/TaxRates");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/TaxRates"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

Unique Identifier for the TaxRate within QPilot

SiteId
int64

ID of the site to which the TaxRate belongs

TaxClass
string

Tax class to which the rate is applied

Country
string

Country in which the tax rate is effective

State
string

State in which the tax rate is effective (requires Country to be specified)

City
string

City in which the tax rate is effective (requires Country, State to be specified)

Postcode
string

Postcode in which the tax rate is effective (requires Country, State, City to be specified)

Rate
float

Percent of purchase to be charged for tax

IsCompound
boolean

Whether or not the tax is calculated based on the total after primary tax

Name
string

Display name for the TaxRate

CreatedUtc
date-time

UTC date string indicating when the Tax Rate was created.

UpdatedUtc
date-time

UTC date string indicating when the Tax Rate was updated.

Response

Successful Operation

Idinteger

Unique Identifier for the TaxRate within QPilot

SiteIdinteger

ID of the site to which the TaxRate belongs

TaxClassstring

Tax class to which the rate is applied

Countrystring

Country in which the tax rate is effective

Statestring

State in which the tax rate is effective (requires Country to be specified)

Citystring

City in which the tax rate is effective (requires Country, State to be specified)

Postcodestring

Postcode in which the tax rate is effective (requires Country, State, City to be specified)

Ratenumber

Percent of purchase to be charged for tax

IsCompoundboolean

Whether or not the tax is calculated based on the total after primary tax

Namestring

Display name for the TaxRate

CreatedUtcstring

UTC date string indicating when the Tax Rate was created.

UpdatedUtcstring

UTC date string indicating when the Tax Rate was updated.

Bad Request

Forbidden - trying to create Tax Rate for which you do not have authorization

Suggest Edits

Get tax rates

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/TaxRates
curl --request GET \
  --url https://api.qpilot.cloud/api/TaxRates
var request = require("request");

var options = { method: 'GET', url: 'https://api.qpilot.cloud/api/TaxRates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/TaxRates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/TaxRates");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/TaxRates"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

Unique Identifier for the TaxRate within QPilot

SiteIdinteger

ID of the site to which the TaxRate belongs

TaxClassstring

Tax class to which the rate is applied

Countrystring

Country in which the tax rate is effective

Statestring

State in which the tax rate is effective (requires Country to be specified)

Citystring

City in which the tax rate is effective (requires Country, State to be specified)

Postcodestring

Postcode in which the tax rate is effective (requires Country, State, City to be specified)

Ratenumber

Percent of purchase to be charged for tax

IsCompoundboolean

Whether or not the tax is calculated based on the total after primary tax

Namestring

Display name for the TaxRate

CreatedUtcstring

UTC date string indicating when the Tax Rate was created.

UpdatedUtcstring

UTC date string indicating when the Tax Rate was updated.

Note

When getting Tax Rates, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Update tax rate

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/TaxRate/taxRateId
curl --request PUT \
  --url https://api.qpilot.cloud/api/TaxRate/taxRateId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/TaxRate/taxRateId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/TaxRate/taxRateId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/TaxRate/taxRateId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/TaxRate/taxRateId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

taxRateId
int64
required

Tax Rate ID

Body Params

Id
int64

Unique Identifier for the TaxRate within QPilot

SiteId
int64

ID of the site to which the TaxRate belongs

TaxClass
string

Tax class to which the rate is applied

Country
string

Country in which the tax rate is effective

State
string

State in which the tax rate is effective (requires Country to be specified)

City
string

City in which the tax rate is effective (requires Country, State to be specified)

Postcode
string

Postcode in which the tax rate is effective (requires Country, State, City to be specified)

Rate
float

Percent of purchase to be charged for tax

IsCompound
boolean

Whether or not the tax is calculated based on the total after primary tax

Name
string

Display name for the TaxRate

CreatedUtc
date-time

UTC date string indicating when the Tax Rate was created.

UpdatedUtc
date-time

UTC date string indicating when the Tax Rate was updated.

Response

Successful Operation

Idinteger

Unique Identifier for the TaxRate within QPilot

SiteIdinteger

ID of the site to which the TaxRate belongs

TaxClassstring

Tax class to which the rate is applied

Countrystring

Country in which the tax rate is effective

Statestring

State in which the tax rate is effective (requires Country to be specified)

Citystring

City in which the tax rate is effective (requires Country, State to be specified)

Postcodestring

Postcode in which the tax rate is effective (requires Country, State, City to be specified)

Ratenumber

Percent of purchase to be charged for tax

IsCompoundboolean

Whether or not the tax is calculated based on the total after primary tax

Namestring

Display name for the TaxRate

CreatedUtcstring

UTC date string indicating when the Tax Rate was created.

UpdatedUtcstring

UTC date string indicating when the Tax Rate was updated.

Bad Request

Forbidden - trying to edit Tax Rate for which you do not have authorization

Not Found - no Tax Rate found for ID provided

Suggest Edits

Get tax rate

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/TaxRate/taxRateId
curl --request GET \
  --url https://api.qpilot.cloud/api/TaxRate/taxRateId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/TaxRate/taxRateId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/TaxRate/taxRateId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/TaxRate/taxRateId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/TaxRate/taxRateId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

taxRateId
int64
required

Tax Rate ID

Response

Successful Operation

Idinteger

Unique Identifier for the TaxRate within QPilot

SiteIdinteger

ID of the site to which the TaxRate belongs

TaxClassstring

Tax class to which the rate is applied

Countrystring

Country in which the tax rate is effective

Statestring

State in which the tax rate is effective (requires Country to be specified)

Citystring

City in which the tax rate is effective (requires Country, State to be specified)

Postcodestring

Postcode in which the tax rate is effective (requires Country, State, City to be specified)

Ratenumber

Percent of purchase to be charged for tax

IsCompoundboolean

Whether or not the tax is calculated based on the total after primary tax

Namestring

Display name for the TaxRate

CreatedUtcstring

UTC date string indicating when the Tax Rate was created.

UpdatedUtcstring

UTC date string indicating when the Tax Rate was updated.

Not Found - no Tax Rate found for ID provided

Suggest Edits

Delete tax rate

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/TaxRate/taxRateId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/TaxRate/taxRateId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/TaxRate/taxRateId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/TaxRate/taxRateId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/TaxRate/taxRateId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/TaxRate/taxRateId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

taxRateId
int64
required

Tax Rate ID

Response

Successful Operation

Forbidden - trying to delete Tax Rate for which you do not have authorization

Not Found - no Tax Rate found for ID provided

Suggest Edits

PaymentIntegrations

 
Suggest Edits

Create Payment Integration

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/PaymentIntegrations
curl --request POST \
  --url https://api.qpilot.cloud/api/PaymentIntegrations
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/PaymentIntegrations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentIntegrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/PaymentIntegrations");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentIntegrations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

The unique Identifier for the Payment Integration.

SiteId
int64

The ID of the Site to which the Payment Integration belongs.

PaymentMethodType
string

The type of payment method. Can be [Stripe, AuthorizeNet]

ApiAccount
string

Stripe

(Not used)

Authorize.net

API Login ID

ApiKey1
string

Stripe

API Secret Key

Authorize.net

API Transaction Key

ApiKey2
string

Stripe

API Publishable Key

Authorize.net

(Not used)

TestMode
boolean

Whether this Payment Integration is running in test mode.

CreatedUtc
date-time

UTC date string indicating when the Payment Integration was created.

UpdatedUtc
date-time

UTC date string indicating when the Payment Integration was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Payment Integration.

SiteIdinteger

The ID of the Site to which the Payment Integration belongs.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

ApiAccountstring

Stripe

(Not used)

Authorize.net

API Login ID

ApiKey1string

Stripe

API Secret Key

Authorize.net

API Transaction Key

ApiKey2string

Stripe

API Publishable Key

Authorize.net

(Not used)

TestModeboolean

Whether this Payment Integration is running in test mode.

CreatedUtcstring

UTC date string indicating when the Payment Integration was created.

UpdatedUtcstring

UTC date string indicating when the Payment Integration was updated.

Bad Request

Forbidden - trying to create Payment Integration for which you do not have authorization

Suggest Edits

Get Payment Integrations

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/PaymentIntegrations
curl --request GET \
  --url https://api.qpilot.cloud/api/PaymentIntegrations
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qpilot.cloud/api/PaymentIntegrations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentIntegrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/PaymentIntegrations");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentIntegrations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

The unique Identifier for the Payment Integration.

SiteIdinteger

The ID of the Site to which the Payment Integration belongs.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

ApiAccountstring

Stripe

(Not used)

Authorize.net

API Login ID

ApiKey1string

Stripe

API Secret Key

Authorize.net

API Transaction Key

ApiKey2string

Stripe

API Publishable Key

Authorize.net

(Not used)

TestModeboolean

Whether this Payment Integration is running in test mode.

CreatedUtcstring

UTC date string indicating when the Payment Integration was created.

UpdatedUtcstring

UTC date string indicating when the Payment Integration was updated.

Note

When getting Payment Integrations, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Update Payment Integration

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId
curl --request PUT \
  --url https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

paymentIntegrationId
int64
required

Payment Integration ID

Body Params

Id
int64

The unique Identifier for the Payment Integration.

SiteId
int64

The ID of the Site to which the Payment Integration belongs.

PaymentMethodType
string

The type of payment method. Can be [Stripe, AuthorizeNet]

ApiAccount
string

Stripe

(Not used)

Authorize.net

API Login ID

ApiKey1
string

Stripe

API Secret Key

Authorize.net

API Transaction Key

ApiKey2
string

Stripe

API Publishable Key

Authorize.net

(Not used)

TestMode
boolean

Whether this Payment Integration is running in test mode.

CreatedUtc
date-time

UTC date string indicating when the Payment Integration was created.

UpdatedUtc
date-time

UTC date string indicating when the Payment Integration was updated.

Response

Successful Operation

Idinteger

The unique Identifier for the Payment Integration.

SiteIdinteger

The ID of the Site to which the Payment Integration belongs.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

ApiAccountstring

Stripe

(Not used)

Authorize.net

API Login ID

ApiKey1string

Stripe

API Secret Key

Authorize.net

API Transaction Key

ApiKey2string

Stripe

API Publishable Key

Authorize.net

(Not used)

TestModeboolean

Whether this Payment Integration is running in test mode.

CreatedUtcstring

UTC date string indicating when the Payment Integration was created.

UpdatedUtcstring

UTC date string indicating when the Payment Integration was updated.

Bad Request

Forbidden - trying to edit Payment Integration for which you do not have authorization

Not Found - no Payment Integration found for ID provided

Suggest Edits

Get Payment Integration

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId
curl --request GET \
  --url https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

paymentIntegrationId
int64
required

Payment Integration ID

Response

Successful Operation

Idinteger

The unique Identifier for the Payment Integration.

SiteIdinteger

The ID of the Site to which the Payment Integration belongs.

PaymentMethodTypestring

The type of payment method. Can be [Stripe, AuthorizeNet]

ApiAccountstring

Stripe

(Not used)

Authorize.net

API Login ID

ApiKey1string

Stripe

API Secret Key

Authorize.net

API Transaction Key

ApiKey2string

Stripe

API Publishable Key

Authorize.net

(Not used)

TestModeboolean

Whether this Payment Integration is running in test mode.

CreatedUtcstring

UTC date string indicating when the Payment Integration was created.

UpdatedUtcstring

UTC date string indicating when the Payment Integration was updated.

Not Found - no Payment Integration found for ID provided

Suggest Edits

Delete Payment Integration

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentIntegration/paymentIntegrationId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

paymentIntegrationId
int64
required

Payment Integration ID

Response

Successful Operation

Forbidden - trying to delete Payment Integration for which you do not have authorization

Not Found - no Payment Integration found for ID provided

Suggest Edits

PaymentMethods

 
Suggest Edits

Get PaymentMethods

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/PaymentMethods
curl --request GET \
  --url https://api.qpilot.cloud/api/PaymentMethods
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qpilot.cloud/api/PaymentMethods' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentMethods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/PaymentMethods");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentMethods"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful Operation

Idinteger

Unique Identifier for the PaymentMethod within QPilot

CustomerIdinteger

ID of QPilot customer to which the PaymentMethod belongs

Typestring

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerIdstring

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentIdstring

Unique Identifier the PaymentMethod within the payment gateway

Descriptionstring

User friendly desciption for the PaymentMethod

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was last updated

Note

When getting Payment Methods, the response includes an array of objects (this is called out because we cannot display this in our docs at this time).

Suggest Edits

Create PaymentMethod

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.qpilot.cloud/api/PaymentMethods
curl --request POST \
  --url https://api.qpilot.cloud/api/PaymentMethods
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qpilot.cloud/api/PaymentMethods' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentMethods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qpilot.cloud/api/PaymentMethods");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentMethods"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

Id
int64

Unique Identifier for the PaymentMethod within QPilot

CustomerId
int64

ID of QPilot customer to which the PaymentMethod belongs

Type
string

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerId
string

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentId
string

Unique Identifier the PaymentMethod within the payment gateway

Description
string

User friendly desciption for the PaymentMethod

BillingFirstName
string

Billing First Name.

BillingLastName
string

Billing Last Name.

BillingStreet1
string

Billing Street 1.

BillingStreet2
string

Billing Street 2.

BillingCity
string

Billing City.

BillingState
string

Billing State.

BillingPostcode
string

Billing Postal Code.

BillingCountry
string

Billing Country.

CreatedUtc
date-time

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtc
date-time

UTC Date string indicating the date/time the PaymentMethod was last updated

Response

Successful Operation

Idinteger

Unique Identifier for the PaymentMethod within QPilot

CustomerIdinteger

ID of QPilot customer to which the PaymentMethod belongs

Typestring

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerIdstring

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentIdstring

Unique Identifier the PaymentMethod within the payment gateway

Descriptionstring

User friendly desciption for the PaymentMethod

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was last updated

Bad request

Forbidden - trying to edit Payment Method for which you do not have authorization

Suggest Edits

Get PaymentMethod by ID

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/PaymentMethods/paymentMethodId
curl --request GET \
  --url https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

paymentMethodId
int64
required

Payment Method ID

Response

Successful Operation

Idinteger

Unique Identifier for the PaymentMethod within QPilot

CustomerIdinteger

ID of QPilot customer to which the PaymentMethod belongs

Typestring

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerIdstring

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentIdstring

Unique Identifier the PaymentMethod within the payment gateway

Descriptionstring

User friendly desciption for the PaymentMethod

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was last updated

Not Found - no Payment Method found for ID provided

Suggest Edits

Update PaymentMethod

 

Header Auth

 Authentication is required for this endpoint.
puthttps://api.qpilot.cloud/api/PaymentMethods/paymentMethodId
curl --request PUT \
  --url https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

paymentMethodId
int64
required

Payment Method ID

Body Params

Id
int64

Unique Identifier for the PaymentMethod within QPilot

CustomerId
int64

ID of QPilot customer to which the PaymentMethod belongs

Type
string

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerId
string

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentId
string

Unique Identifier the PaymentMethod within the payment gateway

Description
string

User friendly desciption for the PaymentMethod

BillingFirstName
string

Billing First Name.

BillingLastName
string

Billing Last Name.

BillingStreet1
string

Billing Street 1.

BillingStreet2
string

Billing Street 2.

BillingCity
string

Billing City.

BillingState
string

Billing State.

BillingPostcode
string

Billing Postal Code.

BillingCountry
string

Billing Country.

CreatedUtc
date-time

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtc
date-time

UTC Date string indicating the date/time the PaymentMethod was last updated

Response

Successful Operation

Idinteger

Unique Identifier for the PaymentMethod within QPilot

CustomerIdinteger

ID of QPilot customer to which the PaymentMethod belongs

Typestring

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerIdstring

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentIdstring

Unique Identifier the PaymentMethod within the payment gateway

Descriptionstring

User friendly desciption for the PaymentMethod

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was last updated

Bad Request

Forbidden - trying to edit Payment Method for which you do not have authorization

Not Found - no Payment Method found for ID provided

Suggest Edits

Delete PaymentMethod

 

Header Auth

 Authentication is required for this endpoint.
deletehttps://api.qpilot.cloud/api/PaymentMethods/paymentMethodId
curl --request DELETE \
  --url https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/PaymentMethods/paymentMethodId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

paymentMethodId
int64
required

Payment Method ID

Response

Successful Operation

Idinteger

Unique Identifier for the PaymentMethod within QPilot

CustomerIdinteger

ID of QPilot customer to which the PaymentMethod belongs

Typestring

The type of payment method. Can be [Stripe, AuthorizeNet]

GatewayCustomerIdstring

Unique Identifier for the customer to which the PaymentMethod belongs within the payment gateway

GatewayPaymentIdstring

Unique Identifier the PaymentMethod within the payment gateway

Descriptionstring

User friendly desciption for the PaymentMethod

BillingFirstNamestring

Billing First Name.

BillingLastNamestring

Billing Last Name.

BillingStreet1string

Billing Street 1.

BillingStreet2string

Billing Street 2.

BillingCitystring

Billing City.

BillingStatestring

Billing State.

BillingPostcodestring

Billing Postal Code.

BillingCountrystring

Billing Country.

CreatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was created

UpdatedUtcstring

UTC Date string indicating the date/time the PaymentMethod was last updated

Forbidden - trying to delete Payment Method for which you do not have authorization

Not Found - no Payment Method found for ID provided

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Users/userId
curl --request GET \
  --url https://api.qpilot.cloud/api/Users/userId
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Users/userId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Users/userId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Users/userId");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Users/userId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

userId
int64
required

User ID

Response

Successful Operation

Idinteger

The unique Identifier for the User.

Emailstring

The email address of the User.

Rolesstring

The assigned roles for the User.

SubscriptionIdstring

The ID of the subscription.

SubscriptionStatusstring

The status of a subscription.

SubscriptionPaymentMethodDescriptionstring

The description of the payment method for the subscription.

SubscriptionUpdatedUtcstring

UTC date string indicating when the subscription was updated.

CreatedUtcstring

UTC date string indicating when the User was created.

UpdatedUtcstring

UTC date string indicating when the User was updated.

Sitesarray

Not Found - no User found for ID provided

Suggest Edits

Get total account usage

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Users/userId/CurrentUsage
curl --request GET \
  --url https://api.qpilot.cloud/api/Users/userId/CurrentUsage
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.qpilot.cloud/api/Users/userId/CurrentUsage' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qpilot.cloud/api/Users/userId/CurrentUsage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qpilot.cloud/api/Users/userId/CurrentUsage");

xhr.send(data);
import requests

url = "https://api.qpilot.cloud/api/Users/userId/CurrentUsage"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

userId
int64
required

User ID

Response

Successful Operation

ScheduledOrdersPausedCountinteger

Number of Scheduled Orders that are paused

ScheduledOrdersActiveCountinteger

Number of Scheduled Orders that are active

ScheduledOrdersTotalinteger

Total value of all Scheduled Orders

Forbidden - trying to access Account Usage for which you do not have authorization

Suggest Edits

Get plan usage for specified period

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.qpilot.cloud/api/Users/userId/PlanUsage