
Veeqo
tap-veeqo (matatika variant)
Veeqo is a cloud-based inventory and order management software for e-commerce businesses.
E-commerce businesses use Veeqo manage their inventory, orders, and shipping across multiple sales channels. It has basic features such as inventory levels, low stock alerts, and management of purchase orders. The software also allows businesses to manage their orders from multiple sales channels in one place, print shipping labels, and automatically update tracking information. Through the Veeqo API, integrations with a variety of e-commerce platforms, marketplaces, and shipping carriers are supported. Veeqo also provides some out of the box analytics and reporting, enough for many businesses to gain basic insights into their sales performance and inventory trends.
Matatika extracts data from the Veeqo API to enable more sophisticated businesses to streamline their operations, reduce errors, and improve their overall efficiency. Our clients tell us its a game changer to have a single space where advanced sales performance and inventory trends are analyzed. Some of the key use case we solve include:
Automated Industry Sales Reporting
Producing standard 3rd party industry sales reports is a breeze. Matatika automatically maps product sales to user defined categories. Saving hours each month for our clients.
Veeqo API streams: Orders, Products, Tags
Tax liabilities and Sales accounts
Matatika automates the reconciliation and update of your accounting system with user defined sales accounts that need to respect zero rated sales, or sales in user defined categories or departments.
Veeqo API streams: Orders, Products, Suppliers, Tags
Forecasting
Whether its sales, inventory, or marketing effectiveness that you need, Matatika provides advanced insights about your business from a single trusted space.
Veeqo API streams: Orders, Returns, Allocations, Products, Purchase Orders, Suppliers, Company, Warehouses, Customers, Stores, Delivery Methods, Shipments, Stock Entries, Tags
Prerequisites
To obtain an API key for Veeqo, follow these steps:
-
Log in to your Veeqo account.
-
Click on your profile icon in the top right corner of the screen.
-
Select "Settings" from the dropdown menu.
-
Click on "API" in the left-hand menu.
-
Click on the "Generate new API key" button.
-
Give your API key a name and select the permissions you want to grant.
-
Click on the "Generate API key" button.
-
Your new API key will be displayed on the screen.
Available Streams
| Stream | Description | Replication | Replication Key | Primary Key |
|---|---|---|---|---|
orders | Sales orders, with their allocations and returns | Incremental | updated_at | id |
products | Products, with their variants and stock levels | Incremental | updated_at | id |
product_property_specifics | Property values set on each product | Full Table | — | product_id, id, product_property_id |
product_option_specifics | Option values set on each product | Full Table | — | product_id, id, product_property_id |
sellables | Sellable product variants, with their stock entries | Full Table | — | id |
variant_property_specifics | Property values set on each product variant | Full Table | — | variant_id, id, product_specific_id, product_property_id |
product_brands | Product brands | Full Table | — | id |
product_properties | Product property definitions | Full Table | — | id |
product_tags | Tags available for products | Full Table | — | id |
purchase_orders | Purchase orders, with their supplier and ordered variants | Full Table | — | id |
suppliers | Suppliers | Full Table | — | id |
customers | Customers, with their addresses | Full Table | — | id |
stores | Sales channels connected to Veeqo | Full Table | — | id |
warehouses | Warehouses | Full Table | — | id |
delivery_methods | Delivery methods | Full Table | — | id |
employees | Users of the Veeqo account | Full Table | — | id |
tags | Tags available for orders | Full Table | — | id |
Limitations
- Per-record requests for child streams.
product_property_specificsandproduct_option_specificsmake one API request for each product, andvariant_property_specificsmakes one for each sellable. A sync of these streams takes longer as the catalogue grows. - Credit limits are text. Veeqo returns a supplier's
credit_limitas either text or a number, so it is always loaded as text.
Data recovery / backfill
orders and products keep a bookmark between syncs: the latest updated_at they have loaded.
Every other stream is full table and re-syncs completely on each run, so it needs no backfill.
The first sync of orders and products reads their full history. To backfill or re-sync them,
reset the pipeline state so that the next sync starts from the beginning again.
The tables below list the main fields of each stream. Every stream has more fields; the full schemas are in the tap's catalog.
orders
Supports incremental replication using updated_at.
| Field | Type | Description |
|---|---|---|
id | integer | Unique order identifier |
number | string | Order number |
status | string | Order status |
channel | object | The sales channel the order came from |
customer | object | The customer who placed the order |
deliver_to | object | Delivery address |
delivery_method | object | Delivery method |
allocations | array | Allocations of the order to warehouses, with their line items and shipments |
returns | array | Returns against the order |
subtotal_price | number | Total before delivery, tax and discounts |
total_price | number | Total price of the order |
total_tax | number | Total tax |
currency_code | string | Currency of the order |
created_at | datetime | Creation timestamp |
shipped_at | datetime | Shipping timestamp |
updated_at | datetime | Last modification timestamp — replication key |
products
Supports incremental replication using updated_at.
| Field | Type | Description |
|---|---|---|
id | integer | Unique product identifier |
title | string | Product title |
description | string | Product description |
brand | object | Product brand |
sellables | array | Variants of the product |
tags | array | Tags on the product |
total_stock_level | integer | Stock level across all warehouses |
total_available_stock_level | integer | Stock available to sell across all warehouses |
total_quantity_sold | integer | Units sold |
on_hand_value | number | Value of the stock on hand |
created_at | datetime | Creation timestamp |
deleted_at | datetime | Deletion timestamp |
updated_at | datetime | Last modification timestamp — replication key |
product_property_specifics and product_option_specifics
| Field | Type | Description |
|---|---|---|
product_id | integer | Product identifier |
id | integer | Unique value identifier |
product_property_id | integer | Property identifier |
product_property_name | string | Property name |
value | string | Property value |
sellables
| Field | Type | Description |
|---|---|---|
id | integer | Unique sellable identifier |
type | string | Sellable type |
sku_code | string | SKU |
upc_code | string | UPC barcode |
full_title | string | Product and variant title |
price | number | Selling price |
cost_price | number | Cost price |
product | object | The product the variant belongs to |
stock_entries | array | Stock levels and bin locations in each warehouse |
stock_level_at_all_warehouses | integer | Stock level across all warehouses |
available_stock_level_at_all_warehouses | integer | Stock available to sell across all warehouses |
total_quantity_sold | integer | Units sold |
created_at | datetime | Creation timestamp |
updated_at | datetime | Last modification timestamp |
variant_property_specifics
| Field | Type | Description |
|---|---|---|
variant_id | integer | Product variant identifier |
id | integer | Unique value identifier |
product_specific_id | integer | Product property value identifier |
product_property_id | integer | Property identifier |
product_property_name | string | Property name |
value | string | Property value |
product_brands
| Field | Type | Description |
|---|---|---|
id | integer | Unique brand identifier |
name | string | Brand name |
display_position | integer | Position in display order |
products_count | integer | Number of products with the brand |
product_properties
| Field | Type | Description |
|---|---|---|
id | integer | Unique property identifier |
name | string | Property name |
product_tags and tags
| Field | Type | Description |
|---|---|---|
id | integer | Unique tag identifier |
name | string | Tag name |
colour | string | Tag colour |
taggings_count | integer | Number of records with the tag |
deleted_at | datetime | Deletion timestamp |
purchase_orders
| Field | Type | Description |
|---|---|---|
id | integer | Unique purchase order identifier |
number | string | Purchase order number |
state | string | Purchase order state |
supplier | object | The supplier |
destination_warehouse | object | The warehouse that receives the stock |
purchase_order_product_variants | array | Ordered product variants and quantities |
units_ordered | integer | Units ordered |
units_received | integer | Units received |
total_including_tax | number | Total including tax |
currency_code | string | Currency of the purchase order |
expected_date | datetime | Expected delivery date |
received_at | datetime | Receipt timestamp |
created_at | datetime | Creation timestamp |
updated_at | datetime | Last modification timestamp |
suppliers
| Field | Type | Description |
|---|---|---|
id | integer | Unique supplier identifier |
name | string | Supplier name |
country | string | Country |
currency_code | string | Currency used with the supplier |
credit_limit | string | Credit limit |
active_purchase_order_count | integer | Number of open purchase orders |
completed_purchase_order_count | integer | Number of completed purchase orders |
created_at | datetime | Creation timestamp |
updated_at | datetime | Last modification timestamp |
customers
| Field | Type | Description |
|---|---|---|
id | integer | Unique customer identifier |
full_name | string | Customer name |
company_name | string | Company name |
email | string | Email address |
customer_type | string | Customer type |
billing_address | object | Billing address |
shipping_addresses | array | Shipping addresses |
payment_terms | integer | Payment terms, in days |
stores
| Field | Type | Description |
|---|---|---|
id | integer | Unique channel identifier |
name | string | Channel name |
type_code | string | Channel type, such as Shopify or Amazon |
state | string | Channel state |
currency_code | string | Currency of the channel |
country | string | Country |
default_warehouse | object | Default warehouse for the channel's orders |
pulled_orders_at | datetime | When orders were last imported from the channel |
warehouses
| Field | Type | Description |
|---|---|---|
id | integer | Unique warehouse identifier |
name | string | Warehouse name |
city | string | City |
country | string | Country |
post_code | string | Postcode |
inventory_type_code | string | Inventory type |
created_at | datetime | Creation timestamp |
updated_at | datetime | Last modification timestamp |
delivery_methods
| Field | Type | Description |
|---|---|---|
id | integer | Unique delivery method identifier |
name | string | Delivery method name |
cost | string | Delivery cost |
created_at | datetime | Creation timestamp |
updated_at | datetime | Last modification timestamp |
deleted_at | datetime | Deletion timestamp |
employees
| Field | Type | Description |
|---|---|---|
id | integer | Unique user identifier |
login | string | Login name |
email | string | Email address |
role | object | User role |
default_warehouse_id | integer | Default warehouse |
company_owner | boolean | Whether the user owns the account |
created_at | datetime | Creation timestamp |
updated_at | datetime | Last modification timestamp |
Settings
API key
A unique identifier used to authenticate and authorize requests to the Veeqo API.
Veeqo connector is available on Meltano. It is built, maintained, supported, and tested by Meltano.