Data Octopus
Demo
Contents
Shops

PrestaShop

Orders and order lines, products, customers with addresses, categories, delivery and reference data.

Integration overview

Data Views — E-commerce engine

ProductsBrandsCategoriesReturns

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

How to connect

Step 1: Go to settings and enable Webservice

Enabling Webservice in PrestaShop
Enabling Webservice in PrestaShop

Step 2: Create an API access key

Open the Webservice page under Advanced Parameters and click Add new webservice key. In the window:

  1. 1Click Generate to create a new key – send it in the registration form you received from Data Octopus.
  2. 2In the description, note who uses the key, e.g. "DataOctopus app".
  3. 3Set the status to YES – this enables the key.
  4. 4In permissions, tick every method in the GET column.

The Data Octopus app never changes your data – it only reads it for analysis.

PrestaShop Webservice key with GET permissions
PrestaShop Webservice key with GET permissions
Access setup guide: every source in one place

Resources we pull

Orders
orders

Order headers with totals, payment and delivery.

Order lines
order_details

Products inside each order.

Products
products

The product catalogue with prices and stock.

Customers and addresses
customersaddresses

Customer accounts and their addresses.

Categories
categories

The category tree.

Reference data
carrierscountriescurrencieslanguagesorder_statesshops

Carriers, countries, currencies, languages, order statuses, shops.

Orders

  • Order reference, creation and update dates, current status (names come from the order statuses).
  • Totals with and without tax: products, shipping, discounts, wrapping, amount paid.
  • Payment method, carrier, currency and conversion rate.
  • Customer and delivery/invoice address references, customer note, gift message.
  • Invoice number and date, delivery number and date, shipping number.
  • Order lines: product, reference, EAN, quantity, unit price with and without tax.

Order lines

  • Product name and reference, EAN, quantity, unit price with and without tax.
  • Discounts (amount and percent), tax, weight.
  • Refunded and returned quantities and amounts, supplier price.

Products

  • Name, short and long description, reference, EAN, manufacturer, default category and all categories.
  • Prices: selling price, wholesale price, unit price, additional shipping cost.
  • Stock quantity, minimal quantity, availability messages, availability date.
  • Weight and dimensions, condition (new or used), active and visible flags, features, images, accessories, tags.
  • SEO texts (title, description, keywords) and dates (added, updated).

Customers

  • Name, e-mail, company, website, birthday, gender, customer group, language.
  • Newsletter and marketing consent, account active, guest flag, dates (added, updated), customer note.

Addresses

  • Name, company, street, house and flat number, city, postcode, country, phone numbers, tax id.

Categories

  • Name, description, parent, depth, active, number of products, SEO texts, dates, products and subcategories in the category.

Delivery and reference data

  • Carriers (name, free shipping, weight and size limits, delivery time, active).
  • Countries (name, ISO code, phone prefix, zip format).
  • Currencies (name, ISO code, symbol, conversion rate), languages.
  • Order statuses (name, paid, shipped, delivered, invoiced), shops (name, theme, active).
PreviousIdoSellNextShoper