Visão Geral

A API da Tray da V4MOS.AI reúne dados de clientes, pedidos e itens de pedidos provenientes das lojas Tray conectadas ao seu organization. Os endpoints ficam sob o prefixo /v1/tray e compartilham o mesmo modelo de autenticação, paginação e metadados utilizados pelas demais integrações.

Endpoints DisponíveisCopiar link da seção

• getClientes/v1/tray/customersRetorna métricas de comércio, engajamento e ciclo de vida dos clientes Tray
• getPedidos/v1/tray/ordersRetorna pedidos Tray com dados de pagamento, envio e status
• getProdutos/v1/tray/productsRetorna produtos vendidos em pedidos Tray com SKU, comissão e informações de categoria

AutenticaçãoCopiar link da seção

Todos os endpoints exigem os headers x-client-id e x-client-secret, além do query parameter organizationId. Veja Autenticação.

Parâmetros ComunsCopiar link da seção

• organizationId (obrigatório) – Organização que possui a integração Tray
• integrationId – Id da integração
• integrationName – Nome da integração
• page – Número da página (padrão: 1)
• limit – Registros por página (padrão: 500, máx: 5000)
• orderBy – Campo utilizado para ordenação
• orderDirection – ASC ou DESC
• createdStart / createdEnd – Data de criação
• lastModifiedStart / lastModifiedEnd – Data de última atualização

Filtros Específicos por RecursoCopiar link da seção

Clientes (/v1/tray/customers)Copiar link da seção

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

Pedidos (/v1/tray/orders)Copiar link da seção

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

Produtos (/v1/tray/products)Copiar link da seção

• orderId
• name
• productId
• category
• integrationId

Destaques do Modelo de Dados TrayCopiar link da seção

ClientesCopiar link da seção

• Contato e marketing: email, newsletter, last_sending_newsletter
• Indicadores comerciais: total_orders, count_orders, credit_limit, discount, blocked, reseller
• Datas relevantes: created, registration_date, last_purchase, last_visit, last_modification, modified, inserted_at

PedidosCopiar link da seção

• Pagamentos e totais: partial_total, taxes, discount, total, payment_method, payment_method_rate, installment, payment_date, coupon
• Envio: 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
• Metadados operacionais: partner_id, point_sale, session_id, app_id, store_segment, integration_id

Produtos (Itens de Pedido)Copiar link da seção

• Identificação: product_id, sold_product_id, order_id, name, brand, model
• Preços: price, cost_price, original_price, commission
• Contexto comercial: quantity, category, product_image, url
• Relacionamentos: integration_id, organization_id, organization_id, document_id

RespostasCopiar link da seção

Todas as respostas seguem o padrão:

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