tray-api

Referência rápida de todos os endpoints da API da Tray, aceita nome do recurso como filtro

Guia rápido para configuração inicial de integração com a API da Tray

Valida o código de integração com a Tray verificando problemas comuns e boas práticas

Guia de referência rápida para escolher o agente correto.

Especialista em migração de dados para a Tray. Utilize quando precisar migrar dados de outras plataformas de e-commerce (Shopify, WooCommerce, Magento, VTEX, Nuvemshop, etc.) para a Tray, incluindo produtos, clientes, pedidos e categorias.

Assistente guiado para configuração inicial de aplicativos que integram com a API da Tray. Utilize quando um desenvolvedor está iniciando um novo projeto de integração e precisa de ajuda com configuração OAuth, primeiras chamadas à API, configuração de webhooks e estrutura inicial do aplicativo.

Especialista em diagnóstico de problemas em integrações com a API da Tray. Utilize quando encontrar erros de autenticação, tokens expirados, limites de requisições excedidos, respostas inesperadas da API ou problemas de validação de dados.

Especialista em gestão de catálogo na Tray. Utilize para operações em massa de produtos, variações, categorias, marcas, imagens e kits. Auxilia em importação de CSV, sincronização de estoque, reestruturação de categorias e gestão de centros de distribuição (MultiCD).

Especialista em gestão de pedidos na Tray. Utilize para operações complexas envolvendo o ciclo completo do pedido: criação, atualização de status, emissão de notas fiscais, geração de etiquetas de envio e fluxo de cancelamento.

Especialista em migração de dados do Magento 2 (Adobe Commerce) para a Tray. Utilize quando precisar extrair produtos, atributos configuráveis, categorias, clientes e pedidos do Magento e converter para o formato da API Tray. Inclui mapeamento de campos, tratamento de configurable products, attribute sets e particularidades da API REST do Magento.

Especialista em migração de dados da Nuvemshop (Tiendanube) para a Tray. Utilize quando precisar extrair produtos, variantes, categorias, clientes e pedidos da Nuvemshop e converter para o formato da API Tray. Estrutura mais similar à Tray entre todas as plataformas, facilitando o mapeamento direto.

Especialista em migração de dados do Shopify para a Tray. Utilize quando precisar extrair produtos, variantes, coleções, clientes e pedidos do Shopify e converter para o formato da API Tray. Inclui mapeamento de campos, tratamento de variantes, coleções para categorias e particularidades da API GraphQL/REST do Shopify.

Especialista em migração de dados da VTEX para a Tray. Utilize quando precisar extrair produtos, SKUs, especificações, categorias, clientes e pedidos da VTEX e converter para o formato da API Tray. Inclui mapeamento de campos, tratamento da estrutura Produto→SKU da VTEX e particularidades das APIs VTEX.

Especialista em migração de dados do WooCommerce para a Tray. Utilize quando precisar extrair produtos, categorias, clientes e pedidos do WooCommerce (WordPress) e converter para o formato da API Tray. Inclui mapeamento de campos, tratamento de produtos variáveis, taxonomias e particularidades da WP REST API.

Autenticação e autorização na API da Tray. Utilize quando o desenvolvedor precisar implementar o fluxo OAuth 2.0, gerar chaves de acesso (access_token), renovar tokens expirados via refresh_token, ou tratar erros de autenticação na plataforma Tray. Inclui o fluxo completo de 3 etapas, campos de resposta, tempos de expiração e códigos de erro.

API de Características de Produtos da Tray. Utilize quando o desenvolvedor precisar gerenciar características (propriedades) dos produtos, incluindo cadastro, atualização, consulta e exclusão. Permite criar características globais reutilizáveis e associar valores específicos a cada produto (ex: cor, tamanho, material, voltagem).

API de carrinho de compras da Tray. Permite criar, consultar, atualizar e excluir carrinhos, incluindo suporte a kits de produtos. Contém 6 endpoints.

API de Categorias da Tray. Utilize quando o desenvolvedor precisar gerenciar a árvore de categorias da loja, incluindo consulta hierárquica, criação de subcategorias, reordenação e exclusão. Inclui consulta de árvore completa e dados individuais por ID.

API de Clientes da Tray. Utilize quando o desenvolvedor precisar gerenciar dados de clientes da loja: listagem, consulta, cadastro, atualização e exclusão. Inclui campos de pessoa física (CPF) e jurídica (CNPJ), validações brasileiras e gestão de newsletter.

API de Configuração de Frete da Tray. Utilize quando o desenvolvedor precisar gerenciar métodos de envio e tabelas de faixa de CEP da loja, incluindo criação, atualização e exclusão de formas de envio e suas respectivas tabelas de CEP com faixas de peso, preços e prazos. Essencial para configurar regras de frete personalizadas por região e faixa de peso.

API completa de cupons de desconto da Tray (discount_coupons). Permite criar, editar, excluir e consultar cupons, além de gerenciar relacionamentos com clientes, produtos, categorias, marcas e fretes. Contém 21 endpoints.

API de Emissores de Etiqueta da Tray. Utilize quando o desenvolvedor precisar integrar geração de etiquetas de envio, cadastrando URLs de etiqueta e vinculando-as a pedidos.

API de Endereços de Clientes da Tray. Utilize quando o desenvolvedor precisar gerenciar os endereços cadastrados dos clientes, incluindo listagem, consulta individual, criação e exclusão. Suporta endereços de entrega e cobrança, com campos completos do padrão brasileiro (CEP, bairro, cidade, estado, complemento).

API de Etiquetas do HUB da Tray. Utilize quando o desenvolvedor precisar criar ou consultar etiquetas de envio através do sistema HUB de integração logística da Tray.

API de Etiquetas do Mercado Livre da Tray. Utilize quando o desenvolvedor precisar consultar etiquetas de envio geradas pelo Mercado Livre para pedidos originados neste marketplace.

API de Frete da Tray. Utilize quando o desenvolvedor precisar calcular valores de frete e consultar métodos de envio disponíveis. Inclui cálculo de frete por CEP com peso e dimensões, listagem de formas de envio configuradas na loja, e integração com gateways de frete como Frete-X API para cotação automática.

API de Imagens de Produtos e Variações da Tray. Utilize quando o desenvolvedor precisar fazer upload, atualizar ou remover imagens de produtos e variações. Inclui formatos aceitos, método de envio e posicionamento de imagens.

API de Informação Adicional da Tray. Utilize quando o desenvolvedor precisar gerenciar campos customizados de informação que podem ser vinculados a produtos, incluindo criação, atualização, vinculação e exclusão.

API de Informações da Loja da Tray. Utilize quando o desenvolvedor precisar consultar dados de configuração da loja como nome, domínio, CNPJ, endereço, plano contratado e status da loja.

API de Kits de Produtos da Tray. Utilize quando o desenvolvedor precisar gerenciar kits (combos/bundles) de produtos, incluindo listagem, consulta individual, criação e atualização. Permite agrupar múltiplos produtos em um único kit com quantidades específicas, ideal para combos promocionais e pacotes de produtos.

Nova API de Listagem de Carrinho da Tray. Utilize quando o desenvolvedor precisar listar todos os carrinhos de compra da loja com paginação. Endpoint separado da API principal de carrinho.

API de Lista de Preço B2B da Tray. Utilize quando o desenvolvedor precisar gerenciar tabelas de preço diferenciadas para clientes B2B e atacado, incluindo criação de listas, gestão de valores por produto/variação.

API de Marcas da Tray. Utilize quando o desenvolvedor precisar gerenciar as marcas (fabricantes) dos produtos da loja, incluindo listagem, consulta individual, criação, atualização e exclusão. Inclui campos de nome, slug, descrição e imagem da marca, além de paginação e filtros.

API de Multi-CD (Centros de Distribuição) da Tray. Utilize quando o desenvolvedor precisar gerenciar múltiplos centros de distribuição, incluindo cadastro, atualização, exclusão de CDs, gestão de estoque por produto/variação em cada CD, e configuração de prioridade e cobertura regional. Inclui documentação de webhooks para sincronização de estoque entre sistemas.

API de Newsletter da Tray. Utilize quando o desenvolvedor precisar gerenciar assinaturas de newsletter da loja, incluindo listagem de assinantes, inscrição e confirmação de cadastro.

API de Notas Fiscais (NF-e) da Tray. Utilize quando o desenvolvedor precisar gerenciar notas fiscais eletrônicas associadas a pedidos, incluindo listagem geral, consulta por ID, consulta por pedido, criação e atualização. Inclui campos como número, série, chave de acesso, CFOP, link do DANFE e valor total, essenciais para integração com ERPs e sistemas fiscais.

API de Pagamentos da Tray. Utilize quando o desenvolvedor precisar gerenciar informações de pagamento da loja, incluindo listagem de pagamentos, consulta individual, criação, atualização, exclusão, opções de pagamento disponíveis e configurações. Suporta múltiplos tipos de pagamento: cartão de crédito, boleto bancário, PIX, transferência bancária e depósito.

API de Palavras-Chave da Tray. Utilize quando o desenvolvedor precisar consultar palavras-chave de SEO associadas à loja. API somente leitura.

API de Parceiros da Tray. Utilize quando o desenvolvedor precisar gerenciar parceiros/revendedores da loja, incluindo listagem, consulta, cadastro, atualização e exclusão.

API de Pedidos da Tray. Utilize quando o desenvolvedor precisar gerenciar o ciclo completo de pedidos: listagem com filtros, consulta de dados simples e completos, criação, atualização, cancelamento, e gestão de produtos dentro do pedido. Inclui todos os campos, status e fluxos de pedido.

API de Perfis de Clientes da Tray. Utilize quando o desenvolvedor precisar gerenciar perfis (grupos/segmentos) de clientes da loja, incluindo criação, consulta, atualização, exclusão e associação/desassociação de clientes a perfis. Útil para segmentação de clientes, preços diferenciados (B2B/B2C) e regras de desconto por grupo.

API de Produtos Vendidos da Tray. Utilize quando o desenvolvedor precisar consultar o histórico de vendas e analytics de produtos vendidos na loja. API somente leitura com filtros de data.

API de Produtos da Tray. Utilize quando o desenvolvedor precisar listar, consultar, cadastrar, atualizar ou excluir produtos no catálogo de uma loja Tray. Inclui todos os campos do produto (nome, preço, estoque, EAN, NCM, dimensões, SEO), filtros de listagem, paginação, ordenação e exclusão de kits.

API de Scripts Externos da Tray. Utilize quando o desenvolvedor precisar gerenciar scripts JavaScript customizados injetados na vitrine da loja, incluindo listagem, cadastro, atualização e exclusão.

API de Status de Pedido da Tray. Utilize quando o desenvolvedor precisar gerenciar os status personalizados de pedidos da loja, incluindo listagem, consulta individual, criação, atualização e exclusão. Permite configurar nome, descrição, cores e tipo do status para personalizar o fluxo de pedidos.

API de Usuários da Tray. Utilize quando o desenvolvedor precisar listar os usuários administrativos da loja. API somente leitura.

API de Variações de Produtos da Tray. Utilize quando o desenvolvedor precisar gerenciar variantes de produtos (SKUs) como diferentes tamanhos, cores ou modelos. Inclui listagem, consulta, cadastro, atualização, exclusão e informações sobre limitações de variações por produto.

Skill de entrada para qualquer trabalho de integração com a API da Tray. Estabelece as regras invariantes da plataforma (OAuth como query param, payloads envolvidos na chave do recurso, expiração de tokens, rate limit, validação de dados brasileiros) e orienta para a skill específica do recurso. Sempre carregue esta skill antes de gerar código contra a API Tray.

Sistema de Notificação (Webhook) da Tray. Utilize quando o desenvolvedor precisar implementar notificações em tempo real para alterações em produtos, pedidos, clientes, variações e configurações da loja. Inclui todos os escopos suportados, formato de payload, lógica de retry e boas práticas de implementação.

2 hooks across 2 events