PrintNowPrintNowDocs

Reports

Run the same business reports as the admin's Reports pages and get the rows as JSON.

Parameters

Every report takes the same query parameters, all required:

ParameterMeaning
storefrontIdA storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows (not an error).
fromDateFirst day of the report, YYYY-MM-DD, inclusive.
toDateLast day of the report, YYYY-MM-DD, inclusive. If it's before fromDate, the two are swapped.

The order report also takes viewBy: day (default), month or year.

A missing parameter answers 404 (no route matches); an invalid value answers 400.

curl -u "YOUR_API_TOKEN:YOUR_API_KEY" \
  "https://api.printnow.com/api/v2/report/sales?storefrontId=0&fromDate=2026-01-01&toDate=2026-01-31"

Reports

ReportOne row per
salesstorefront: customers, orders, average order, sales
taxorder: ship-to country/state, subtotal, shipping, discount, tax, total
orderday, month or year: orders, items, sales, tax, shipping
order_detailsorder: customer, addresses, sales rep, totals, shipping, tracking, status
order_item_detailsline item: customer, product, quantity, total, ship-to address, shipping
product_salesproduct: units, orders, sales
promotion_codepromotion code: orders, discount
customer_listcustomer: account details, orders and sales in the range
customer_salescustomer: orders and sales in the range
shippingcarrier and service: orders, shipping charges
sales_repsales rep: orders, average order, sales
saved_projectscustomer: saved projects
conversion_ratestorefront: sessions, added to cart, reached checkout, converted
affiliatesaffiliate: referred orders, their total, commission

Dates in report rows

Report rows don't use the UTC timestamps of the rest of the API. Each date field's description says which form it uses:

  • Timestamps such as the tax and order details order_date, the customer list's login and creation dates, and order item shipped_on: ISO 8601 in the server's local time, without a time zone (2026-01-15T09:30:00).
  • Plain dates such as the order item details order_date, the customer sales login and creation dates, and promotion expiration: M/D/YYYY text (1/15/2026). The order report's period is M/D/YYYY, M/YYYY or YYYY, depending on viewBy.

Sales report

GET
/api/v2/report/sales
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/sales?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront": "Demo Store",
    "user_count": 247,
    "order_count": 683,
    "order_average": 269.2221,
    "order_total": 183878.7
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Tax report

GET
/api/v2/report/tax
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/tax?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "order_id": 406,
    "order_date": "2018-09-07T14:48:52.767",
    "country": "IE",
    "state": "",
    "sub_total": 0.5,
    "shipping_total": 106.09,
    "promotion_total": 0,
    "tax_total": 21.32,
    "grand_total": 127.91,
    "group_by_key": ", Ireland"
  },
  {
    "order_id": 698,
    "order_date": "2021-12-07T08:57:57.937",
    "country": "CA",
    "state": "AB",
    "sub_total": 293.5,
    "shipping_total": 28.02,
    "promotion_total": 0,
    "tax_total": 9.7,
    "grand_total": 331.22,
    "group_by_key": "AB, Canada"
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Order report

GET
/api/v2/report/order
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time
viewBy?|

Group rows by day (default), month or year.

Default"day"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/order?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "period": "1/2/2018",
    "order_count": 1,
    "item_count": 1,
    "order_total": 148,
    "tax_total": 9.25,
    "shipping_total": 0
  },
  {
    "period": "1/31/2018",
    "order_count": 1,
    "item_count": 3,
    "order_total": 444,
    "tax_total": 27.75,
    "shipping_total": 0
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Order details report

GET
/api/v2/report/order_details
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/order_details?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "order_id": 385,
    "customer_email": "demo.user@domain.com",
    "billing_address": "Demo Company\r\nJohn Doe\r\n123 Main St.\r\nSuite 200\r\nSpringfield MA 01103\r\nUS\r\n555-123-4567\r\ndemo@demostore.com",
    "shipping_address": "Demo Company\r\nJohn Doe\r\n123 Main St.\r\nSuite 200\r\nSpringfield MA 01103\r\nUS\r\n555-123-4567\r\ndemo@demostore.com",
    "order_date": "2018-01-02T11:50:04.62",
    "store_url": "demostore.com",
    "sales_rep": null,
    "sub_total": 148,
    "shipping_total": 0,
    "promotion_total": 0,
    "tax_total": 9.25,
    "grand_total": 157.25,
    "promotion_code": "",
    "shipping_provider": "UPS",
    "shipping_method": "UPS Second Day Air",
    "tracking_numbers": null,
    "invoice_number": null,
    "order_status": "Beginning",
    "company": "Demo Company",
    "user_group": ""
  },
  {
    "order_id": 386,
    "customer_email": "demo.user@domain.com",
    "billing_address": "Demo Company\r\nJohn Doe\r\n123 Main St.\r\nSuite 200\r\nSpringfield MA 01103\r\nUS\r\n555-123-4567\r\ndemo@demostore.com",
    "shipping_address": "Demo Company\r\nJohn Doe\r\n123 Main St.\r\nSuite 200\r\nSpringfield MA 01103\r\nUS\r\n555-123-4567\r\ndemo@demostore.com",
    "order_date": "2018-01-02T11:56:03.777",
    "store_url": "demostore.com",
    "sales_rep": null,
    "sub_total": 148,
    "shipping_total": 0,
    "promotion_total": 0,
    "tax_total": 9.25,
    "grand_total": 157.25,
    "promotion_code": "",
    "shipping_provider": "UPS",
    "shipping_method": "UPS Second Day Air",
    "tracking_numbers": null,
    "invoice_number": null,
    "order_status": "Beginning",
    "company": "Demo Company",
    "user_group": ""
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Order item details report

GET
/api/v2/report/order_item_details
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/order_item_details?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "order_id": 385,
    "order_date": "1/2/2018",
    "customer_company": "Demo Company",
    "customer_name": "Demo User",
    "customer_username": "demouser",
    "item_id": 509,
    "item_status": "Beginning",
    "product_name": "Static Product",
    "product_item_number": "104",
    "product_model_number": "static-product-2",
    "quantity": 250,
    "item_total": 148,
    "shipping_address_line_1": "123 Main St.",
    "shipping_address_line_2": "Suite 200",
    "shipping_address_line_3": "",
    "shipping_address_line_4": "",
    "shipping_address_city": "Springfield",
    "shipping_address_state": "MA",
    "shipping_address_postal_code": "01103",
    "shipping_method": "UPS Second Day Air",
    "shipping_provider": "UPS",
    "shipped_on": null,
    "tracking_numbers": null,
    "shipping_total": 0,
    "customer_user_groups": ""
  },
  {
    "order_id": 386,
    "order_date": "1/2/2018",
    "customer_company": "Demo Company",
    "customer_name": "Demo User",
    "customer_username": "demouser",
    "item_id": 510,
    "item_status": "Beginning",
    "product_name": "Static Product",
    "product_item_number": "104",
    "product_model_number": "static-product-2",
    "quantity": 250,
    "item_total": 148,
    "shipping_address_line_1": "123 Main St.",
    "shipping_address_line_2": "Suite 200",
    "shipping_address_line_3": "",
    "shipping_address_line_4": "",
    "shipping_address_city": "Springfield",
    "shipping_address_state": "MA",
    "shipping_address_postal_code": "01103",
    "shipping_method": "UPS Second Day Air",
    "shipping_provider": "UPS",
    "shipped_on": null,
    "tracking_numbers": null,
    "shipping_total": 0,
    "customer_user_groups": ""
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Product sales report

GET
/api/v2/report/product_sales
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/product_sales?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "product_id": 0,
    "category_name": "Business Cards",
    "product_name": "3.5\" × 3.5\" Custom Upload ",
    "quantity": 10000,
    "order_count": 1,
    "sales_total": 100000000
  },
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "product_id": 18,
    "category_name": "Test Business Cards",
    "product_name": "Test Business Card 4",
    "quantity": 72950,
    "order_count": 135,
    "sales_total": 65235.2733
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Promotion code report

GET
/api/v2/report/promotion_code
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/promotion_code?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "code": "100OFF4ME",
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "description": "",
    "expiration": "",
    "order_count": 5,
    "discount_total": 4779.85
  },
  {
    "code": "DISTPROOF",
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "description": "Ground shipping",
    "expiration": "",
    "order_count": 2,
    "discount_total": 149.85
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Customer list report

GET
/api/v2/report/customer_list
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/customer_list?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "customer_id": 24,
    "customer_company": "Demo Company",
    "customer_first_name": "Demo",
    "customer_last_name": "User",
    "customer_email": "demo.user@domain.com",
    "customer_username": "demouser",
    "customer_last_login_on": "2026-11-16T10:01:16.62",
    "customer_created_on": "2021-08-30T09:34:44.62",
    "order_count": 740,
    "sales_total": 119426161.5524,
    "customer_marketing_emails": true
  },
  {
    "storefront_id": 2,
    "storefront": "Storefront : B2B",
    "customer_id": 180946,
    "customer_company": null,
    "customer_first_name": "Demo",
    "customer_last_name": "User",
    "customer_email": "demo.user@domain.com",
    "customer_username": "5e46d0c5cf63514f8fca00f718c0f42e",
    "customer_last_login_on": null,
    "customer_created_on": "2024-11-05T09:29:48.097",
    "order_count": 8,
    "sales_total": 692,
    "customer_marketing_emails": false
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Customer sales report

GET
/api/v2/report/customer_sales
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/customer_sales?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "customer_id": 24,
    "customer_company": "Demo Company",
    "customer_first_name": "Demo",
    "customer_last_name": "User",
    "customer_email": "demo.user@domain.com",
    "customer_username": "demouser",
    "customer_last_login_on": "11/16/2026",
    "customer_created_on": "8/30/2021",
    "order_count": 480,
    "sales_total": 118390085.8424
  },
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "customer_id": 53141,
    "customer_company": "",
    "customer_first_name": "Jane",
    "customer_last_name": "Smith",
    "customer_email": "jane.smith@domain.com",
    "customer_username": "jsmith",
    "customer_last_login_on": "7/23/2014",
    "customer_created_on": "7/23/2014",
    "order_count": 2,
    "sales_total": 1632.71
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Shipping report

GET
/api/v2/report/shipping
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/shipping?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "provider": "USPS",
    "description": "U.S.P.S Priority Mail™",
    "shipping_total": 1154.1,
    "order_count": 87
  },
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "provider": "FIXED",
    "description": "No Cost Shipping",
    "shipping_total": 0,
    "order_count": 78
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Sales rep report

GET
/api/v2/report/sales_rep
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/sales_rep?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "sales_rep_id": 51516,
    "sales_rep_name": "Demo Approver",
    "order_count": 2,
    "order_average": 339358.86,
    "order_total": 678717.72
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Saved projects report

GET
/api/v2/report/saved_projects
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/saved_projects?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "customer_id": 24,
    "customer_company": "Demo Company",
    "customer_first_name": "Demo",
    "customer_last_name": "User",
    "customer_email": "demo.user@domain.com",
    "customer_username": "demouser",
    "project_count": 1143
  },
  {
    "storefront_id": 1,
    "storefront": "Storefront : Demo Store",
    "customer_id": 53508,
    "customer_company": "",
    "customer_first_name": "Sam",
    "customer_last_name": "Lee",
    "customer_email": "sam.lee@domain.com",
    "customer_username": "Lee",
    "project_count": 25
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Conversion rate report

GET
/api/v2/report/conversion_rate
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/conversion_rate?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "storefront": "Demo Store",
    "added_to_cart": 1286,
    "converted": 284,
    "reached_checkout": 893,
    "total_sessions": 37658
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

Affiliates report

GET
/api/v2/report/affiliates
AuthorizationBasic <token>

Your API token as the username and your API key as the password.

In: header

Query Parameters

storefrontId*integer

Storefront id, or 0 for all storefronts in your account. An id that doesn't match a storefront returns no rows.

Formatint32
fromDate*string

First day of the report (YYYY-MM-DD), inclusive.

Formatdate-time
toDate*string

Last day of the report (YYYY-MM-DD), inclusive. Swapped with fromDate if earlier.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.printnow.com/api/v2/report/affiliates?storefrontId=0&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z"
[
  {
    "affiliate_id": 2,
    "company": "Acme, Inc.",
    "affiliate_code": "splash-page",
    "first_name": "Sam",
    "last_name": "Lee",
    "email": "sam.lee@domain.com",
    "order_count": 83,
    "order_total": 112309.65,
    "affiliate_total": 83
  },
  {
    "affiliate_id": 1,
    "company": "Demo Company",
    "affiliate_code": "demo-affiliate",
    "first_name": "Alex",
    "last_name": "Rivera",
    "email": "alex.rivera@domain.com",
    "order_count": 6,
    "order_total": 209.09,
    "affiliate_total": 12.55
  }
]
{
  "Message": "string"
}

The key or token is missing, does not match, or the token is inactive or deleted.

{
  "Message": "Invalid key or token."
}

The message names the section, e.g. Orders, Customers, Products, Storefronts, Reports or Webhooks.

{
  "Message": "Your license does not include the Orders API."
}
{
  "Message": "string"
}

Each license may make 100 calls per 10 seconds across all its API keys. Wait for the Retry-After header (seconds) before calling again.

{
  "Message": "Rate limit exceeded: 100 calls per 10 seconds."
}

On this page