Ferramentas do catálogo do seller
Rotas de apoio ao catálogo do seller: anexos, imagens, características, campos do importador, perguntas de clientes e tarefas em lote.
Esta seção reúne as rotas de apoio que o painel do seller (lojista) usa ao redor do cadastro de produtos: arquivos anexos (manual, ficha técnica), exclusão de imagens, as características que descrevem os produtos (cor, tamanho, marca), a lista de campos que o importador de planilhas aceita, as perguntas dos clientes na página do produto e o acompanhamento de tarefas em lote.
O cadastro em si (criar, alterar e listar produtos) é outra área: aqui está o que gira em torno dele.
Como funciona
- Descreva o produtoLeia
GET /featureseGET /features/{id}/variantspara saber que características e valores existem (por exemplo Cor: Azul, Verde). - Gerencie arquivosAltere ou apague um anexo (
PUT/DELETE /attachments/{attachmentId}) e apague imagens (DELETE /images/{id}). - Importe em massaUse
GET /import-export/fields/{entity}para saber que colunas o importador entende e monte o mapeamento. - Responda os clientes
GET /product-questionslista as perguntas dos seus produtos;PUT /product-questions/{id}/answerresponde. - Acompanhe lotesQuando uma operação em lote vira tarefa, siga o progresso em
GET /bulk-jobs/{id}ou/stream.
Conceitos-chave
Característica e variante
Uma característica (feature) é um atributo de produto: Cor, Material, Marca. As características do tipo lista têm variantes, os valores permitidos (Cor: Azul, Verde). A plataforma usa os tipos select, multi_select, brand, author e color com variantes, e text, number, date e bool com valor livre. group agrupa outras características.
Anexo
Um anexo é um arquivo ligado ao produto (manual em PDF, ficha técnica) que o cliente baixa na página do produto. O arquivo em si é guardado com o upload de mídia; o anexo guarda a URL e os dados.
Pergunta de cliente
Qualquer visitante pode perguntar na página do produto. A pergunta nasce pending. Ao ser respondida vira answered e passa a ser pública. O administrador pode rejectar (moderar) ou archivear.
Tarefa em lote
Operações em lote (como clonar muitos mestres) viram tarefa quando alcançam 50 registros ou mais. A tarefa tem estado queued, running, done, failed ou interrupted e contadores de progresso.
Endpoints
| Método | Caminho | Para que serve | Página |
|---|---|---|---|
| PUT | /api/v1/vendor/attachments/{attachmentId} | Alterar um anexo | Anexos e imagens |
| DELETE | /api/v1/vendor/attachments/{attachmentId} | Apagar um anexo | Anexos e imagens |
| DELETE | /api/v1/vendor/images/{id} | Apagar uma imagem de produto | Anexos e imagens |
| GET | /api/v1/vendor/features | Listar características | Características |
| GET | /api/v1/vendor/features/{id}/variants | Listar os valores de uma característica | Características |
| GET | /api/v1/vendor/import-export/fields/{entity} | Campos aceitos pelo importador | Campos do importador |
| GET | /api/v1/vendor/product-questions | Listar perguntas dos seus produtos | Perguntas de clientes |
| PUT | /api/v1/vendor/product-questions/{id}/answer | Responder uma pergunta | Perguntas de clientes |
| GET | /api/v1/vendor/bulk-jobs/{id} | Estado de uma tarefa em lote | Tarefas em lote |
| GET | /api/v1/vendor/bulk-jobs/{id}/stream | Progresso em tempo real (SSE) | Tarefas em lote |
Erros comuns
- Esquecer que
PUT /attachmentsregrava a posição e a descrição. Campos omitidos comopositionedescriptionvoltam a0e vazio. Mande-os sempre. - Tentar criar característica por aqui. O seller só lê; a criação é do administrador.
- Passar
pageesperando paginar a lista padrão de características. A paginação vale para cada tipo separadamente (veja a página). - Responder duas vezes uma pergunta. A segunda chamada não sobrescreve: devolve a pergunta como está.
- Acompanhar tarefa de outra pessoa. A tarefa só é visível a quem a iniciou; outro usuário recebe
404. - Usar
EventSourcedo navegador no stream. Ele não envia o cabeçalhoAuthorization. Usefetche leia o corpo em partes.