Data Octopus
Demo
Contents
Shops

Shoper

Orders and order lines, products with variants and stock, categories, brands, delivery and reference data.

Integration overview

Data Views — E-commerce engine

ProductsBrandsCategoriesReturns

The current documentation for these views describes IdoSell report data and rules.

Shoper has no separate customers table: customer data comes with orders.

How to connect

Connecting Data Octopus to Shoper requires creating an External Integration in the admin panel, which provides data access via an API token.

Step 1: Start adding a new integration

  1. 1In the side panel, choose Add-ons and integrations (1).
  2. 2Click External integrations (2).
  3. 3Click Add integration in the top-right corner (3).
External integrations and the Add integration button in Shoper
External integrations and the Add integration button in Shoper

Step 2: Fill in the basic settings

  1. 1Tool: choose Other (1).
  2. 2Integration name: enter DataOctopus Integration (2) so it's clear who was given access.
  3. 3Description: optional (recommended), e.g. "DataOctopus <> Shoper data integration" (3).
Basic integration settings in Shoper
Basic integration settings in Shoper

Step 3: Grant integration permissions (read)

In the Integration permissions section, add a read permission for each of these data categories:

  • Orders
  • Products
  • Producers
  • Currencies
  • Deliveries
  • Categories
  • Availability states
  • Order statuses
  1. 1In Shop area (1), choose one item, e.g. orders.
  2. 2In Access scope (2), always choose read.
  3. 3Click Add permission (3).
  4. 4Repeat until the list contains all 8 items with read scope.
List of read permissions for the integration in Shoper
List of read permissions for the integration in Shoper

Step 4: Save and create the token

Once all permissions are added, scroll down and click Save and create token.

Step 5: Copy and send the API token

Copy the API token immediately – it can't be viewed again once the page is closed. If you close it without copying, you'll need to create a new token.

  1. 1Copy the Client ID and the API token.
  2. 2Paste both into the Data Octopus onboarding form.
  3. 3Click I understand (1).
Summary with the Client ID and API token in Shoper
Summary with the Client ID and API token in Shoper
Access setup guide: every source in one place

Resources we pull

Orders
orders

Order headers with customer, addresses, totals, payment and delivery.

Order lines
order_products

Products inside each order.

Products and variants
productsproduct_stocks

The catalogue, prices and stock levels.

Categories and brands
categoriesproducers

The category tree and producers.

Reference data
shippingsstatusesavailabilitiescurrencies

Shipping methods, order statuses, availabilities, currencies.

Orders

  • Order id and code, creation, confirmation, status and delivery dates, status.
  • Customer e-mail, billing address and delivery address (name, company, street, city, postcode, country, phone, tax id).
  • Totals: sum, paid amount, shipping cost, discounts (client, group, code, levels), tax, loyalty cost, currency and rate.
  • Shipping method and delivery code, pickup point (name, address, opening hours), payment method.
  • Promo code, tags, notes (public and private), source of the order, paid and underpaid/overpaid flags.

Order lines

  • Product, name, code, option, quantity, unit, price, discount, tax, weight, warehouse code.

Products

  • Code, EAN, producer, category and all categories, names and descriptions per language, attributes, options, tags, collections.
  • Prices: price, promo price, loyalty price, other price, special offers (discount, dates).
  • Stock and variants, dimensions and volumetric weight, tax, unit.
  • Flags: new product, bestseller, product of the day; related products, bundles (children), main image, dates (added, edited).

Variants and stock

  • Variant code, EAN, price types (retail, wholesale, special), buying price, lowest price in the last period.
  • Stock level, warning level, sold quantity, availability, delivery time, weight, packaging, special offers.

Categories, brands and reference data

  • Categories (name, description, SEO, parent, sort order).
  • Producers (name, website, logo, SEO).
  • Shipping methods (name, cost, weight and cost limits, free shipping threshold, payments).
  • Order statuses (name, type, color, e-mail on change), availabilities, currencies and rates.
PreviousPrestaShopNextShopify