Skip to content

Marketplace

Visão Geral

O módulo de Marketplace é o componente vital para a expansão comercial da plataforma Uappi, permitindo que os lojistas conectem seu catálogo de produtos aos maiores canais de venda e ecossistemas de marketplace do mercado. 🚀

Através deste módulo, é possível gerenciar de forma centralizada a comunicação bidirecional com parceiros e hubs de integração, garantindo que informações críticas estejam sempre em perfeita sincronia entre a loja e o canal externo.

O objetivo principal é reduzir a complexidade operacional da multicanalidade, permitindo que o lojista administre todas as suas vendas externas diretamente pelo painel administrativo da Uappi. 🛠️

O acesso e a gestão destas integrações exigem autenticação administrativa (UserAuth) para a maioria das operações, garantindo a integridade dos dados e o controle total sobre quem pode iniciar processos de sincronização. 🔒

Entidades Envolvidas

  • Credencial de Marketplace: Representa a identidade da loja perante o marketplace. Armazena chaves de API, tokens e configurações de acesso necessárias para a comunicação. 🔑
  • Entidade de Sincronização: Refere-se aos objetos de dados que podem ser enviados ou recebidos, como product, category, brand e storage. 📦
  • Uappi Hub: O orquestrador nativo da plataforma que centraliza e distribui os dados para diversos marketplaces de forma otimizada. 🛰️
  • Status de Integração: Indica a saúde e o progresso de cada operação de sincronização, permitindo o rastreamento em tempo real de sucessos e falhas. 📶

Notas e Considerações

A sincronização de dados é, em sua maioria, um processo assíncrono.

Ao disparar uma sincronização, o sistema valida os dados iniciais e enfileira a tarefa para execução em segundo plano, garantindo que o desempenho da API não seja afetado por grandes volumes de dados. ⏳

É fundamental que as credenciais estejam corretamente configuradas e ativas.

O uso de uma credencial inválida ou inativa resultará no bloqueio imediato das operações de sincronização. ⚠️

Além disso, as regras de negócio de cada marketplace parceiro (como limites de caracteres em títulos ou obrigatoriedade de campos específicos) são tratadas por processos especializados dentro de cada integração. ✅

Sincronização de Entidades (Uappi Hub)

POST /third-party/marketplace/uappi-hub/sync

Inicia a sincronização assíncrona de entidades específicas com o Uappi Hub.

Descrição

O endpoint de Sincronização de Entidades é a porta de entrada para a atualização massiva de dados entre a plataforma Uappi e o Uappi Hub.

Ele foi projetado para lidar com grandes volumes de informação de forma eficiente, permitindo disparar a sincronia de múltiplas categorias de dados em uma única chamada. 🚀

A operação é realizada de forma totalmente assíncrona. Ao receber a requisição, o sistema valida as credenciais e enfileira os comandos de sincronização para serem processados em segundo plano.

Isso garante que a API responda instantaneamente, enquanto disparadores especializados executam a lógica pesada de integração para cada entidade selecionada (como o envio de centenas de produtos ou a atualização global de estoques). 🛠️

Este endpoint é de uso restrito e exige autenticação administrativa (UserAuth), garantindo que apenas lojistas ou sistemas autorizados possam gerenciar o fluxo de dados entre a loja e o marketplace. 🔒

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {userToken}Token de autenticação administrativo.

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
marketplaceStoreCredentialIdinteger✅ID da credencial de marketplace da loja.
entitiesarray✅Lista de strings contendo os nomes das entidades a serem sincronizadas.
entities.*string✅Nome da entidade requerida (attribute, brand, carrier, category, filter, shipping-table, storage, product).
---

Exemplo de Requisição

1curl --request POST \
2 --url {{MAIN_URL}}/third-party/marketplace/uappi-hub/sync \
3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4 --header "Content-Type: application/json" \
5 --data '{
6 "marketplaceStoreCredentialId": 1,
7 "entities": ["product", "storage", "brand"]
8 }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1true

Uappi é a melhor opção para o crescimento da sua loja!

;