Introduction
Datasources and destinations
- Find all the data sources available at www.catchr.io/connectors
- Find all the destinations available at www.catchr.io/destinations
Day of the month Day of the year |
| ||||||
Day of the week Week of the year |
| ||||||
Hour of the day Hour of the day |
| ||||||
Month of the year Month of the year |
| ||||||
Month and day Month and day |
| ||||||
Quarter of the year Quarter of the year |
| ||||||
Week of the year Week of the year |
| ||||||
Week of the year (start Sunday) Week of the year |
| ||||||
Year Year such as 2017. |
| ||||||
Year month Year and month. |
| ||||||
Date Year, month, and day. |
| ||||||
Year month day hour Year, month, day, and hour. |
| ||||||
Year Quarter Year and quarter. |
| ||||||
Year week Year and week. |
| ||||||
Coupon Amount The amount of discount. Should always be numeric, even if setting a percentage. |
| ||||||
Coupon Code Coupon code. mandatory |
| ||||||
Coupon Date Created The date the coupon was created, in the site's timezone. read-only |
| ||||||
Coupon Date Created Gmt The date the coupon was created, as GMT. read-only |
| ||||||
Coupon Date Expires The date the coupon expires, in the site's timezone. |
| ||||||
Coupon Date Expires Gmt The date the coupon expires, as GMT. |
| ||||||
Coupon Date Modified The date the coupon was last modified, in the site's timezone. read-only |
| ||||||
Coupon Date Modified Gmt The date the coupon was last modified, as GMT. read-only |
| ||||||
Coupon Description Coupon description. |
| ||||||
Coupon Discount Type Determines the type of discount that will be applied. Options: percent, fixed_cart and fixed_product. Default is fixed_cart. |
| ||||||
Coupon Email Restrictions List of email addresses that can use this coupon. |
| ||||||
Coupon Exclude Sale Items If true, this coupon will not be applied to items that have sale prices. Default is false. |
| ||||||
Coupon Excluded Product Categories List of category IDs the coupon does not apply to. |
| ||||||
Coupon Excluded Product Ids List of product IDs the coupon cannot be used on. |
| ||||||
Coupon Free Shipping If true and if the free shipping method requires a coupon, this coupon will enable free shipping. Default is false. |
| ||||||
Coupon Id Unique identifier for the object. read-only |
| ||||||
Coupon Individual Use If true, the coupon can only be used individually. Other applied coupons will be removed from the cart. Default is false. |
| ||||||
Coupon Limit Usage To X Items Max number of items in the cart the coupon can be applied to. |
| ||||||
Coupon Maximum Amount Maximum order amount allowed when using the coupon. |
| ||||||
Coupon Minimum Amount Minimum order amount that needs to be in the cart before coupon applies. |
| ||||||
Coupon Product Categories List of category IDs the coupon applies to. |
| ||||||
Coupon Product Ids List of product IDs the coupon can be used on. |
| ||||||
Coupon Usage Count Number of times the coupon has been used already. read-only |
| ||||||
Coupon Usage Limit How many times the coupon can be used in total. |
| ||||||
Coupon Usage Limit Per User How many times the coupon can be used per customer. |
| ||||||
Coupon Used By List of user IDs (or guest email addresses) that have used the coupon. read-only |
| ||||||
Customer Avatar Url Avatar URL. read-only |
| ||||||
Customer Date Created The date the customer was created, in the site's timezone. read-only |
| ||||||
Customer Date Created Gmt The date the customer was created, as GMT. read-only |
| ||||||
Customer Date Modified The date the customer was last modified, in the site's timezone. read-only |
| ||||||
Customer Date Modified Gmt The date the customer was last modified, as GMT. read-only |
| ||||||
Customer Email The email address for the customer. mandatory |
| ||||||
Customer First Name Customer first name. |
| ||||||
Customer Id Unique identifier for the resource. read-only |
| ||||||
Customer Is Paying Customer Is the customer a paying customer? read-only |
| ||||||
Customer Last Name Customer last name. |
| ||||||
Customer Role Customer role. read-only |
| ||||||
Shop Total Customers Total of customers who placed orders |
| ||||||
Shop Total Coupons Used Total of coupons used |
| ||||||
Shop Total Items Purchased Total of items purchased. |
| ||||||
Shop Net Sales Net sales in the period. |
| ||||||
Order Attribution Device Type Device type used to place the order. read-only |
| ||||||
Order Attribution Referrer Referrer used to place the order. read-only |
| ||||||
Order Attribution Session Count Number of sessions used to place the order. read-only |
| ||||||
Order Attribution Session Pages Number of pages viewed during the sessions used to place the order. read-only |
| ||||||
Order Attribution Source Type Source type used to place the order. read-only |
| ||||||
Order Attribution User Agent User agent of the device used to place the order. read-only |
| ||||||
Order Attribution UTM Medium UTM medium used to place the order. read-only |
| ||||||
Order Attribution UTM Source UTM source used to place the order. read-only |
| ||||||
Billing Address 1 Billing Address 2 |
| ||||||
Billing Address 2 Billing Address 2 |
| ||||||
Billing Company Name Billing Company Name |
| ||||||
Billing Country Billing Country |
| ||||||
Billing Email Billing Email |
| ||||||
Billing First Name Billing First Name |
| ||||||
Billing Last Name Billing Last Name |
| ||||||
Billing Phone Number Billing Email |
| ||||||
Billing Post code Billing Post code |
| ||||||
Billing State Billing State |
| ||||||
Order Cart Hash MD5 hash of cart items to ensure orders are not modified. read-only |
| ||||||
Order Cart Tax Sum of line item taxes only. read-only |
| ||||||
Order Created Via Shows where the order was created. read-only |
| ||||||
Order Currency Currency the order was created with, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. Default is USD. |
| ||||||
Order Customer Id User ID who owns the order. 0 for guests. Default is 0. |
| ||||||
Order Customer Ip Address Customer's IP address. read-only |
| ||||||
Order Customer Note Note left by customer during checkout. |
| ||||||
Order Customer User Agent User agent of the customer. read-only |
| ||||||
Order Date Completed The date the order was completed, in the site's timezone. read-only |
| ||||||
Order Date Completed Gmt The date the order was completed, as GMT. read-only |
| ||||||
Order Date Created The date the order was created, in the site's timezone. read-only |
| ||||||
Order Date Created Gmt The date the order was created, as GMT. read-only |
| ||||||
Order Date Modified The date the order was last modified, in the site's timezone. read-only |
| ||||||
Order Date Modified Gmt The date the order was last modified, as GMT. read-only |
| ||||||
Order Date Paid The date the order was paid, in the site's timezone. read-only |
| ||||||
Order Date Paid Gmt The date the order was paid, as GMT. read-only |
| ||||||
Order Discount Tax Total discount tax amount for the order. read-only |
| ||||||
Order Discount Total Total discount amount for the order. read-only |
| ||||||
Order Id Unique identifier for the resource. read-only |
| ||||||
Order Number Order number. read-only |
| ||||||
Order Order Key Order key. read-only |
| ||||||
Order Parent Id Parent order ID. |
| ||||||
Order Payment Method Payment method ID. |
| ||||||
Order Payment Method Title Payment method title. |
| ||||||
Order Prices Include Tax True the prices included tax during checkout. read-only |
| ||||||
Order Set Paid Define if the order is paid. It will set the status to processing and reduce stock items. Default is false. write-only |
| ||||||
shipping Address 1 shipping Address 2 |
| ||||||
shipping Address 2 shipping Address 2 |
| ||||||
shipping Company Name shipping Company Name |
| ||||||
shipping Country shipping Country |
| ||||||
shipping Email shipping Email |
| ||||||
shipping First Name shipping First Name |
| ||||||
shipping Last Name shipping Last Name |
| ||||||
Order Shipping Lines ID Order Shipping Lines ID |
| ||||||
Order Shipping Method ID Order Shipping Method ID |
| ||||||
Order Shipping Method Title Order Shipping Method Title |
| ||||||
Order Shipping Method Total Order Shipping Method Total |
| ||||||
Order Shipping Method Total Tax Order Shipping Method Total Tax |
| ||||||
shipping Phone Number shipping Email |
| ||||||
shipping Post code shipping Post code |
| ||||||
shipping State shipping State |
| ||||||
Order Shipping Tax Total shipping tax amount for the order. read-only |
| ||||||
Order Shipping Total Total shipping amount for the order. read-only |
| ||||||
Order Status Order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Default is pending. |
| ||||||
Tax Lines Compound Tax Lines Compound |
| ||||||
Tax Lines 1 ID Tax Lines 1 ID |
| ||||||
Tax Lines Label Tax Lines Label |
| ||||||
Tax Lines Rate Code Tax Lines Rate Code |
| ||||||
Tax Lines Rate Id Tax Lines Rate Id |
| ||||||
Tax Lines Shipping Tax Total Tax Lines Shipping Tax Total |
| ||||||
Tax Lines Number Tax Lines Number |
| ||||||
Order Total Grand total. read-only |
| ||||||
Order Total Tax Sum of all taxes. read-only |
| ||||||
Order Transaction Id Unique transaction ID. |
| ||||||
Order Version Version of WooCommerce which last updated the order. read-only |
| ||||||
Order Line Id Item ID. |
| ||||||
Order Line Product name Order Line Product name. |
| ||||||
Order Line Product price Product price. |
| ||||||
Order Line Product Id Order Line Product Id. |
| ||||||
Order Line Product Quantity Order Line Product Quantity |
| ||||||
Order Line Product SKU Product SKU. |
| ||||||
Order Line Subtotal Line subtotal (before discounts). |
| ||||||
Order Line Subtotal tax Line subtotal tax (before discounts). |
| ||||||
Order Line Tax Class Slug of the tax class of product. |
| ||||||
Order Line Total Line total (after discounts). |
| ||||||
Order Line Total Tax Line total tax (after discounts). |
| ||||||
Order Line Product Variation Id Order Line Product Variation Id. |
| ||||||
Shop Total Orders Total of orders placed. |
| ||||||
Product Attributes List of attributes. See Product - Attributes properties |
| ||||||
Product Average Rating Reviews average rating. read-only |
| ||||||
Product Backordered Shows if the product is on backordered. read-only |
| ||||||
Product Backorders If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no. |
| ||||||
Product Backorders Allowed Shows if backorders are allowed. read-only |
| ||||||
Product Button Text Product external button text. Only for external products. |
| ||||||
Product Catalog Visibility Catalog visibility. Options: visible, catalog, search and hidden. Default is visible. |
| ||||||
Product Categories List of categories. See Product - Categories properties |
| ||||||
Product Cross Sell Ids List of cross-sell products IDs. |
| ||||||
Product Date Created The date the product was created, in the site's timezone. read-only |
| ||||||
Product Date Created Gmt The date the product was created, as GMT. read-only |
| ||||||
Product Date Modified The date the product was last modified, in the site's timezone. read-only |
| ||||||
Product Date Modified Gmt The date the product was last modified, as GMT. read-only |
| ||||||
Product Date On Sale From Start date of sale price, in the site's timezone. |
| ||||||
Product Date On Sale From Gmt Start date of sale price, as GMT. |
| ||||||
Product Date On Sale To End date of sale price, in the site's timezone. |
| ||||||
Product Date On Sale To Gmt End date of sale price, as GMT. |
| ||||||
Product Default Attributes Defaults variation attributes. See Product - Default attributes properties |
| ||||||
Product Description Product description. |
| ||||||
Product Download Expiry Number of days until access to downloadable files expires. Default is -1. |
| ||||||
Product Download Limit Number of times downloadable files can be downloaded after purchase. Default is -1. |
| ||||||
Product Downloadable If the product is downloadable. Default is false. |
| ||||||
Product Downloads List of downloadable files. See Product - Downloads properties |
| ||||||
Product External Url Product external URL. Only for external products. |
| ||||||
Product Featured Featured product. Default is false. |
| ||||||
Product Grouped Products List of grouped products ID. |
| ||||||
Product height Product height. |
| ||||||
Product Id Unique identifier for the resource. read-only |
| ||||||
Product Images List of images. See Product - Images properties |
| ||||||
Product Length Product Length. |
| ||||||
Product Manage Stock Stock management at product level. Default is false. |
| ||||||
Product Menu Order Menu order, used to custom sort products. |
| ||||||
Product Name Product name. |
| ||||||
Product On Sale Shows if the product is on sale. read-only |
| ||||||
Product Parent Id Product parent ID. |
| ||||||
Product Permalink Product URL. read-only |
| ||||||
Product Price Current product price. read-only |
| ||||||
Product Price Html Price formatted in HTML. read-only |
| ||||||
Product Purchasable Shows if the product can be bought. read-only |
| ||||||
Product Purchase Note Optional note to send the customer after purchase. |
| ||||||
Product Rating Count Amount of reviews that the product have. read-only |
| ||||||
Product Regular Price Product regular price. |
| ||||||
Product Related Ids List of related products IDs. read-only |
| ||||||
Product Reviews Allowed Allow reviews. Default is true. |
| ||||||
Product Sale Price Product sale price. |
| ||||||
Product Shipping Class Shipping class slug. |
| ||||||
Product Shipping Class Id Shipping class ID. read-only |
| ||||||
Product Shipping Required Shows if the product need to be shipped. read-only |
| ||||||
Product Shipping Taxable Shows whether or not the product shipping is taxable. read-only |
| ||||||
Product Short Description Product short description. |
| ||||||
Product Sku Unique identifier. |
| ||||||
Product Slug Product slug. |
| ||||||
Product Sold Individually Allow one item to be bought in a single order. Default is false. |
| ||||||
Product Status Product status (post status). Options: draft, pending, private and publish. Default is publish. |
| ||||||
Product Stock Quantity Stock quantity. |
| ||||||
Product Stock Status Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock. |
| ||||||
Product Tags List of tags. See Product - Tags properties |
| ||||||
Product Tax Class Tax class. |
| ||||||
Product Tax Status Tax status. Options: taxable, shipping and none. Default is taxable. |
| ||||||
Product Total Sales Amount of sales. read-only |
| ||||||
Product Type Product type. Options: simple, grouped, external and variable. Default is simple. |
| ||||||
Product Upsell Ids List of up-sell products IDs. |
| ||||||
Product Variations List of variations IDs. read-only |
| ||||||
Product Virtual If the product is virtual. Default is false. |
| ||||||
Product Weight Product weight. |
| ||||||
Product Width Product width. |
| ||||||
Product Variations Backordered Shows if the variation is on backordered. read-only |
| ||||||
Product Variations Backorders If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no. |
| ||||||
Product Variations Backorders Allowed Shows if backorders are allowed. read-only |
| ||||||
Product Variations Date Created The date the variation was created, in the site's timezone. read-only |
| ||||||
Product Variations Date Created Gmt The date the variation was created, as GMT. read-only |
| ||||||
Product Variations Date Modified The date the variation was last modified, in the site's timezone. read-only |
| ||||||
Product Variations Date Modified Gmt The date the variation was last modified, as GMT. read-only |
| ||||||
Product Variations Date On Sale From Start date of sale price, in the site's timezone. |
| ||||||
Product Variations Date On Sale From Gmt Start date of sale price, as GMT. |
| ||||||
Product Variations Date On Sale To End date of sale price, in the site's timezone. |
| ||||||
Product Variations Date On Sale To Gmt End date of sale price, as GMT. |
| ||||||
Product Variations Description Variation description. |
| ||||||
Product Variations Download Expiry Number of days until access to downloadable files expires. Default is -1. |
| ||||||
Product Variations Download Limit Number of times downloadable files can be downloaded after purchase. Default is -1. |
| ||||||
Product Variations Downloadable If the variation is downloadable. Default is false. |
| ||||||
Product Variations Id Unique identifier for the resource. read-only |
| ||||||
Product Variations Image Variation image data. See Product variation - Image properties |
| ||||||
Product Variations Manage Stock Stock management at variation level. Default is false. |
| ||||||
Product Variations Menu Order Menu order, used to custom sort products. |
| ||||||
Product Variations On Sale Shows if the variation is on sale. read-only |
| ||||||
Product Variations Permalink Variation URL. read-only |
| ||||||
Product Variations Price Current variation price. read-only |
| ||||||
Product Variations Purchasable Shows if the variation can be bought. read-only |
| ||||||
Product Variations Regular Price Variation regular price. |
| ||||||
Product Variations Sale Price Variation sale price. |
| ||||||
Product Variations Shipping Class Shipping class slug. |
| ||||||
Product Variations Shipping Class Id Shipping class ID. read-only |
| ||||||
Product Variations Sku Unique identifier. |
| ||||||
Product Variations Status Variation status. Options: draft, pending, private and publish. Default is publish. |
| ||||||
Product Variations Stock Quantity Stock quantity. |
| ||||||
Product Variations Stock Status Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock. |
| ||||||
Product Variations Tax Class Tax class. |
| ||||||
Product Variations Tax Status Tax status. Options: taxable, shipping and none. Default is taxable. |
| ||||||
Product Variations Virtual If the variation is virtual. Default is false. |
| ||||||
Product Variations Weight Variation weight. |
| ||||||
Refund Amount Total refund amount. Optional. If this parameter is provided, it will take precedence over line item totals, even when total of line items does not matches with this amount. |
| ||||||
Refund Api Refund When true, the payment gateway API is used to generate the refund. Default is true. write-only |
| ||||||
Refund Date Created The date the order refund was created, in the site's timezone. read-only |
| ||||||
Refund Date Created Gmt The date the order refund was created, as GMT. read-only |
| ||||||
Refund Id Unique identifier for the resource. read-only |
| ||||||
Refund Line Items Line items data. See Order refund - Line items properties |
| ||||||
Refund Meta Data Meta data. See Order refund - Meta data properties |
| ||||||
Refund Reason Reason for refund. |
| ||||||
Refund Refunded By User ID of user who created the refund. |
| ||||||
Refund Refunded Payment If the payment was refunded via the API. See api_refund. read-only |
| ||||||
Shop Total Refunds Total of refunds |
| ||||||
Shop Gross Sales Gross sales in the period. |
| ||||||
Shop Total Shipping Total charged for shipping. |
| ||||||
Store Id Get the Store Id. |
| ||||||
Shop Total Tax Total charged for taxes. |
| ||||||
Total order CA Total order CA |
| ||||||
Total Order Number Total Order Number |
|
.svg){kind=logo}