Shopify
The table below gives information about all the data fields that you can import from Shopify.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs. As a result, the fields shown here may not be the same as the fields available in Adverity. If you notice a difference between this documentation and the fields you see in Adverity, please contact your Adverity account manager for more information.
To see the fields you can collect from another data source, go back to the Available fields in Adverity overview.
|
Field UI name |
Field API name |
Description |
Use in Adverity |
Docs |
|---|---|---|---|---|
|
|
app_id |
The ID of the app that created the order. |
dimension |
|
|
|
billing_address.city |
The city- town- or village of the billing address. |
dimension |
|
|
|
billing_address.country |
The name of the country of the billing address. |
dimension |
|
|
|
billing_address.first_name |
|
dimension |
|
|
|
billing_address.last_name |
The last name of the person associated with the payment method. |
dimension |
|
|
|
body_html |
A description of the product. Supports HTML formatting. |
dimension |
|
|
|
buyer_accepts_marketing |
Whether the customer consented to receive email updates from the shop. |
dimension |
|
|
|
cancel_reason |
The reason why the order was canceled. |
dimension |
|
|
|
cancelled_at |
The date and time (ISO 8601 format) when the order was canceled. |
dimension |
|
|
|
cart_token |
The ID of the cart that's associated with the order. |
dimension |
|
|
|
client_details |
Information about the browser that the customer used when they placed their order. |
dimension |
|
|
|
closed_at |
The date and time (ISO 8601 format) when the order was closed. |
dimension |
|
|
|
created_at |
Date of creation. |
dimension |
|
|
|
currency |
The three-letter code (ISO 4217 format) for the shop currency. |
dimension |
|
|
|
customer.city |
The city- town- or village of the customer. |
dimension |
|
|
|
customer.country |
The name of the country of customer. |
dimension |
|
|
|
customer.email |
The email of the customer. |
dimension |
|
|
|
customer.first_name |
The first name of the customer. |
dimension |
|
|
|
customer.last_name |
The last name of the customer. |
dimension |
|
|
|
customer_locale |
The two or three-letter language code- optionally followed by a region modifier. |
dimension |
|
|
|
discount_applications |
An ordered list of stacked discount applications. |
dimension |
|
|
|
discount_codes |
A list of discount codes to apply to the order. |
dimension |
|
|
|
|
The customer's email address. |
dimension |
|
|
|
financial_status |
The status of payments associated with the order. Can only be set when the order is created. |
dimension |
|
|
|
fulfillment_status |
The order's status in terms of fulfilled line items. |
dimension |
|
|
|
fulfillments |
A list of fulfillments associated with the order. |
dimension |
|
|
|
gateway |
The payment gateway used. |
dimension |
|
|
|
handle |
A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects. |
dimension |
|
|
|
id |
A unique numeric identifier. |
dimension |
|
|
|
landing_site |
The URL for the page where the buyer landed when they entered the shop. |
dimension |
|
|
|
line_items.0.quantity |
The number of items that were purchased. |
metric |
|
|
|
line_items.0.sku |
The item's SKU (stock keeping unit). |
dimension |
|
|
|
line_items.1.quantity |
The number of items that were purchased. |
metric |
|
|
|
line_items.1.sku |
The item's SKU (stock keeping unit). |
dimension |
|
|
|
location_id |
The ID of the physical location where the order was processed. |
dimension |
|
|
|
name |
The order name as represented by a number. |
dimension |
|
|
|
note |
An optional note that a shop owner can attach to the order. |
dimension |
|
|
|
note_attributes |
Extra information that is added to the order. |
dimension |
|
|
|
number |
For internal use only. An ID unique to the shop. Numbers are sequential and start at 1000. |
dimension |
|
|
|
options |
The custom product property names like Size- Color- and Material. You can add up to 3 options of up to 255 characters eac |
dimension |
|
|
|
order_number |
The ID of the order used by the shop owner and customer. This is different from the id property- which is the ID of the order used by the API. |
dimension |
|
|
|
order_status_url |
The URL pointing to the order status web page- if applicable. |
dimension |
|
|
|
payment_details |
An object containing information about the payment. |
dimension |
|
|
|
payment_gateway_names |
The list of payment gateways used for the order. |
dimension |
|
|
|
phone |
The customer's phone number. |
dimension |
|
|
|
processed_at |
The date and time (ISO 8601 format) when an order was processed. |
dimension |
|
|
|
processing_method |
How the payment was processed. |
dimension |
|
|
|
product_type |
A categorization for the product used for filtering and searching products. |
dimension |
|
|
|
published_at |
The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel. |
dimension |
|
|
|
published_scope |
Whether the product is published to the Point of Sale channel. |
dimension |
|
|
|
referring_site |
The website where the customer clicked a link to the shop. |
dimension |
|
|
|
refunds |
A list of refunds applied to the order. |
dimension |
|
|
|
shipping_address.city |
The city- town- or village of the shipping address. |
dimension |
|
|
|
shipping_address.country |
The name of the country of the shipping address. |
dimension |
|
|
|
shipping_address.first_name |
The first name of the person associated with the shipping address. |
dimension |
|
|
|
shipping_address.last_name |
The last name of the person associated with the shipping address. |
dimension |
|
|
|
shipping_lines.0.discount_allocations |
An ordered list of amounts allocated by discount applications. |
dimension |
|
|
|
shipping_lines.0.discounted_price |
The price of the shipping method after discounts. |
metric |
|
|
|
shipping_lines.0.price |
The price of this shipping method in the shop currency. |
metric |
|
|
|
shipping_lines.0.tax_lines |
A list of tax line objects- each of which details a tax applicable to this shipping line. |
dimension |
|
|
|
shop_id |
The ID of the shop. |
dimension |
|
|
|
shop_name |
The name of the shop. |
dimension |
|
|
|
source_name |
Where the order originated. |
dimension |
|
|
|
subtotal_price |
The price of the order in the shop currency after discounts but before shipping- taxes- and tips. |
metric |
|
|
|
tags |
A string of comma-separated tags. |
dimension |
|
|
|
tax_lines |
An array of tax line objects- each of which details a tax applicable to the order. |
dimension |
|
|
|
taxes_included |
Whether taxes are included in the order subtotal. |
dimension |
|
|
|
template_suffix |
The suffix of the Liquid template used for the product page. |
dimension |
|
|
|
test |
Whether this is a test order. |
dimension |
|
|
|
title |
The name of the product. |
dimension |
|
|
|
token |
A unique token for the order. |
dimension |
|
|
|
total_discounts |
The total discounts applied to the price of the order in the shop currency. |
metric |
|
|
|
total_line_items_price |
The sum of all line item prices in the shop currency. |
metric |
|
|
|
total_price |
The sum of all line item prices- discounts- shipping- taxes- and tips in the shop currency. |
metric |
|
|
|
total_tax |
The sum of all the taxes applied to the order in the shop currency. |
metric |
|
|
|
total_tip_received |
The sum of all the tips in the order in the shop currency. |
metric |
|
|
|
total_weight |
The sum of all line item weights in grams. |
metric |
|
|
|
updated_at |
The date and time (ISO 8601 format) of the last update. |
dimension |
|
|
|
user_id |
The ID of the user logged into Shopify POS who processed the order- if applicable. |
dimension |
|
|
|
variants.barcode |
The barcode of the product variant. |
dimension |
|
|
|
variants.inventory_quantity |
The number of inventory of the product variant. |
metric |
|
|
|
variants.price |
The price of the product variant. |
metric |
|
|
|
variants.sku |
The SKU of the product variant. |
dimension |
|
|
|
vendor |
The name of the product's vendor. |
dimension |
|