Overview

The V4MOS.AI VTEX API brings together order and order item data from VTEX stores connected to your organization. Endpoints share the /v1/vtex prefix and use the same authentication, pagination, and metadata envelope as every other V4MOS.AI integration.

Available EndpointsCopy Anchor Link

• getOrders/v1/vtex/ordersRetrieve VTEX sales orders with status, totals breakdown, payment, shipping, and marketing attribution (UTMs, coupon).
• getOrder items/v1/vtex/orders/itemsRetrieve VTEX order line items with SKU, pricing, brand, and commission data.

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 VTEX integration
• userId – User scope
• integrationName – Integration name
• orderId – Filter rows belonging to a single order
• dateStart / dateEnd – Date-range filter (creation_date for orders, inserted_at for items)
• page – Page number (default: 1)
• limit – Records per page (default: 500, max: 5000)

Resource-Specific FiltersCopy Anchor Link

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

• status – VTEX order status (e.g. invoiced, canceled)

PaginationCopy Anchor Link

Responses return meta.page, meta.limit, meta.hasNextPage, and meta.hasPreviousPage. Iterate while hasNextPage is true.