Essential Attributes and Supported Tables for Shopify
Essential Attributes and Supported Tables for Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
In this article, we will look at the essential attributes and tables supported by the Shopify connector.
Find the links to other articles related to Shopify Below:
- Setup Instructions for Shopify
- Schema Information for Shopify
- Shop Name and Access Token for Shopify
Essential Attributes
| Features | Details |
|---|---|
| Release Status | Released |
| Table Selection | Yes |
| Column Selection | Yes |
| Edit Integration | Yes |
| Replication Type Selection | No |
| Authentication Parameters | Shopify Shop name Shopify Access Token |
| Replication Type | Key Based Incremental |
| Replication Key | Date |
| Suggested Replication Frequency | 1 hr |
Tables/APIs Supported
| Supported Table Names | |
|---|---|
| orders | transactions |
| refunds | fulfillment_orders |
| fulfillment_events | tender_transactions |
| customers | customer_address |
| events | products |
| payouts | balance_transactions |
| smart_collections | custom_collections |
| collects | abandoned_checkouts |
| policies | countries |
| shops | locations |
| inventory_levels | inventory_items |
| gift_cards | carrier_services |
| price_rules | disputes |
| order_customerjourneysummary | product_sessiondata |
| users | |
To know more about the supported APIs and tables, read Shopify V2 - Schema Information.
Table mapping between V1 and V2
- One of the major differences in V2 is that all tables that were dependent on the parent will now be a separate table instead of a record column in the parent table. For eg. fulfillment_orders is a dependent table on parents and it was available as a record in V1 but in V2 it will be a separate table.
- Some additional tables such as fulfillment_events, gift_cards, and disputes have been added to the V2 connector.
Note: gift_cards table is available only for Shopify Plus users and you need to reach out to your merchant success manager to get the scopes
| V1 | V2 |
|---|---|
| orders | orders transactions refunds fulfillment_orders fulfillment_events |
| checkouts | abandoned_checkouts |
| customers | customers custome_address |
| products | products product_metafields |
| tender_transactions | tender_transactions |
| policies | policies |
| countries | countries |
| smart_collections | smart_collections |
| custom_collections | custom_collections |
| collects | collects |
| locations | locations |
| events | events |
| price_rules | price_rules |
| shop | shop |
| carrier_services | carrier_services |
| inventory | inventory_levels inventory_items |
| payouts | payouts |
| transactions | balance_transactions |
| - | disputes |
| - | gift_cards |
| - | users |
Table level scope
| TableName | Scope Required |
| orders | read_orders |
| transactions | read_orders, read_shopify_payments_payouts |
| refunds | read_orders |
| fulfillment_orders | read_merchant_managed_fulfillment_orders/read_assigned_fulfillment_orders |
| fulfillment_events | read_orders |
| tender_transactions | read_orders |
| draft_orders | read_draft_orders |
| customers | read_customers |
| customer_address | read_customers |
| events | - |
| products | read_products |
| payouts | read_shopify_payments_payouts |
| balance_transactions | read_shopify_payments_payouts |
| collects | read_products |
| custom_collections | read_products |
| smart_collections | read_products |
| abandoned_checkouts | read_orders |
| policies | - |
| countries | - |
| shop | - |
| locations | read_locations |
| inventory_levels | read_inventory |
| inventory_items | read_inventory |
| gift_cards | read_gift_cards (Reach out to Shopify Merchant Success Manager) |
| users | read_users (Reach out to Shopify Merchant Success Manager) |
| carrier_services | read_shipping |
| price_rules | read_price_rules |
| disputes | read_shopify_payments_payouts |
| order_customerjourneysummary | read_orders, read_marketplace_orders, read_all_orders(if you need data for orders placed before 2 months) |
| product_sessiondata |
