Shopify Connector Reference
https://connectors.windsor.ai/shopify?api_key=[your API key]&date_preset=last_7d&fields=order_id,order_current_total_price,order_email,order_updated_at&_renderer=csv
The Shopify connector lets you pull Shopify data on an object level (e.g. order, contact). If you specify the fields
date_from and date_to it will filter for a date range in which the objects were created.
Sample query for order objects
https://connectors.windsor.ai/shopify?api_key=[your API key]&date_preset=last_28d&fields=order_app_id,order_sales_channel,order_name,order_note,order_tags,order_cancelled_at,order_cancel_reason,order_closed_at,order_created_at,order_count,order_currency,order_current_total_discounts,order_total_discounts,order_total_discounts_set,order_current_total_price,order_current_subtotal_price,order_current_total_tax,order_total_price,order_email,order_financial_status,order_updated_at,order_line_items,order_fulfillable_quantity,order_shipping_address
Sample query for customer objects
https://connectors.windsor.ai/shopify?api_key=[your API key]&date_preset=last_28d&fields=customer_email,customer_created_at,customer_updated_at,customer_date,customer_first_name,customer_last_name,customer_state,customer_total_spent,customer_verified_email,customer_multipass_identifier,customer_tax_exempt,customer_phone,customer_currency,customer_id,customer_last_order_id,customer_last_order_name,customer_note,customer_orders_count,customer_tags&_renderer=powerbi
The Shopify connector exposes 374 fields (90 metrics, 284 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.
Shopify Fields
Shopify abandoned_checkouts fields
The abandoned_checkouts report of the Shopify connector includes 15 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| abandoned_checkout_completed_at | Abandoned Checkout Completed At | The date and time (ISO 8601 format) when the checkout was completed, if the customer later recovered it. | |
| abandoned_checkout_created_at | Abandoned Checkout Created At | The date and time (ISO 8601 format) when the checkout was created. | |
| abandoned_checkout_currency | TEXT | Abandoned Checkout Currency | The currency of the abandoned checkout in the shop currency. |
| abandoned_checkout_customer_email | TEXT | Abandoned Checkout Customer Email | The email address of the customer associated with the checkout. |
| abandoned_checkout_customer_id | TEXT | Abandoned Checkout Customer ID | The ID of the customer associated with the abandoned checkout. |
| abandoned_checkout_id | TEXT | Abandoned Checkout ID | The unique ID of the abandoned checkout. |
| abandoned_checkout_name | TEXT | Abandoned Checkout Name | The name of the abandoned checkout (e.g. '#1234'). |
| abandoned_checkout_note | TEXT | Abandoned Checkout Note | The text of an optional note that a merchant can attach. |
| abandoned_checkout_subtotal_price | NUMERIC | Abandoned Checkout Subtotal Price | The sum of the prices of all line items before taxes and discounts. |
| abandoned_checkout_taxes_included | BOOLEAN | Abandoned Checkout Taxes Included | Whether taxes are included in the line item and shipping prices. |
| abandoned_checkout_total_discount | NUMERIC | Abandoned Checkout Total Discount | The total amount of discounts applied to the abandoned checkout. |
| abandoned_checkout_total_price | NUMERIC | Abandoned Checkout Total Price | The sum of all line item prices, discounts, shipping and taxes. |
| abandoned_checkout_total_tax | NUMERIC | Abandoned Checkout Total Tax | The total tax applied to the abandoned checkout. |
| abandoned_checkout_updated_at | Abandoned Checkout Updated At | The date and time (ISO 8601 format) when the checkout was last updated. | |
| abandoned_checkout_url | TEXT | Abandoned Checkout URL | The recovery URL that returns the customer to their checkout. |
Shopify balance_transactions fields
The balance_transactions report of the Shopify connector includes 11 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| balance_transaction_amount | NUMERIC | Balance Transaction Amount | The gross amount contributing to the balance. |
| balance_transaction_currency | TEXT | Balance Transaction Currency | The currency of the balance transaction amounts. |
| balance_transaction_date | Balance Transaction Date | The date the transaction was processed (settlement date). | |
| balance_transaction_fee | NUMERIC | Balance Transaction Fee | The processing fee for the transaction. |
| balance_transaction_id | TEXT | Balance Transaction ID | The ID of the Shopify Payments balance transaction. |
| balance_transaction_net | NUMERIC | Balance Transaction Net | The net amount contributing to the balance (amount minus fee). |
| balance_transaction_order_id | TEXT | Balance Transaction Order ID | The ID of the order associated with the transaction. |
| balance_transaction_order_name | TEXT | Balance Transaction Order Number | The name/number of the associated order (e.g. '#1001'). |
| balance_transaction_payout_id | TEXT | Balance Transaction Payout ID | The ID of the payout this transaction belongs to (null if pending). |
| balance_transaction_payout_status | TEXT | Balance Transaction Payout Status | The status of the payout this transaction belongs to. |
| balance_transaction_type | TEXT | Balance Transaction Type | The transaction category (e.g. CHARGE, REFUND, ADJUSTMENT). |
Shopify customers fields
The customers report of the Shopify connector includes 36 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| customer_aov | NUMERIC | Customer Average Order Value | Average order value is the average dollar amount customer spend each time an order is placed on your ecommerce website. |
| customer_created_at | Customer Created at (Timestamp) | The date and time (ISO 8601 format) when the customer was created. | |
| customer_currency | TEXT | Customer Currency | The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders. |
| customer_date | DATE | Customer Updated At (Date) | The date and time (ISO 8601 format) when the customer information was last updated. |
| customer_default_address | OBJECT | (Deprecated) Customer Default Address | The customer's default address. |
| customer_default_address_city | CITY | Customer Default Address City | The customer's default address city. |
| customer_default_address_country | COUNTRY | Customer Default Address Country | The customer's default address country. |
| customer_default_address_country_code | TEXT | Customer Default Address Country Code | The customer's default address country code. |
| customer_email | TEXT | Customer E-Mail Address | The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error. |
| customer_email_marketing_consent_consent_updated_at | TEXT | Customer Email Marketing Consent Updated At | The date and time at which the marketing consent was updated. No date is provided if the email address never updated its marketing consent. |
| customer_email_marketing_consent_opt_in_level | TEXT | Customer Email Marketing Consent Opt-In Level | The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the customer gave when they consented to receive marketing material by email. |
| customer_email_marketing_consent_state | TEXT | Customer Email Marketing Consent State | The current email marketing state for the customer. |
| customer_first_name | TEXT | Customer First Name | The customer's first name. |
| customer_id | TEXT | Customer ID | A unique identifier for the customer. |
| customer_is_returning | BOOLEAN | Customer Is Returning | Whether a customer is returning or new. |
| customer_last_name | TEXT | Customer Last Name | The customer's last name. |
| customer_last_order_id | TEXT | Customer Last Order ID | The ID of the customer's last order. |
| customer_last_order_name | TEXT | Customer Last Order Name | The name of the customer's last order. This is directly related to the name field on the Order resource. |
| customer_metafield_created_at | Customer Metafield Created At | The date and time (ISO 8601 format) when the metafield was created. | |
| customer_metafield_description | TEXT | Customer Metafield Description | The description of the metafield. |
| customer_metafield_id | TEXT | Customer Metafield ID | The unique ID of the metafield. |
| customer_metafield_key | TEXT | Customer Metafield Key | The unique identifier for a metafield within its namespace. |
| customer_metafield_namespace | TEXT | Customer Metafield Namespace | The container for a group of metafields that the metafield is or will be associated with. |
| customer_metafield_type | TEXT | Customer Metafield Type | The type of data that is stored in the metafield. |
| customer_metafield_updated_at | Customer Metafield Updated At | The date and time (ISO 8601 format) when the metafield was last updated. | |
| customer_metafield_value | TEXT | Customer Metafield Value | The data stored in the metafield. Always stored as a string, regardless of the metafield's type. |
| customer_multipass_identifier | NUMERIC | Customer Multipass Identifier | A unique identifier for the customer that's used with Multipass login. |
| customer_note | TEXT | Customer Note | A note about the customer. |
| customer_orders_count | NUMERIC | Customer Orders Count | The number of orders associated with this customer. |
| customer_phone | TEXT | Customer Phone Number | The unique phone number (E.164 format) for this customer. |
| customer_state | TEXT | Customer state | The state of the customer's account with a shop (Can be disabled, invited, enabled and declined) |
| customer_tags | TEXT | Customer Tags | Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. |
| customer_tax_exempt | BOOLEAN | Customer Tax Exempt | Whether the customer is exempt from paying taxes on their order. If true, then taxes won't be applied to an order at checkout. If false, then taxes will be applied at checkout. |
| customer_total_spent | NUMERIC | Customer Total Spent | The total amount of money that the customer has spent across their order history. |
| customer_updated_at | Customer Updated at (Timestamp) | The date and time (ISO 8601 format) when the customer information was last updated. | |
| customer_verified_email | BOOLEAN | Customer Email Verified | Whether the customer has verified their email address. |
Shopify marketing_events fields
The marketing_events report of the Shopify connector includes 19 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| breadcrumb_id | TEXT | (Deprecated) Marketing Event Breadcrumb ID | The breadcrumb ID of the event. |
| budget_type | TEXT | Marketing Event Budget Type | The budget type of the event. |
| ended_at | Marketing Ended At | The event end datetime. | |
| event_type | TEXT | Marketing Event Type | The event type. |
| manage_url | TEXT | Marketing Event Manage URL | The manage URL of the event. |
| marketing_activity_id | TEXT | Marketing Event Activity ID | The activity ID of the event. |
| marketing_channel | TEXT | Marketing Event Channel | The markerting channel of the event. |
| marketing_event_budget | NUMERIC | Marketing Event Budget | The budget of the event. |
| marketing_event_currency | TEXT | Marketing Event Currency | The currency of the event. |
| marketing_event_description | TEXT | Marketing Event Description | The event description. |
| marketing_event_paid | BOOLEAN | (Deprecated) Marketing Event Paid | The flag that indicates if an event is paid. |
| preview_url | TEXT | Marketing Event Preview URL | The preview URL of the event. |
| referring_domain | TEXT | (Deprecated) Marketing Event Referring Domain | The referring domain of the event. |
| remote_id | TEXT | Marketing Remote ID | The remote id. |
| scheduled_to_end_at | Marketing Event Scheduled To End At | The scheduled end date of the event. | |
| started_at | Marketing Started At | The event start datetime. | |
| utm_campaign | TEXT | Marketing Event UTM Campaign | The UTM campaign of the event. |
| utm_medium | TEXT | Marketing Event UTM Medium | The UTM medium of the event. |
| utm_source | TEXT | Marketing Event UTM Source | The UTM source of the event. |
Shopify orders fields
The orders report of the Shopify connector includes 234 fields.
Shopify orders fields (email to line_item__variant_display_name)
| ID | Type | Name | Description |
|---|---|---|---|
| TEXT | Order Email | The customers email address. | |
| line_item__discount_allocations | TEXT | Line Item Discount Allocations | An ordered list of amounts allocated by discount applications. Eachdiscount allocation is associated with a particular discount application.amount: The discount amount allocated to the line in the shop currency.discount_application_index: The index of the associated discount application in the order'sdiscount_applications list.amount_set: The discount amount allocated to the line item in shop and presentmentcurrencies. |
| line_item__discount_allocations_obj | OBJECT | Line Item Discount Allocations Object | An ordered list of amounts allocated by discount applications. Same data as line_item__discount_allocations but returned as an object instead of text. |
| line_item__discounted_unit_price | NUMERIC | Line Item Discounted Unit Price | The unit price of the line item in the shop currency after all discounts (line-level, order-level and discount-code) are applied, before taxes. |
| line_item__duties | TEXT | Line Item Duties | A list of duty objects, each containing information about a duty on the line item. |
| line_item__fulfillable_quantity | NUMERIC | (Deprecated) Line Item Fulfillable Quantity | Deprecated. Please use 'Line Item Non Fulfillable Quantity' instead. |
| line_item__fulfillment_status | TEXT | (Deprecated) Line Item Fulfillment Status | Deprecated. Please use 'Order Fulfillment Status' instead. |
| line_item__gift_card | BOOLEAN | Line Item Gift Card | Whether the line item represents the purchase of a gift card. |
| line_item__grams | NUMERIC | Line Item Grams | The weight of the item in grams. |
| line_item__id | TEXT | Line Item Id | The ID of the line item. |
| line_item__name | TEXT | Line Item Product Name | The name of the product. |
| line_item__net_sales | NUMERIC | Line Item Net Sales | Net sales for the line item in the shop currency: the discounted line total (unit price times quantity minus line-level discounts), before taxes. Excludes order-level and discount-code discounts and is not reduced by returns/refunds, which are reported as separate order rows. Added to line_item__total_discount it equals the line's original (gross) total. |
| line_item__non_fulfillable_quantity | NUMERIC | Line Item Non Fulfillable Quantity | The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. |
| line_item__price | NUMERIC | Line Item Price | The price of the item before discounts have been applied in the shop currency. |
| line_item__product_category | TEXT | Line Item Product Category | The name of the standard product taxonomy category of the product that the line item belongs to. |
| line_item__product_id | TEXT | Line Item Product Id | The ID of the product that the line item belongs to. Can be null ifthe original product associated with the order is deleted at a later date. |
| line_item__product_price | NUMERIC | Line Item Product Highest Variant's Price | The highest product variant price of this line item. |
| line_item__properties | TEXT | Line Item Properties | An array of custom information for the item that has been added to the cart. Often used to provide product customization options. |
| line_item__quantity | NUMERIC | Line Item Quantity | The number of items that were purchased. |
| line_item__refundable_quantity | NUMERIC | Line Item Refundable Quantity | The line item's quantity, minus the refunded quantity. |
| line_item__refunds | TEXT | Line Item Refunds | A list of refund objects |
| line_item__refunds_ids | TEXT | Line Item Refunds IDs | Comma-separated ids of the refunds that include this line item. The ids match the ones returned by the Order Refunds field. |
| line_item__refunds_price | NUMERIC | Line Item Refunds Price | The price of a refunded line item in shop currency over all refunds. |
| line_item__refunds_quantity | NUMERIC | Line Item Refunds Quantity | The quantity of a refunded line item over all refunds. |
| line_item__refunds_subtotal | NUMERIC | Line Item Refunds Subtotal | The subtotal price of a refunded line item in shop currency over all refunds. |
| line_item__refunds_total_tax | NUMERIC | Line Item Refunds Total Tax | The total tax charged on a refunded line item in shop currency over all refunds. |
| line_item__requires_shipping | TEXT | Line Item Requires Shipping | Whether the item requires shipping. |
| line_item__sku | TEXT | Line Item SKU | The item's SKU (stock keeping unit). |
| line_item__tax_lines | TEXT | Line Item Tax Lines | A list of tax line objects, each of which details a tax applied to the item.title: The name of the tax.price: The amount added to the order for this tax in the shop currency.price_set: The amount added to the order for this tax in shop and presentment currencies.rate: The tax rate applied to the order to calculate the tax price.channel_liable: Whether the channel that submitted the tax line is liable for remitting. Avalue of null indicates unknown liability for the tax line. |
| line_item__tax_lines_obj | OBJECT | Line Item Tax Lines Object | A list of tax line objects, each of which details a tax applied to the item. Same data as line_item__tax_lines but returned as an object instead of text. |
| line_item__taxable | TEXT | Line Item Taxable | Whether the item was taxable. |
| line_item__tip_payment_gateway | TEXT | Line Item Tip Payment Gateway | The payment gateway used to tender the tip, such as shopify_payments. Present only on tips. |
| line_item__title | TEXT | Line Item Title | The title of the product. |
| line_item__total_discount | NUMERIC | Line Item Total Discount Set | The total amount allocated to the line item in the shop currency. Instead of using this field, Shopify recommends using discount_allocations, which provides the sameinformation. |
| line_item__unfulfilled_quantity | NUMERIC | Line Item Unfulfilled Quantity | The number of units not yet fulfilled. |
| line_item__variant_available_for_sale | BOOLEAN | Line Item Product Variant Available For Sale | Whether the product variant is available for sale. |
| line_item__variant_barcode | TEXT | Line Item Product Variant Barcode | The value of the barcode associated with the product. |
| line_item__variant_compare_at_price | NUMERIC | Line Item Product Variant Compare At Price | The compare-at price of the variant in the default shop currency. |
| line_item__variant_created_at | Line Item Product Variant Created At Datetime | The date and time when the variant was created. | |
| line_item__variant_display_name | TEXT | Line Item Product Variant Display Name | Display name of the variant, based on product's title + variant's title. |
Shopify orders fields (line_item__variant_id to order_confirmed)
| ID | Type | Name | Description |
|---|---|---|---|
| line_item__variant_id | TEXT | Line Item Variant ID | The ID of the product variant. |
| line_item__variant_inventory_quantity | NUMERIC | Line Item Product Variant Inventory Quantity | The total sellable quantity of the variant. |
| line_item__variant_metafield_created_at | Line Item Product Variant Metafield Created At | The date and time (ISO 8601 format) when the metafield was last updated. | |
| line_item__variant_metafield_description | TEXT | Line Item Product Variant Metafield Description | The description of the metafield. |
| line_item__variant_metafield_key | TEXT | Line Item Product Variant Metafield Key | The unique identifier for a metafield within its namespace. |
| line_item__variant_metafield_type | TEXT | Line Item Product Variant Metafield Type | The type of data that is stored in the metafield. |
| line_item__variant_metafield_update_at | Line Item Product Variant Metafield Updated At | The type of resource that the metafield is attached to. | |
| line_item__variant_metafield_value | TEXT | Line Item Product Variant Metafield Value | The data stored in the metafield. Always stored as a string, regardless of the metafield's type. |
| line_item__variant_price | NUMERIC | Line Item Product Variant Price | The price of the product variant in the default shop currency. |
| line_item__variant_sellable_online_quantity | NUMERIC | Line Item Product Variant Sellable Online Quantity | The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture limitations based on customer location. |
| line_item__variant_selling_plan_group_count | NUMERIC | Line Item Product Variant Selling Plan Group Count | Count of selling plan groups associated with the product variant. |
| line_item__variant_tax_code | TEXT | (Deprecated) Line Item Product Variant Tax Code | Avalara tax code for the product variant. Applies only to the stores that have the Avalara AvaTax app installed. |
| line_item__variant_title | TEXT | Line Item Variant Title | The title of the product variant. |
| line_item__variant_unit_cost | NUMERIC | Line Item Product Variant Unit Cost | Unit cost associated with the inventory item. Note: the user must have 'View product costs' permission granted in order to access this field once product granular permissions are enabled. |
| line_item__variant_unit_cost_currency | TEXT | Line Item Product Variant Unit Cost Currency | Currency of the money for unit cost associated with the inventory item. |
| line_item__variant_updated_at | Line Item Product Variant Updated At | The date and time (ISO 8601 format) when the product variant was last modified. | |
| line_item__variant_weight | NUMERIC | Line Item Product Variant Weight | The weight of the product variant in the unit system specified with weight_unit. |
| line_item__variant_weight_unit | TEXT | Line Item Product Variant Weight Unit (weight_unit) | The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: g, kg, oz, lb. |
| line_item__vendor | TEXT | Line Item Vendor | The name of the item's supplier. |
| order_adjusted_discounts | NUMERIC | Order Adjusted Discounts | The total product-level discounts for the order, calculated on the product price before taxes, in shop currency. |
| order_app_id | TEXT | Order App ID | The id of the application. |
| order_app_name | TEXT | Order App name | The name of the application. |
| order_billing_address | TEXT | Order Billing Address | The orders billing address. |
| order_billing_address_city | CITY | Order Billing Address City | The orders billing address city. |
| order_billing_address_country | COUNTRY | Order Billing Address Country | The orders billing address country. |
| order_billing_address_province | TEXT | Order Billing Address Province | The orders billing address province. |
| order_billing_matches_shipping | BOOLEAN | Order Billing Address Matches Shipping Address | Whether the billing address matches the shipping address. |
| order_can_mark_as_paid | BOOLEAN | Order Can Mark As Paid | Whether the order can be manually marked as paid. |
| order_can_notify_customer | BOOLEAN | Order Can Notify Customer | Whether a customer email exists for the order. |
| order_cancel_reason | TEXT | Order Cancel Reason | The reason why the order was canceled. |
| order_cancellation_staff_note | TEXT | Order Cancellation Staff Note | Staff provided note for the order cancellation. |
| order_cancelled_at | Order Cancelled At | The date and time ( ISO 8601 format) when the order was canceled. | |
| order_capturable | BOOLEAN | Order Capturable | Whether payment for the order can be captured. |
| order_cart_discount_amount_presentment | NUMERIC | Order Cart Discount Amount (Presentment Currency) | The order-level discount amount in the customer's presentment currency, before returns and refunds. |
| order_channel_handle | TEXT | Order Channel Handle | Unique string used as a public identifier for the channel definition associated with the channel that created the order. |
| order_client_ip | TEXT | Order Client IP | The IP address of the API client that created the order. |
| order_closed | BOOLEAN | Order Closed | Whether the order is closed. |
| order_closed_at | Order Closed At | The date and time (ISO 8601 format) when the order was closed. | |
| order_confirmation_number | TEXT | Order Confirmation Number | A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. |
| order_confirmed | TEXT | Order Confirmed | Whether inventory has been reserved for the order. |
Shopify orders fields (order_cost_of_goods_sold to order_email)
| ID | Type | Name | Description |
|---|---|---|---|
| order_cost_of_goods_sold | NUMERIC | Order Cost of Goods Sold | The total cost of goods sold for the order, calculated as the sum of line item quantity multiplied by inventory item unit cost (Shopify cost per item). Note: the user must have 'View product costs' permission granted in order to access this field once product granular permissions are enabled. |
| order_count | NUMERIC | Order Count | The number of orders. Default value is 1, but for refunds, the value is zero. This value is displayed in Analytics Sales report. Aggregates by sum, so a daily query returns the number of orders per day. |
| order_created_at | Order Created At | The autogenerated date and time (ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed. | |
| order_currency | TEXT | Order Currency | The three-letter code (ISO 4217 format) for the shop currency. |
| order_current_cart_discount_amount_presentment | NUMERIC | Order Current Cart Discount Amount (Presentment Currency) | The current order-level discount amount in the customer's presentment currency, after returns and refunds. |
| order_current_discount_cart | NUMERIC | Order Current Discount Cart | The current order-level discount amount after all order updates, in shop currency. |
| order_current_shipping_price | NUMERIC | Order Current Shipping Price | The current shipping price after applying refunds and discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. Otherwise, this field is the pre-tax price. |
| order_current_shipping_price_presentment | NUMERIC | Order Current Shipping Price (Presentment Currency) | The current shipping price after refunds and discounts in the customer's presentment currency. |
| order_current_subtotal_line_items_quantity | NUMERIC | Order Current Subtotal Line Items Quantity | The current order-level discount amount after all order updates, in shop currency. |
| order_current_subtotal_price | NUMERIC | Order Current Subtotal Price | The current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds. |
| order_current_subtotal_price_presentment | NUMERIC | Order Current Subtotal Price (Presentment Currency) | The current subtotal price of the order in the customer's presentment currency. Reflects order edits, returns, and refunds. |
| order_current_total_additional_fees_amount | NUMERIC | Order Current Total Additional Fees Amount | The total amount of additional fees after returns, in shop currency. |
| order_current_total_additional_fees_presentment | NUMERIC | Order Current Total Additional Fees (Presentment Currency) | The current total additional fees on the order in the customer's presentment currency. |
| order_current_total_discounts | NUMERIC | Order Current Total Discounts | The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds. |
| order_current_total_discounts_presentment | NUMERIC | Order Current Total Discounts (Presentment Currency) | The current total discounts on the order in the customer's presentment currency. Reflects order edits, returns, and refunds. |
| order_current_total_duties_amount | NUMERIC | Order Current Total Duties Amount | The total amount of duties after returns, in shop currency. |
| order_current_total_duties_presentment | NUMERIC | Order Current Total Duties (Presentment Currency) | The current total duties charged on the order in the customer's presentment currency. |
| order_current_total_price | NUMERIC | Order Current Total Price (A duplicate of `order_total_price`) | The current total price of the order, after returns.This includes taxes and discounts.refunds. |
| order_current_total_price_presentment | NUMERIC | Order Current Total Price (Presentment Currency) | The current total price of the order, after returns, in the buyer's presentment currency. The presentment twin of `order_current_total_price`. |
| order_current_total_tax | NUMERIC | Order Current Total Tax | The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds. |
| order_current_total_tax_presentment | NUMERIC | Order Current Total Tax (Presentment Currency) | The current total taxes charged on the order in the customer's presentment currency. Reflects order edits, returns, or refunds. |
| order_current_total_weight | NUMERIC | Order Current Total Weight | The total weight of the order after returns, in grams. |
| order_custom_attributes | TEXT | Order Custom Attributes (Note Attributes) | Additional custom fields (note attributes) attached to the order at checkout, as a semicolon-separated list of key=value pairs. |
| order_customer_accepts_marketing | BOOLEAN | Order Customer Accepts Marketing | Whether the customer agreed to receive marketing materials. |
| order_customer_has_multiple_orders | BOOLEAN | Order Customer Has Multiple Orders | Whether the customer has multiple orders.This value is based on amount of orders customer made at the time of the request. |
| order_customer_id | TEXT | Order Customer ID | The ID of the customer that placed the order. |
| order_customer_last_visit_landing_page | TEXT | Order Customer Last Visit Landing Page | URL of the first page the customer landed on for the session. |
| order_customer_last_visit_referral_code | TEXT | Order Customer Last Visit Referral Code | Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. |
| order_customer_last_visit_referrer_url | TEXT | Order Customer Last Visit Referrer URL | Webpage where the customer clicked a link that sent them to the online store. For example, https://randomblog.com/page1 or android-app://com.google.android.gm. |
| order_customer_last_visit_source | TEXT | Order Customer Last Visit Source | Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown. |
| order_customer_last_visit_utm_campaign | TEXT | Order Customer Last Visit UTM Campaign | The name of a marketing campaign gathered from the last customer visit (session) before an order is made. |
| order_customer_last_visit_utm_content | TEXT | Order Customer Last Visit UTM Content | The name of a marketing content gathered from the last customer visit (session) before an order is made. |
| order_customer_last_visit_utm_medium | TEXT | Order Customer Last Visit UTM Medium | The name of a marketing medium gathered from the last customer visit (session) before an order is made. |
| order_customer_last_visit_utm_source | TEXT | Order Customer Last Visit UTM Source | The name of a marketing source gathered from the last customer visit (session) before an order is made. |
| order_customer_last_visit_utm_term | TEXT | Order Customer Last Visit UTM Term | The name of a marketing term gathered from the last customer visit (session) before an order is made. |
| order_customer_number_of_orders | NUMERIC | Order Customer Number Of Orders | The number of orders that the customer has made at the store in their lifetime. |
| order_discount_code | TEXT | Order Discount Code | The discount code used for the order. |
| order_discount_codes | TEXT | Order Discount Codes | The discount codes used for the order. |
| order_edited | BOOLEAN | Order Edited | Whether the order has had any edits applied. |
| order_email | TEXT | Order Email | The customers email address. |
Shopify orders fields (order_estimated_taxes to order_payment_gateways)
| ID | Type | Name | Description |
|---|---|---|---|
| order_estimated_taxes | BOOLEAN | Order Estimated Taxes | Whether taxes on the order are estimated. This field returns false when taxes on the order are finalized and aren't subject to any changes. |
| order_financial_status | TEXT | Order Payment Status | The status of payments associated with the order. Can only be set when the order is created. |
| order_fulfillable | BOOLEAN | Order Fulfillable | Whether there are line items that can be fulfilled. This field returns false when the order has no fulfillable line items. |
| order_fulfillable_quantity | NUMERIC | (Deprecated) Order Fullfillable Quantity | Deprecated. Please use 'Line Item Non Fulfillable Quantity' instead. |
| order_fulfillment_created_first_date | Order Fulfillment Created First Date | Created date of the first successful order fulfullment. | |
| order_fulfillment_created_last_date | Order Fulfillment Created Last Date | Created date of the last successful order fulfullment. | |
| order_fulfillment_delivered_first_date | Order Fulfillment Delivered First Date | Delivered date of the first successful order fulfullment. | |
| order_fulfillment_delivered_last_date | Order Fulfillment Delivered Last Date | Delivered date of the last successful order fulfullment. | |
| order_fulfillment_service | TEXT | Order Fulfillment Service | The order fulfillment service. |
| order_fulfillment_status | TEXT | Order Fulfillment Status | The fulfillment status for the order that can be shown to the merchant. This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. |
| order_fulfillment_updated_first_date | Order Fulfillment Updated First Date | Updated date of the first successful order fulfullment. | |
| order_fulfillment_updated_last_date | Order Fulfillment Updated Last Date | Updated date of the last successful order fulfullment. | |
| order_fully_paid | BOOLEAN | Order Fully Paid | Whether the order has been paid in full. |
| order_fx_rate | NUMERIC | Order FX Rate | The implied foreign-exchange rate applied to the order, derived as the current total price in presentment currency divided by the same amount in shop currency. Empty when the shop amount is zero. |
| order_gross_sales | NUMERIC | Order Gross Sales | The order gross sales (before taxes, shipping, discounts, and returns). Pending and unpaid orders are included. Test, canceled, and deleted orders aren't included. |
| order_has_timeline_comment | BOOLEAN | Order Has Timeline Comment | Whether the merchant added a timeline comment to the order. |
| order_id | TEXT | Order ID | The unique identifier of the order |
| order_line_items | OBJECT | Order Line Items | The line items of the order. |
| order_merchant_editable | BOOLEAN | Order Merchant Editable | Whether the order can be edited by the merchant. For example, canceled orders can’t be edited. |
| order_merchant_editable_errors | TEXT | Order Merchant Editable Errors | A list of reasons why the order can't be edited. For example, `Canceled orders can't be edited`. |
| order_metafield_created_at | Order Metafield Created At | The date and time (ISO 8601 format) when the metafield was created. | |
| order_metafield_description | TEXT | Order Metafield Description | The description of the metafield. |
| order_metafield_id | TEXT | Order Metafield ID | The unique ID of the metafield. |
| order_metafield_key | TEXT | Order Metafield Key | The unique identifier for a metafield within its namespace. |
| order_metafield_namespace | TEXT | Order Metafield Namespace | The container for a group of metafields that the metafield is or will be associated with. |
| order_metafield_type | TEXT | Order Metafield Type | The type of data that is stored in the metafield. |
| order_metafield_updated_at | Order Metafield Updated At | The date and time (ISO 8601 format) when the metafield was last updated. | |
| order_metafield_value | TEXT | Order Metafield Value | The data stored in the metafield. Always stored as a string, regardless of the metafield's type. |
| order_name | TEXT | Order name | The name of the order |
| order_net_payment | NUMERIC | Order Net Payment | The net payment for the order, based on the total amount received minus the total amount refunded. |
| order_net_sales | NUMERIC | Order Net Sales | The order net sales. Equates to gross sales - discounts - returns. Pending and unpaid orders are included. Test, canceled, and deleted orders aren't included. |
| order_new_or_returning_customer | TEXT | Order New or Returning Customer | Whether the customer was new or returning at the time of the order, based on the number of orders the customer had placed: 'new' for their first order, 'returning' otherwise. |
| order_note | TEXT | Order note | An optional note that a shop owner can attach to the order. |
| order_original_price | NUMERIC | Order Original Price | The total price of the order at the time of order creation. |
| order_original_price_presentment | NUMERIC | Order Original Price (Presentment Currency) | The total price of the order at creation in the customer's presentment currency. |
| order_original_total_additional_fees_amount | NUMERIC | Order Original Total Additional Fees Amount | The total amount of additional fees at the time of order creation. |
| order_original_total_additional_fees_presentment | NUMERIC | Order Original Total Additional Fees (Presentment Currency) | The total additional fees on the order at creation in the customer's presentment currency. |
| order_original_total_duties_amount | NUMERIC | Order Original Total Duties Amount | The total amount of duties before returns, in shop currency. |
| order_original_total_duties_presentment | NUMERIC | Order Original Total Duties (Presentment Currency) | The total duties charged on the order at creation in the customer's presentment currency. |
| order_payment_gateways | TEXT | Order Payment Methods (Gateways) | A list of the names of all payment gateways used for the order. |
Shopify orders fields (order_payment_references to order_shipping_line_title)
| ID | Type | Name | Description |
|---|---|---|---|
| order_payment_references | TEXT | Order Payment References | The payment references sent to the payment gateways for the order's transactions, comma-separated. Includes captures, refunds and failed payment attempts. |
| order_po_number | TEXT | Order PO Number | The PO number associated with the order. |
| order_presentment_currency | TEXT | Order Presentment Currency | The three-letter code (ISO 4217 format) for the currency the buyer used when placing the order. Together with the shop currency and a presentment amount it yields the FX rate applied to the order. |
| order_processed_at | Order Processed At | The date and time when the order was processed. | |
| order_product_price | NUMERIC | Line Item Product Price | The product price of this line item. |
| order_quantity | NUMERIC | Order Items Quantity | The sum of the quantities for all line items that contribute to the order's current subtotal price. |
| order_refund_discrepancy_amount | NUMERIC | Order Refund Discrepancy Amount | The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor. |
| order_refund_discrepancy_amount_presentment | NUMERIC | Order Refund Discrepancy Amount (Presentment Currency) | The difference between the refunded amount and the returned amount, in the customer's presentment currency. |
| order_refund_note | TEXT | Order Refund Note | The notes (reasons) attached to the order's refunds, semicolon-separated when there is more than one refund. |
| order_refundable | BOOLEAN | Order Refundable | Whether the order can be refunded. |
| order_refunds | TEXT | Order Refunds | Id of refund assigned to the order. |
| order_refunds_net | NUMERIC | Aggregated Order Refunds Net | (Equates to order_gross_sales - order_total_discounts - order_net_sales). |
| order_refunds_quantity | NUMERIC | Order refunded items quantity | Total quantity of refunded items. |
| order_refunds_subtotal | NUMERIC | Order Refunds total | The order total refunds. |
| order_refunds_total_tax | NUMERIC | Aggregated Order Refunds Total Tax | The total tax on the refund line items. |
| order_registered_source_url | TEXT | Order Registered Source URL | The URL of the source that the order originated from, if found in the domain registry. |
| order_requires_shipping | BOOLEAN | Order Requires Shipping | Whether the order has shipping lines or at least one line item on the order that requires shipping. |
| order_restockable | BOOLEAN | Order Restockable | Whether any line item on the order can be restocked. |
| order_retail_location_name | TEXT | Order Retail Location Name | The name of the physical location where a retail order is created or completed. |
| order_return_status | TEXT | Order Return Status | The order's aggregated return status for display purposes. |
| order_returns_amount | NUMERIC | Order returned items value | The order total returned items value. |
| order_returns_quantity | NUMERIC | Order returned items quantity | The order total returned items quantity. |
| order_sales_channel | TEXT | Order Sales Channel (A duplicate of `order_app_name`) | The name of the application. |
| order_shipping_address | TEXT | Order Shipping Address | The orders shipping address. |
| order_shipping_address_city | CITY | Order Shipping Address City | The orders shipping address city. |
| order_shipping_address_country | COUNTRY | Order Shipping Address Country | The orders shipping address country. |
| order_shipping_address_province | TEXT | Order Shipping Address Province | The orders shipping address province. |
| order_shipping_address_zip | TEXT | Order Shipping Address Zip | The orders shipping address zip or postal code. |
| order_shipping_line_amount | NUMERIC | Order Shipping Line Amount | The pre-tax shipping price without any discounts applied, in shop currency. |
| order_shipping_line_carrier_identifier | TEXT | Order Shipping Line Carrier Identifier | A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. |
| order_shipping_line_code | TEXT | Order Shipping Line Code | A reference to the shipping method. |
| order_shipping_line_delivery_category | TEXT | Order Shipping Line Delivery Category | The general classification of the delivery method. |
| order_shipping_line_discounted_amount | NUMERIC | Order Shipping Line Discounted Amount | The shipping price after applying discounts, in shop currency. If the order_taxes_included field is true, then this price includes taxes. If not, it's the pre-tax price. |
| order_shipping_line_id | TEXT | Order Shipping Line ID | A globally-unique ID for this shipping line. |
| order_shipping_line_is_custom | BOOLEAN | Order Shipping Line Is Custom | Whether the shipping line is custom or not. |
| order_shipping_line_is_removed | BOOLEAN | Order Shipping Line Is Removed | Whether the shipping line has been removed. |
| order_shipping_line_phone | TEXT | Order Shipping Line Phone | The phone number at the shipping address. |
| order_shipping_line_shipping_rate_handle | TEXT | Order Shipping Line Shipping Rate Handle | A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users. |
| order_shipping_line_source | TEXT | Order Shipping Line Source | The rate source for this shipping line. |
| order_shipping_line_title | TEXT | Order Shipping Line Title | The title of this shipping line. |
Shopify orders fields (order_shipping_net_price to variant_title)
| ID | Type | Name | Description |
|---|---|---|---|
| order_shipping_net_price | NUMERIC | Order Shipping Price (with taxes) | The shipping price without taxes, in shop currency. |
| order_shipping_price | NUMERIC | Order Shipping Price | The pre-tax shipping price without any discounts applied, in shop currency. |
| order_shipping_tax | NUMERIC | Order Shipping Tax | The pre-tax shipping price without any discounts applied, in shop currency. |
| order_source_identifier | TEXT | Order Source Identifier | A unique POS or third party order identifier. |
| order_source_name | TEXT | Order Source Name | The name of the source (sales channel or POS) where the order originated, for example 'web', 'pos', or an app handle. |
| order_subtotal_price | NUMERIC | Order Subtotal Price | The sum of the prices for all line items after discounts and before returns, in shop currency. If order_taxes_included is true, then the subtotal also includes tax. |
| order_subtotal_price_presentment | NUMERIC | Order Subtotal Price (Presentment Currency) | The sum of line item prices after discounts and before returns, in the customer's presentment currency. |
| order_tags | TEXT | Order tags | Tags attached to the order |
| order_tax_exempt | BOOLEAN | Order Tax Exempt | Whether taxes are exempt on the order. |
| order_taxes_included | BOOLEAN | Order Taxes Included | Whether taxes are included in the subtotal price of the order. |
| order_test | BOOLEAN | Order Is Test | Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. |
| order_total_capturable_amount | NUMERIC | Order Total Capturable Amount | The authorized amount that's uncaptured or undercaptured, in shop currency. This amount isn't adjusted for returns. |
| order_total_capturable_presentment | NUMERIC | Order Total Capturable (Presentment Currency) | The total amount that can be captured on the order in the customer's presentment currency. |
| order_total_count | NUMERIC | Total Placed Order Count | The number of all placed orders (including orders with refunds). This value is displayed in Orders report. |
| order_total_discount_cart | NUMERIC | Order Total Discount Cart | The total order-level discount amount, before returns, in shop currency. |
| order_total_discounts | NUMERIC | Order Total Discounts | The total discounts applied to the price of the order in the shop currency. |
| order_total_discounts_presentment | NUMERIC | Order Total Discounts (Presentment Currency) | The total discounts applied to the price of the order in the customer's presentment currency. |
| order_total_discounts_set | NUMERIC | Order Total Discounts Set | The total discounts applied to the price of the order in shop currency. This includes both order and line level discounts. |
| order_total_outstanding_amount | NUMERIC | Order Total Outstanding Amount | The total amount not yet transacted for the order, in shop currency. A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer). |
| order_total_outstanding_presentment | NUMERIC | Order Total Outstanding (Presentment Currency) | The total outstanding (unpaid) amount on the order in the customer's presentment currency. |
| order_total_price | NUMERIC | Order Total Price | The current total price of the order, after returns.This includes taxes and discounts. |
| order_total_price_amount | NUMERIC | Order Total Price Amount | The total price of the order, before returns.This includes taxes and discounts. |
| order_total_price_presentment | NUMERIC | Order Total Price (Presentment Currency) | The total price of the order, before returns, in the customer's presentment currency. Includes taxes and discounts. |
| order_total_shipping_price | NUMERIC | Order Total Shipping Price | The total shipping amount before discounts and returns, in the shop currency. |
| order_total_shipping_price_presentment | NUMERIC | Order Total Shipping Price (Presentment Currency) | The total shipping amount before discounts and returns in the customer's presentment currency. |
| order_total_shipping_refunded_price | NUMERIC | Order Total Shipping Refunded Price | The total amount of shipping that was refunded, in the shop currency. |
| order_total_shipping_refunded_price_presentment | NUMERIC | Order Total Shipping Refunded Price (Presentment Currency) | The total amount of shipping that was refunded in the customer's presentment currency. |
| order_total_tax_amount | NUMERIC | Order Total Tax Amount | The total tax amount before returns, in shop currency. |
| order_total_tax_presentment | NUMERIC | Order Total Tax (Presentment Currency) | The total taxes charged on the order in the customer's presentment currency. |
| order_unpaid | BOOLEAN | Order Unpaid | Whether no payments have been made for the order. |
| order_updated_at | Order Updated At | The date and time (ISO 8601 format) when the order was last modified. | |
| order_user_id | TEXT | Order User ID | The ID of the user logged into Shopify POS who processed the order, if applicable. |
| sku | TEXT | Variant SKU number | The product variant SKU number. |
| variant_title | TEXT | Variant Title | The title of the product variant. |
Shopify payouts fields
The payouts report of the Shopify connector includes 5 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| payout_amount | NUMERIC | Payout Amount | The net amount of the payout in the payout currency. |
| payout_currency | TEXT | Payout Currency | The currency of the payout amount. |
| payout_date | Payout Date | The date the payout was issued (funds settled to the bank). | |
| payout_id | TEXT | Shopify Payout ID | The ID of the Shopify Payments payout (bank settlement). |
| payout_status | TEXT | Shopify Payout Status | The transfer status of the payout (e.g. PAID, SCHEDULED). |
Shopify products fields
The products report of the Shopify connector includes 75 fields.
Shopify products fields (product_created_at_datetime to product_variant_inventory_item_id)
| ID | Type | Name | Description |
|---|---|---|---|
| product_created_at_datetime | Product Created At Datetime | The date and time the product was created. | |
| product_description | TEXT | Product Description | Description of the product. |
| product_handle | TEXT | Product handle | The product handle. |
| product_id | TEXT | Product ID | Unique identifier for the product. |
| product_image_src | IMAGE_URL | Product Image URL | The image URL of the product. |
| product_inventory_quantity | NUMERIC | Product Inventory Quantity | The product quantity in inventory. |
| product_inventory_value | NUMERIC | Product Inventory Value | The sell value of the product inventory. |
| product_metafield_created_at | Product Metafield Created At | The date and time (ISO 8601 format) when the metafield was last updated. | |
| product_metafield_description | TEXT | Product Metafield Description | The description of the metafield. |
| product_metafield_id | TEXT | Product Metafield ID | The unique ID of the metafield. |
| product_metafield_key | TEXT | Product Metafield Key | The unique identifier for a metafield within its namespace. |
| product_metafield_namespace | TEXT | Product Metafield Namespace | The container for a group of metafields that the metafield is or will be associated with. |
| product_metafield_owner_id | TEXT | Product Metafield Owner ID | The unique ID of the resource that the metafield is attached to. |
| product_metafield_owner_resource | TEXT | Product Metafield Owner Resource | The type of resource that the metafield is attached to. |
| product_metafield_type | TEXT | Product Metafield Type | The type of data that is stored in the metafield. |
| product_metafield_update_at | Product Metafield Updated At | The type of resource that the metafield is attached to. | |
| product_metafield_value | TEXT | Product Metafield Value | The data stored in the metafield. Always stored as a string, regardless of the metafield's type. |
| product_price | NUMERIC | Product Price | The price of the product. |
| product_published_at | Product published at datetime | The date and time (ISO 8601 format) when the product was published. Can be null if unpublished. | |
| product_published_scope | TEXT | (Deprecated) Product published scope | (Deprecated) No longer available via the Shopify API for this app; always null. Previously indicated whether the product was published to the Point of Sale channel (global) or web only. |
| product_status | TEXT | Product status | The status of the product (active/archived/draft). |
| product_tags | TEXT | Product Tags | Tags attached to the product. |
| product_template_suffix | TEXT | Product Template Suffix | The suffix of the Liquid template used for the product page. |
| product_title | TEXT | Product Title | The title of the product. |
| product_type | TEXT | Product Type | The type of the product. |
| product_updated_at_datetime | Product Updates At Datetime | The date and time when the product was last modified. | |
| product_variant_barcode | TEXT | Product Variant Barcode | The barcode, UPC, or ISBN number for the product. |
| product_variant_compare_at_price | TEXT | Product Variant Compare At Price | The original price of the item before an adjustment or a sale. |
| product_variant_created_at | Product Variant Created At | The date and time (ISO 8601 format) when the product variant was created. | |
| product_variant_grams | NUMERIC | (Deprecated) Product Variant Grams | The weight of the product variant in grams. |
| product_variant_id | TEXT | Product Variant ID | The unique numeric identifier for the product variant. |
| product_variant_inventory_available_quantity | NUMERIC | Product Variant Available Quantity At Location | Units that can be sold at this location. Current stock, not historical. |
| product_variant_inventory_committed_quantity | NUMERIC | Product Variant Committed Quantity At Location | Units part of placed orders but not yet fulfilled at this location. Current stock, not historical. |
| product_variant_inventory_damaged_quantity | NUMERIC | Product Variant Damaged Quantity At Location | On hand units not sellable due to damage at this location. Current stock, not historical. |
| product_variant_inventory_incoming_quantity | NUMERIC | Product Variant Incoming Quantity At Location | Units on their way to this location. Current stock, not historical. |
| product_variant_inventory_item_cost | NUMERIC | Product Variant Inventory Item Cost | Unit cost associated with the inventory item. Note: the user must have 'View product costs' permission granted in order to access this field once product granular permissions are enabled. |
| product_variant_inventory_item_country_code_of_origin | TEXT | Product Variant Inventory Item Country Code Of Origin | The ISO 3166-1 alpha-2 country code of where the item originated from. |
| product_variant_inventory_item_created_at | TEXT | Product Variant Inventory Item Created At | The date and time when the inventory item was created. |
| product_variant_inventory_item_harmonized_system_code | TEXT | Product Variant Inventory Item harmonized System Code | The harmonized system code of the item. |
| product_variant_inventory_item_id | TEXT | Product Variant Inventory Item ID | The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information. |
Shopify products fields (product_variant_inventory_item_province_code_of_origin to product_vendor)
| ID | Type | Name | Description |
|---|---|---|---|
| product_variant_inventory_item_province_code_of_origin | TEXT | Product Variant Inventory Item Province Code Of Origin | The ISO 3166-2 alpha-2 province code of where the item originated from. |
| product_variant_inventory_item_province_tracked | TEXT | Product Variant Inventory Item Tracked | Whether inventory levels are tracked for the item. |
| product_variant_inventory_item_requires_shipping | TEXT | Product Variant Inventory Item Requires Shipping | Whether the inventory item requires shipping. |
| product_variant_inventory_item_sku | TEXT | Product Variant Inventory Item SKU | Inventory item SKU. |
| product_variant_inventory_item_updated_at | TEXT | Product Variant Inventory Item Updated | The date and time when the inventory item was updated. |
| product_variant_inventory_location_id | TEXT | Product Variant Inventory Location ID | The unique identifier of the location the stock is held at. Selecting a per-location field returns one row per (variant, location), so variant-level metrics (e.g. Product Variant Inventory Quantity) repeat across those rows and should not be summed. |
| product_variant_inventory_location_name | TEXT | Product Variant Inventory Location Name | The name of the location the stock is held at. Requires the read_locations access scope. Selecting a per-location field returns one row per (variant, location), so variant-level metrics repeat across those rows and should not be summed. |
| product_variant_inventory_on_hand_quantity | NUMERIC | Product Variant On Hand Quantity At Location | Total units physically stocked at this location. Current stock, not historical. |
| product_variant_inventory_policy | TEXT | Product Variant Inventory Policy | Whether customers are allowed (continue) to place an order for the product variant when it's out of stock or not (deny). |
| product_variant_inventory_quality_control_quantity | NUMERIC | Product Variant Quality Control Quantity At Location | On hand units in inspection and not sellable at this location. Current stock, not historical. |
| product_variant_inventory_quantity | NUMERIC | Product Variant Inventory Quantity | The total sellable quantity of the variant. |
| product_variant_inventory_reserved_quantity | NUMERIC | Product Variant Reserved Quantity At Location | On hand units temporarily set aside at this location. Current stock, not historical. |
| product_variant_inventory_safety_stock_quantity | NUMERIC | Product Variant Safety Stock Quantity At Location | On hand units held back to guard against overselling. Current stock, not historical. |
| product_variant_metafield_created_at | Product Variant Metafield Created At | The date and time (ISO 8601 format) when the metafield was last updated. | |
| product_variant_metafield_description | TEXT | Product Variant Metafield Description | The description of the metafield. |
| product_variant_metafield_id | TEXT | Product Variant Metafield ID | The unique ID of the metafield. |
| product_variant_metafield_key | TEXT | Product Variant Metafield Key | The unique identifier for a metafield within its namespace. |
| product_variant_metafield_namespace | TEXT | Product Variant Metafield Namespace | The container for a group of metafields that the metafield is or will be associated with. |
| product_variant_metafield_owner_id | TEXT | Product Variant Metafield Owner ID | The unique ID of the resource that the metafield is attached to. |
| product_variant_metafield_owner_resource | TEXT | Product Variant Metafield Owner Resource | The type of resource that the metafield is attached to. |
| product_variant_metafield_type | TEXT | Product Variant Metafield Type | The type of data that is stored in the metafield. |
| product_variant_metafield_update_at | Product Variant Metafield Updated At | The type of resource that the metafield is attached to. | |
| product_variant_metafield_value | TEXT | Product Variant Metafield Value | The data stored in the metafield. Always stored as a string, regardless of the metafield's type. |
| product_variant_option1 | TEXT | Product Variant Option 1 | The custom properties that a shop owner uses to define product variants. First option. |
| product_variant_option2 | TEXT | Product Variant Option 2 | The custom properties that a shop owner uses to define product variants. Second option. |
| product_variant_option3 | TEXT | Product Variant Option 3 | The custom properties that a shop owner uses to define product variants. Third option. |
| product_variant_position | TEXT | Product Variant Position | The order of the product variant in the list of product variants. |
| product_variant_price | NUMERIC | Product Variant Price | The price of the product variant in the default shop currency. |
| product_variant_sku | TEXT | Product Variant SKU | A unique case-sensitive identifier for the product variant in the shop. |
| product_variant_taxable | BOOLEAN | Product Variant Is Taxable | Whether a tax is charged when the product variant is sold. |
| product_variant_title | TEXT | Product Variant Title | The title of the product variant. |
| product_variant_updated_at | Product Variant Updated At | The date and time when the product variant was last modified. Gets returned in ISO 8601 format. | |
| product_variant_weight | NUMERIC | Product Variant Weight | The weight of the product variant in the unit system specified with weight_unit (Product Variant Weight Unit). |
| product_variant_weight_unit | TEXT | Product Variant Weight Unit | The unit of measurement that applies to the product variant's weight. |
| product_vendor | TEXT | Product Vendor | The vendor of the product. |
Shopify shops fields
The shops report of the Shopify connector includes 3 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| shop_id | TEXT | Shop ID | Shopify shop ID. |
| shop_name | TEXT | Shop Name | Shopify shop name. |
| shop_timezone | TEXT | Shop Time Zone | Shopify shop time zone in IANA format (e.g. America/New_York). |
Shopify tender_transactions fields
The tender_transactions report of the Shopify connector includes 8 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| tender_transaction_amount | NUMERIC | Tender Transaction Amount | The amount of the tender transaction in the shop currency. |
| tender_transaction_currency | TEXT | Tender Transaction Currency | The currency of the tender transaction in the shop currency. |
| tender_transaction_id | TEXT | Tender Transaction ID | The ID of the tender transaction. |
| tender_transaction_order_id | TEXT | Tender Transaction Order ID | The ID of the order associated with this tender transaction. |
| tender_transaction_payment_method | TEXT | Tender Transaction Payment Method | Information about the payment method used for the transaction. |
| tender_transaction_processed_at | Tender Transaction Processed At | Date and time when the transaction was processed. | |
| tender_transaction_remote_reference | TEXT | Tender Transaction Remote Reference | The remote gateway reference associated with the tender transaction. |
| tender_transaction_test | BOOLEAN | Tender Transaction Is Test | Whether the transaction is a test transaction. |
Shopify other fields
The Shopify connector has 23 fields that do not belong to a named report, or belong to a report with only one or two fields.
| ID | Type | Name | Description | Report |
|---|---|---|---|---|
| account_id | TEXT | Account ID | Shopify Account URL. | |
| account_name | TEXT | Account Name | Shopify Account URL. | |
| data_fetched_at | Data fetched at | UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed. | ||
| datasource | TEXT | Data Source | The name of the Windsor connector returning the row | |
| date | DATE | Date | The date and time (ISO 8601 format) of the queried object. | |
| day_of_month | TEXT | Day of month | Day of the month | |
| first_date_order_created_at | First Date Order Created At | The autogenerated date and time (ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed. | ||
| month | TEXT | Month | Number of the month | |
| now | Now | Current timestamp | ||
| order_inventory_item_cost | NUMERIC | Total inventory item cost of an order | Total inventory item cost of an order. | inventory_items |
| source | TEXT | Source | The name of the Windsor connector returning the row | |
| today | DATE | Today | Today's date | |
| week | TEXT | Week | Week (Sun-Sat). | |
| week_day | TEXT | Day of week and day number | Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday. | |
| week_day_iso | TEXT | Day of week and day number, ISO | Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7 | |
| week_iso | TEXT | Week ISO | Week, ISO format (Mon-Sun). | |
| year | TEXT | Year | Year | |
| year_month | TEXT | Yearmonth | Year and month, e.g. 2024|3 | |
| year_month_name | TEXT | Year month name | Year and month with the month name written out, e.g. "Jan 2025". | |
| year_of_week | TEXT | Year of week | The year that contains first day of the week (Sun-Sat). | |
| year_of_week_iso | TEXT | Year of week, ISO | The year that contains first day of the ISO week (Mon-Sun). | |
| year_week | TEXT | Year week | Year and week for US weeks (Sun-Sat), e.g. 2024|15 | |
| year_week_iso | TEXT | Year week ISO | Year and week for ISO weeks (Mon-Sun), e.g. 2024|20 |
Windsor vs Coupler.io
