Overview

The V4MOS.AI Shopify API centralizes customer, order, order-item, and product information synced from connected Shopify stores. All endpoints live under the /v1/shopify prefix and share the same pagination and authentication patterns used across the platform.

Available EndpointsCopy Anchor Link

• getCustomers/v1/shopify/customersRetrieve Shopify customers with email marketing consent and aggregated order info
• getOrders/v1/shopify/ordersRetrieve Shopify orders with payment, totals, and lifecycle timestamps
• getOrder Items/v1/shopify/orders-itemsRetrieve Shopify order line items with SKU, pricing, and discounts
• getProducts/v1/shopify/productsRetrieve Shopify products with catalog, inventory, and pricing information

AuthenticationCopy Anchor Link

All endpoints require the x-client-id and x-client-secret headers, plus the organizationId query parameter. See Authentication.

Common ParametersCopy Anchor Link

• organizationId (required) – Organization that owns the data
• integrationId – Integration ID
• integrationName – Integration name
• page – Page number (default: 1)
• limit – Records per page (default: 500, max: 5000)
• orderBy – Field used for ordering
• orderDirection – ASC or DESC
• createdStart / createdEnd – Filter by creation timestamp
• lastModifiedStart / lastModifiedEnd – Filter by last update timestamp

Resource-Specific FiltersCopy Anchor Link

Customers (/v1/shopify/customers)Copy Anchor Link

• id, email
• limit, page, and date filters listed above

Orders (/v1/shopify/orders)Copy Anchor Link

• customerId – Shopify customer ID
• storeId – Shopify store identifier
• name – Order name (e.g., #1001)
• closedDateStart / closedDateEnd
• processedDateStart / processedDateEnd

Order Items (/v1/shopify/orders-items)Copy Anchor Link

• orderId, orderName
• productId
• orderCreatedStart / orderCreatedEnd
• quantity
• name – Line item name

Products (/v1/shopify/products)Copy Anchor Link

• productType, status
• title
• publishedStart / publishedEnd
• id

Shopify Data Model HighlightsCopy Anchor Link

CustomersCopy Anchor Link

• Profile: id, email, state, verified_email
• Lifecycle: created_at, updated_at, number_of_orders, state, verified_email
• Consents: email_marketing_consent_*

OrdersCopy Anchor Link

• Status and lifecycle: cancelled_at, closed_at, processed_at, confirmed, fully_paid, source_name
• Monetary totals: total_price_set_*, total_shipping_price_set_*, total_tax_set_*, total_discounts_set_*, total_refunded_set_*, total_received_set_*
• Relationships: customer_id, customer_email, organization_id, integration_id

Order ItemsCopy Anchor Link

• Identifiers: order_id, order_name, product_id, sku
• Pricing: original_total_set_*, original_unit_price_set_*, total_discount_set_*
• Lifecycle: order_created_at, current_quantity, is_gift_card

ProductsCopy Anchor Link

• Catalog basics: title, status, product_type, category_name
• Inventory: total_inventory, tracks_inventory
• Pricing: price_range_v2_min_variant_price_*, price_range_v2_max_variant_price_*
• Publication metadata: created_at, published_at, integration_id, organization_id

ResponsesCopy Anchor Link

All responses follow the standard format:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}