Overview

A API da Tray do V4 Marketing reúne dados de clientes, pedidos e itens de pedidos provenientes das lojas Tray conectadas ao seu workspace. 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íveis

Clientes

GET /v1/tray/customers – Perfis com identificadores fiscais, dados de contato, métricas de fidelidade e endereços completos.

Pedidos

GET /v1/tray/orders – Pedidos com status, informações de envio, pagamentos, taxas e comissões.

GET /v1/tray/products – Itens de pedido (produtos vendidos) com SKU, valores, comissão e vínculo com o pedido.

Autenticação

Todos os endpoints exigem autenticação via Bearer token no header Authorization.

Parâmetros Comuns

workspaceId (obrigatório) – Workspace que possui a integração Tray

organizationId – Escopo da organização

integrationId – Conector Tray específico

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 Recurso

Clientes (`/v1/tray/customers`)

id, cnpj, cpf, name

registrationDateStart / registrationDateEnd

createdStart / createdEnd

lastModifiedStart / lastModifiedEnd

Pedidos (`/v1/tray/orders`)

id

customerId

orderStatus, status, deliveredStatus, paymentMethodType

paymentDateStart / paymentDateEnd

createdStart / createdEnd

lastModifiedStart / lastModifiedEnd

partnerId

Produtos (`/v1/tray/products`)

orderId

name

productId

category

integrationId

Destaques do Modelo de Dados Tray

Clientes

Identificadores: cnpj, cpf, rg, company_name, state_inscription

Contato e marketing: email, phone, cellphone, newsletter, last_sending_newsletter

Indicadores comerciais: total_orders, count_orders, credit_limit, discount, blocked, reseller

Endereço completo: address, number, complement, neighborhood, city, state, country, zip_code

Datas relevantes: created, registration_date, last_purchase, last_visit, last_modification, modified, inserted_at

Pedidos

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, sending_code, tracking_url, 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, store_note, customer_note, point_sale, session_id, app_id, store_segment, integration_id

Produtos (Itens de Pedido)

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, workspace_id, organization_id, document_id

Respostas

Todas as respostas seguem o padrão:

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

Endpoints Disponíveis#

Clientes#

Pedidos#

Autenticação#

Parâmetros Comuns#

Filtros Específicos por Recurso#

Clientes (/v1/tray/customers)#

Pedidos (/v1/tray/orders)#

Produtos (/v1/tray/products)#

Destaques do Modelo de Dados Tray#

Clientes#

Pedidos#

Produtos (Itens de Pedido)#

Respostas#

Endpoints Disponíveis

Clientes

Pedidos

Autenticação

Parâmetros Comuns

Filtros Específicos por Recurso

Clientes (`/v1/tray/customers`)

Pedidos (`/v1/tray/orders`)

Produtos (`/v1/tray/products`)

Destaques do Modelo de Dados Tray

Clientes

Pedidos

Produtos (Itens de Pedido)

Respostas