Overview
WooCommerce data synced to V4MOS.AI, through the integration's own endpoints
The V4MOS.AI WooCommerce API gives you the raw records synced from the WooCommerce accounts connected to your organization: orders, order items, refunds, customers, catalog and stock. Rows come as they were synced, with the warehouse column names (snake_case), so you can load them straight into your BI. All endpoints use the /v1/woocommerce prefix and the same authentication, pagination and response format.
Getting started
Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication.
- Connect WooCommerce in app.v4mos.ai (Connected accounts) and wait for the first sync.
- Call any endpoint below with your
organizationId, for exampleGET /v1/woocommerce/orders?organizationId=…. - Every row carries
integration_idandintegration_name: the connected account it came from. To read a single account, pass that value asintegrationId.
Available endpoints
- getOrders
/v1/woocommerce/ordersOne row per order: status, totals, discounts, taxes, shipping, payment, coupons and UTM attribution. - getOrder items
/v1/woocommerce/order-itemsOne row per order line item: product, SKU, quantity, price, taxes and unit cost, with the order status and dates. - getRefunds
/v1/woocommerce/refundsOne row per refund issued against an order, with its amount. - getCustomers
/v1/woocommerce/customersOne row per registered customer of the store. - getProducts
/v1/woocommerce/productsOne row per catalog product: type, status, SKU, prices, stock and category. - getProduct variants
/v1/woocommerce/variantsOne row per sellable SKU of the catalog (product variation or simple product): attributes, prices and stock. - getInventory snapshots
/v1/woocommerce/inventory-snapshotsOne row per stock reading of a SKU: available quantity and stock status at snapshotat.
Resources
| Endpoint | What one row is | dateFrom / dateTo filter |
|---|---|---|
GET /v1/woocommerce/orders | One row per order: status, totals, discounts, taxes, shipping, payment, coupons and UTM attribution. | date_created_gmt |
GET /v1/woocommerce/order-items | One row per order line item: product, SKU, quantity, price, taxes and unit cost, with the order status and dates. | order_date_created_gmt |
GET /v1/woocommerce/refunds | One row per refund issued against an order, with its amount. | order_date_modified_gmt |
GET /v1/woocommerce/customers | One row per registered customer of the store. | date_created_gmt |
GET /v1/woocommerce/products | One row per catalog product: type, status, SKU, prices, stock and category. | date_created_gmt |
GET /v1/woocommerce/variants | One row per sellable SKU of the catalog (product variation or simple product): attributes, prices and stock. | date_created_gmt |
GET /v1/woocommerce/inventory-snapshots | One row per stock reading of a SKU: available quantity and stock status at snapshot_at. | snapshot_at |
Pagination and filters
page(default 1) andlimit(default 500, max 5000).meta.hasNextPagesays whether another page exists; rows come in a stable order, so walk the pages until it isfalse.dateFrom/dateTo(YYYY-MM-DD, inclusive) filter by the date column shown in the table above. Resources without one reject them.integrationIdkeeps the rows of one connected account.- Answers are cached for 30 minutes and the data is synced once a day — see Data sync.
Personal data
Some WooCommerce resources carry personal data of your customers and contacts (such as email). Store and process it according to the LGPD and your own privacy policy.
Response format
{
"data": [{ "...": "one object per row, with the columns listed on each endpoint" }],
"meta": {
"page": 1,
"limit": 500,
"hasNextPage": true,
"hasPreviousPage": false
}
}Amounts and large counters (fields with format: decimal or format: int64 in each endpoint schema) come as strings, e.g. "125.50", so no precision is lost. Convert them to a decimal type on your side.