Shopify
Orders, order lines, products, variants and customer data inside orders.
Integration overviewData Views — E-commerce engine
The current documentation for these views describes IdoSell report data and rules.
Stores with several markets are loaded as separate sets of tables per market (for example PL, DE, FR, IT).
How to connect
Connecting Data Octopus to a Shopify store requires creating a dedicated app in the admin panel. It gives secure, read-only data access via an API key.
Step 1: Go to app settings
Click Settings in the bottom-left corner.
In the settings menu, choose Apps and sales channels.
Step 2: Open the developer dashboard
Click Develop apps in the top-right corner.
Then click Build apps in Dev Dashboard.
Step 3: Create and name a new app
Click Create app in the top-right corner.
Enter DataOctopus as the App name so it's clear who was given access, then click Create.
Step 4: Configure permissions (API scopes)
This is the key step. In the app configuration panel, scroll to the Access section.
Paste the following permissions into the Scopes field – they give read-only access to the required data:
| Scopes |
|---|
| read_analytics, read_gift_cards, read_customers, read_orders, read_products |
Step 5: Save and install the app
After pasting the scopes, click Release in the bottom-right corner.
In the new window, click Release again without filling in any extra fields.
On the app's main page, click Install app in the top-right corner.
Confirm the installation by clicking Install.
Step 6: Copy the API key and store address
After installation Shopify shows the API key. If you closed that window, go back to Settings > Apps and sales channels > Develop apps and select the DataOctopus app.
In the Credentials section, copy the Admin API access token and paste it into the Data Octopus registration form.
The Admin API access token is unique and required to complete the integration.
Finally, in Settings > Store details you'll find the store address in the format store-name.myshopify.com. Copy it and paste it into the form too.
Resources we pull
ordersOrder headers with customer, addresses, totals, discounts and traffic source.
orders_productsProducts inside each order.
productsThe product catalogue.
product_variantsSizes, colors and other variants with price and inventory.
Orders
- Order name and id, creation, update, processing, closing and cancelling dates, cancel reason, test flag.
- Status: financial (paid, refunded, ...), fulfillment, return status.
- Totals (in shop and presentment currency): subtotal, total, tax, discounts, shipping, tips, refunded, received, outstanding.
- Discount codes, tags, note, source of the order, shipping method (title, code, source).
- Customer: id, name, e-mail, number of orders, amount spent, marketing consent.
- Billing and shipping address (name, company, street, city, region, country, postcode, phone, coordinates).
- Traffic source: landing page, referrer, UTM parameters (source, medium, campaign, term, content), last visit.
- Refunds, disputes, payment terms, payment gateways.
Order lines
- Product and variant title, SKU, quantity, current and refundable quantity.
- Unit price, discounted price, totals, discounts, tax lines (rate, title).
- Product link (id, handle, vendor, type, tags), gift card and shipping-required flags.
Products
- Title, handle, vendor, product type, tags, description, SEO title and description.
- Options (for example size and color) and their values.
- Price range, compare-at price range, total inventory, category (full path in the Shopify taxonomy).
- Status and dates (created, updated, published).
Variants
- Title, SKU, barcode, price, compare-at price, available for sale, inventory and sellable quantity, position.
- Selected options, taxable and tax code, inventory policy, weight, unit price measurement, delivery profile.