Overview

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

Available EndpointsCopy Anchor Link

• getCustomers/v1/tray/customersRetrieve Tray customer commerce, engagement, and lifecycle metrics
• getOrders/v1/tray/ordersRetrieve Tray orders with payment, shipping, and status data
• getProducts/v1/tray/productsRetrieve products sold in Tray orders with SKU, commission, and category 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 Tray integration
• 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 entity creation date
• lastModifiedStart / lastModifiedEnd – Filter by last update timestamp

Resource-Specific FiltersCopy Anchor Link

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

• id
• registrationDateStart / registrationDateEnd
• createdStart / createdEnd
• lastModifiedStart / lastModifiedEnd

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

• id
• customerId
• orderStatus, status, deliveredStatus, paymentMethodType
• paymentDateStart / paymentDateEnd
• createdStart / createdEnd
• lastModifiedStart / lastModifiedEnd
• partnerId

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

• orderId
• name
• productId
• category
• integrationId

Tray Data Model HighlightsCopy Anchor Link

CustomersCopy Anchor Link

• Contact and marketing: email, newsletter, last_sending_newsletter
• Commerce insights: total_orders, count_orders, credit_limit, discount, blocked, reseller
• Lifecycle timestamps: created, registration_date, last_purchase, last_visit, last_modification, modified, inserted_at

OrdersCopy Anchor Link

• Payment and totals: partial_total, taxes, discount, total, payment_method, payment_method_rate, installment, payment_date, coupon
• Shipping: shipment, shipment_value, shipment_date, delivery_date, shipment_integrator, delivery_time, is_traceable
• Status: status, order_status, order_status_type, delivered, delivered_status, shipping_cancelled, has_payment, has_shipment, has_invoice
• Operational metadata: partner_id, point_sale, session_id, app_id, store_segment, integration_id

Products (Order Items)Copy Anchor Link

• Identification: product_id, sold_product_id, order_id, name, brand, model
• Pricing: price, cost_price, original_price, commission
• Inventory context: quantity, category, product_image, url
• Relationships: integration_id, organization_id, organization_id, document_id

ResponsesCopy Anchor Link

All responses follow the standard format:

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