Shops
IdoSell
Orders, returns, the product catalogue, categories and, optionally, customers and shop settings.
Integration overviewData Views — E-commerce engine
The current documentation for these views describes IdoSell report data and rules.
Typically enabled tables: orders, products, returns, categories. Customers and shop settings are optional.
How to connect
Open the access panel: yourdomain.com/panel/users-api.php (use your own domain) and click "+ Add new key".
A window for configuring the new API access key opens. In it:
- 1Choose API key.
- 2Enter the name Data Octopus.
- 3Enter the e-mail address given in the form.
- 4Set Active to Yes.
- 5Set PIM to Read only.
- 6Set OMS to Read only.
- 7Click Add.
After creating the key, go back to users-api.php and click Edit.
Click Show key, copy it and paste it into the form.
Resources we pull
Orders
ordersWhat customers bought.
Products
productsThe product catalogue with prices and stock.
Returns
returnsReturned orders and refunds.
Categories
categoriesThe category tree.
Customersoptional
clients_crmCustomer accounts and their order history.
Shop settingsoptional
shopsShop configuration.
Orders
- Order number and type, internal notes.
Returns
- Return number, the related order, status and key dates.
- Returned products: quantity, price, size.
- Costs: shipping cost, additional payment cost.
- Refund payments: amount, payment form, status, date.
- Return method, package number, customer and shop notes.
Products
- Product id, displayed code, name and description in each language.
- Category (shop and IdoSell category path), producer.
- Prices: retail, wholesale, minimal, last and average purchase price (net and gross), VAT.
- Sizes and variants, stock levels, availability type.
- Visibility, promotions, deleted flag, dates (added, modified, price and quantity changed).
- Per-shop settings and per-shop currencies.
Customersoptional
- Customer id, login, name, company and tax id, e-mail, phone numbers, country, type (retail or wholesale).
- Order history: number of orders (all and completed), total order value, last purchase date, last login, returns and complaints count.
- Purchased and observed products, discount, loyalty points, newsletter consents (e-mail and SMS), notes.
Categories
- Id, parent category, priority, names (singular and plural), description, number of products, language.
Shop settingsoptional
- Shop id and name, default language and currency, company data on documents, which customer fields are required, loyalty, vouchers and gift cards on/off.