Commerce data

Commerce endpoints provide orders, subscriptions and products from your connected store. Use the documented VYG response fields when building reports or integrations.

Requirements

Customer data features require a connected Shopify store and access to these features in VYG. If a request returns 403 insufficient_scope, check the store connection and your credential's permissions. Contact your VYG account manager if access is unavailable.

Data freshness

Orders, subscriptions and insights reflect the latest store data available in VYG. Product information can take about 30 seconds to reflect a change in Shopify.

Money and completed orders

• Monetary amounts are decimal strings in the store's currency, such as "120.00". They are not integer counts of cents.
• Spend totals, lifetime value and insights include completed orders (state = "complete"). Pending, draft, delivered, cancelled and refunded orders are excluded from these calculations.
• Order-listing endpoints can return orders in other states. Filter by state when needed.

Product catalog

Use product endpoints to retrieve the connected store's catalog.

• Pass the returned next_cursor as cursor to retrieve the next page. Stop when it is null.
• The Shopify connection needs read_products or write_products access. Missing product permissions return 403 insufficient_scope.
• A rate-limited request returns 429 rate_limited. Wait for the number of seconds in Retry-After before trying again.
• An unknown product ID returns 404 not_found.
• If product data is temporarily unavailable, retry a 503 unavailable response with backoff.

Check the HTTP status and error.code. Error messages can change.

Next steps

• Commerce reference: orders, subscriptions and products.
• Integrations reference: connected apps.
• Insights: definitions of customer metrics.
• Errors: response codes and retry guidance.