Overview

The V4MOS.AI Nuvemshop API gives you the raw records synced from the Nuvemshop accounts connected to your organization: orders, order items, abandoned checkouts, customers, catalog, coupons, promotions 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/nuvemshop prefix and the same authentication, pagination and response format.

Getting startedCopy Anchor Link

Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication.

1. Connect Nuvemshop in app.v4mos.ai (Connected accounts) and wait for the first sync.
2. Call any endpoint below with your organizationId, for example GET /v1/nuvemshop/orders?organizationId=….
3. Every row carries integration_id and integration_name: the connected account it came from. To read a single account, pass that value as integrationId.

Available endpointsCopy Anchor Link

• getOrders/v1/nuvemshop/ordersOne row per order: status, payment and shipping status, totals, discounts, coupons, promotions, shipping and UTM attribution.
• getOrder items/v1/nuvemshop/order-itemsOne row per order line item: product, variant, SKU, quantity, price, cost and promotions, with the order status and dates.
• getAbandoned checkouts/v1/nuvemshop/abandoned-checkoutsOne row per checkout the shopper started and did not finish: items, totals, coupons and shipping option.
• getCustomers/v1/nuvemshop/customersOne row per customer of the store, with marketing consent and total spent.
• getProducts/v1/nuvemshop/productsOne row per catalog product: brand, publication, shipping flags, category and variant count.
• getProduct variants/v1/nuvemshop/variantsOne row per product variant: SKU, prices, cost, stock and visibility.
• getCoupons/v1/nuvemshop/couponsOne row per coupon registered in the store: type, value, validity and usage limits.
• getPromotions/v1/nuvemshop/promotionsOne row per promotion configured in the store: status, discount type and validity.
• getInventory snapshots/v1/nuvemshop/inventory-snapshotsOne row per stock reading of a variant at a location: available quantity at snapshotat.

ResourcesCopy Anchor Link

Pagination and filtersCopy Anchor Link

• page (default 1) and limit (default 500, max 5000). meta.hasNextPage says whether another page exists; rows come in a stable order, so walk the pages until it is false.
• dateFrom / dateTo (YYYY-MM-DD, inclusive) filter by the date column shown in the table above. Resources without one reject them.
• integrationId keeps the rows of one connected account.
• Answers are cached for 30 minutes and the data is synced once a day — see Data sync.

Response formatCopy Anchor Link

{
  "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.