Shopify Field Reference

Sample

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

Fields

ID	Type	Name	Description	Report
account_id	TEXT	Account ID	Shopify Account URL
account_name	TEXT	Account Name	Shopify Account URL
breadcrumb_id	TEXT	Marketing Event Breadcrumb ID	The breadcrumb ID of the event.	marketing_event
budget_type	TEXT	Marketing Event Budget Type	The budget type of the event.	marketing_event
customer_created_at	TIMESTAMP	Customer Created at (Timestamp)	The date and time (ISO 8601 format) when the customer was created.	customer
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
customer_date	DATE	Customer Created At (Date)	The date and time (ISO 8601 format) when the customer information was last updated.	customer
customer_default_address	OBJECT	Customer Default Address	The customer's default address.	customer
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
customer_first_name	TEXT	Customer First Name	The customer's first name.	customer
customer_id	TEXT	Customer ID	A unique identifier for the customer.	customer
customer_last_name	TEXT	Customer Last Name	The customer's last name.	customer
customer_last_order_id	TEXT	Customer Last Order ID	The ID of the customer's last order.	customer
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
customer_multipass_identifier	NUMERIC	Customer Multipass Identifier	A unique identifier for the customer that's used with Multipass login.	customer
customer_note	TEXT	Customer Note	A note about the customer.	customer
customer_orders_count	NUMERIC	Customer Orders Count	The number of orders associated with this customer.	customer
customer_phone	TEXT	Customer Phone Number	The unique phone number (E.164 format) for this customer.	customer
customer_state	TEXT	Customer state	The state of the customer's account with a shop (Can be disabled, invited, enabled and declined)	customer
customer_tags	TEXT	Customer Tags	Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values.	customer
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
customer_total_spent	NUMERIC	Customer Total Spent	The total amount of money that the customer has spent across their order history.	customer
customer_updated_at	TIMESTAMP	Customer Updated at (Timestamp)	The date and time (ISO 8601 format) when the customer information was last updated.	customer
customer_verified_email	BOOLEAN	Customer Email Verified	Whether the customer has verified their email address.	customer
date	DATE	Customer Created at (Timestamp)	The date and time (ISO 8601 format) of the queried object.
email	TEXT	Order Email	The customers email address.	order
ended_at	TIMESTAMP	Marketing Ended At	The event end datetime.	marketing_event
event_type	TEXT	Marketing Event Type	The event type.	marketing_event
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.	order
line_item__duties	TEXT	Line Item Duties	A list of duty objects, each containing information about a duty on the line item.	order
line_item__fulfillable_quantity	NUMERIC	Line Item Fulfillable Quantity	The amount available to fulfill, calculated as follows:quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity	order
line_item__fulfillment_service	TEXT	Line Item Fulfillment Service	The service provider that's fulfilling the item. Valid values: manual,or the name of the provider, such as amazon or shipwire.	order
line_item__fulfillment_status	TEXT	Line Item Fulfillment Status	How far along an order is in terms line items fulfilled. Valid values:null, fulfilled, partial, and not_eligible.	order
line_item__gift_card	TEXT	Line Item Gift Card	Whether the item is a gift card. If true, then the item is not taxed orconsidered for shipping charges.	order
line_item__grams	NUMERIC	Line Item Grams	The weight of the item in grams.	order
line_item__id	TEXT	Line Item Id	The ID of the line item.	order
line_item__name	TEXT	Line Item Name	The name of the product variant.	order
line_item__origin_location	TEXT	Line Item Origin Location	The location of the line item’s fulfillment origin.id: The location ID of the line item’s fulfillment origin. Used by Shopify to calculateapplicable taxes. This is not the ID of the location where the order was placed. You can use the FulfillmentOrderresource to determine the location an item will be sourced from.country_code: The two-letter code (ISO 3166-1 format) forthe country of the item's supplier.province_code: The two-letter abbreviation for the region of the item's supplier.name: The name of the item's supplier.address1: The street address of the item's supplier.address2: The suite number of the item's supplier.city: The city of the item's supplier.zip: The zip of the item's supplier.	order
line_item__price	NUMERIC	Line Item Price	The price of the item before discounts have been applied in the shop currency.	order
line_item__price_set	TEXT	Line Item Price Set	The price of the line item in shop and presentment currencies.	order
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.	order
line_item__properties	TEXT	Line Item Properties	An array of custom information for the item that has been added to the cart. Oftenused to provide product customization options.	order
line_item__quantity	NUMERIC	Line Item Quantity	The number of items that were purchased.	order
line_item__requires_shipping	TEXT	Line Item Requires Shipping	Whether the item requires shipping.	order
line_item__sku	TEXT	Line Item SKU	The item's SKU (stock keeping unit).	order
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.	order
line_item__taxable	TEXT	Line Item Taxable	Whether the item was taxable.	order
line_item__tip_payment_gateway	TEXT	Line Item Tip Payment Gateway	The payment gateway used to tender the tip, such asshopify_payments. Present only on tips.	order
line_item__tip_payment_method	TEXT	Line Item Tip Payment Method	The payment method used to tender the tip, such as Visa.Present only on tips.	order
line_item__title	TEXT	Line Item Title	The title of the product.	order
line_item__total_discount	NUMERIC	Line Item Total Discount	The total amount of the discount allocated to the line item in the shopcurrency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of usingthis field, Shopify recommends using discount_allocations, which provides the same information.	order
line_item__total_discount_set	NUMERIC	Line Item Total Discount Set	The total amount allocated to the line item in the presentment currency.Instead of using this field, Shopify recommends using discount_allocations, which provides the sameinformation.	order
line_item__variant_id	TEXT	Line Item Variant ID	The ID of the product variant.	order
line_item__variant_title	TEXT	Line Item Variant Title	The title of the product variant.	order
line_item__vendor	TEXT	Line Item Vendor	The name of the item's supplier.	order
manage_url	TEXT	Marketing Event Manage URL	The manage URL of the event.	marketing_event
marketing_activity_id	TEXT	Marketing Event Activity ID	The activity ID of the event.	marketing_event
marketing_channel	TEXT	Marketing Event Channel	The markerting channel of the event.	marketing_event
marketing_event_budget	NUMERIC	Marketing Event Budget	The budget of the event.	marketing_event
marketing_event_currency	NUMERIC	Marketing Event Currency	The currency of the event.	marketing_event
marketing_event_description	TEXT	Marketing Event Description	The event description.	marketing_event
marketing_event_paid	BOOLEAN	Marketing Event Paid	The flag that indicates if an event is paid.	marketing_event
order_app_id	TEXT	Order App ID	The ID of the app that created the order.	order
order_billing_address	OBJECT	Order Billing Address	The orders billing address.	order
order_cancel_reason	TEXT	Order Cancel Reason	The reason why the order was canceled.	order
order_cancelled_at	TIMESTAMP	Order Cancelled At	The date and time ( ISO 8601 format) when the order was canceled.	order
order_closed_at	TIMESTAMP	Order Closed At	The date and time (ISO 8601 format) when the order was closed.	order
order_count	NUMERIC	Order Count	The number of orders. Default value is 1, but for refunds, the value is zero.	order
order_created_at	TIMESTAMP	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
order_currency	TEXT	Order Currency	The three-letter code (ISO 4217 format) for the shop currency.	order
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
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
order_current_total_price	NUMERIC	Order Current Total Price	The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.	order
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
order_email	TEXT	Order Email	The customers email address.	order
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
order_fulfillable_quantity	NUMERIC	Order Fullfillable Quantity	The fullfillable quantity of the order.	order
order_fulfillment_service	TEXT	Order Fulfillment Service	The order fulfillment service.	order
order_gross_sales	NUMERIC	Order Gross Sales	The order gross sales (before taxes, shipping, discounts, and returns).	order
order_id	TEXT	Order ID	The unique identifier of the order	order
order_inventory_item_cost	NUMERIC	Total invetory item cost of an order	Total invetory item cost of an order.	inventory_item
order_inventory_item_id	TEXT	Inventory Item Id	The ID of the inventory item.	inventory_item
order_line_items	OBJECT	Order Line Items	The line items of the order.	order
order_name	TEXT	Order name	The name of the order	order
order_net_margin	NUMERIC	Order Net Margin	The order net margin.	inventory_item
order_net_sales	NUMERIC	Order Net Sales	The order net sales (Equates to order_gross_sales - order_total_discounts - order_refunds_net).	order
order_note	TEXT	Order note	An optional note that a shop owner can attach to the order.	order
order_product_price	NUMERIC	Order Product Price	The order price.	order
order_quantity	NUMERIC	Order Quantity	The order quantity.	order
order_refunds	TEXT	Order Refunds	A list of refunds applied to the order.	order
order_refunds_net	NUMERIC	Aggregated Order Refunds Net	Sum of order_refunds_subtotal and order_refunds_refunds_total_tax.	order
order_refunds_subtotal	NUMERIC	Aggregated Order Refunds Subtotal	The subtotal of the refund line items.	order
order_refunds_total_tax	NUMERIC	Aggregated Order Refunds Total Tax	The total tax on the refund line items.	order
order_sales_channel	TEXT	Order Sales Channel (A duplicate of `order_app_id`)	The ID of the app that created the order.	order
order_shipping_address	OBJECT	Order Shipping Address	The orders shipping address.	order
order_tags	TEXT	Order tags	Tags attached to the order	order
order_total_discounts	NUMERIC	Order Total Discounts	The total discounts applied to the price of the order in the shop currency.	order
order_total_discounts_set	NUMERIC	Order Total Discounts Set	The total discounts applied to the price of the order in shop and presentment currencies.	order
order_total_price	NUMERIC	Order Total Price	The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.	order
order_updated_at	TIMESTAMP	Order Updated At	The date and time (ISO 8601 format) when the order was last modified.	order
preview_url	TEXT	Marketing Event Preview URL	The preview URL of the event.	marketing_event
product_created_at_datetime	TIMESTAMP	Product Created At Datetime	The date and time the product was created.	product
product_description	TEXT	Product Description	Description of the product.	product
product_handle	TEXT	Product handle	The product handle.	product
product_id	TEXT	Product ID	The product variant SKU number.	product
product_image_src	TEXT	Product Image URL	The image URL of the product.	product
product_inventory_quantity	NUMERIC	Product Inventory Quantity	The product quantity in inventory.	product
product_inventory_value	NUMERIC	Product Inventory Value	The sell value of the product inventory.	product
product_price	NUMERIC	Product Price	The price of the product.	product
product_tags	TEXT	Product Tags	Tags attached to the product.	product
product_title	TEXT	Product Title	The title of the product.	product
product_type	TEXT	Product Type	The type of the product.	product
product_vendor	TEXT	Product Vendor	The vendor of the product.	product
referring_domain	TEXT	Marketing Event Referring Domain	The referring domain of the event.	marketing_event
remote_id	TEXT	Marketing Remote ID	The remote id.	marketing_event
scheduled_to_end_at	TIMESTAMP	Marketing Event Scheduled To End At	The scheduled end date of the event.	marketing_event
sku	TEXT	Variant SKU number	The product variant SKU number.	order
started_at	TIMESTAMP	Marketing Started At	The event start datetime.	marketing_event
utm_campaign	TEXT	Marketing Event UTM Campaign	The UTM campaign of the event.	marketing_event
utm_medium	TEXT	Marketing Event UTM Medium	The UTM medium of the event.	marketing_event
utm_source	TEXT	Marketing Event UTM Source	The UTM source of the event.	marketing_event
variant_id	TEXT	Variant ID	The unique identifier of the product variant.	order
variant_title	TEXT	Variant Title	The title of the product variant.	order