Pular para o conteúdo principal

​
Endpoint

POST /api/workspace/{workspaceId}/catalogs/{catalogId}/batch/gold
Aciona o estágio de scoring Gold para uma seleção de produtos ou o catálogo inteiro. O Gold analisa cada produto contra uma rubrica de 7 estágios e produz um score de otimização (0–100), uma lista de gaps e um resumo a nível de catálogo.

​
Parâmetros de path

ParâmetroTipoObrigatórioDescrição
workspaceIdstringSimSeu ID de workspace
catalogIdstringSimO catálogo a analisar

​
Corpo da requisição

{
  "productIds": ["prod_abc", "prod_def"],
  "scope": "selection"
}

​
Resposta

{
  "results": [
    {
      "productId": "prod_abc",
      "status": "success",
      "score": 82,
      "gaps": ["secondaryImages", "gtin"],
      "missingFields": ["gtin"]
    }
  ],
  "catalogSummary": {
    "avgScore": 61.5,
    "scoreDistribution": {
      "excellent": 12,
      "good": 34,
      "warning": 28,
      "poor": 8
    },
    "topGaps": ["gtin", "description", "secondaryImages"]
  }
}

​
Limites de score

FaixaRótuloSignificado
85–100ExcelentePronto para todos os canais
65–84BomMelhorias menores recomendadas
40–64AtençãoCampos importantes ausentes
0–39RuimGaps críticos — não está pronto para feeds

​
Exemplos

curl -X POST "https://app.alana.shopping/api/workspace/ws_123/catalogs/cat_456/batch/gold" \
  -H "Authorization: Bearer sk_live_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{"scope": "all"}'

​
Respostas de erro

Status HTTPCódigoDescrição
400VALIDATION_ERRORscope ausente ou inválido
403INSUFFICIENT_PERMISSIONSChave API sem catalogs:write
404CATALOG_NOT_FOUNDCatálogo não existe no workspace
409JOB_ALREADY_RUNNINGUm job em lote já está em andamento
429RATE_LIMIT_EXCEEDEDAguarde o valor do header Retry-After
Last modified on March 18, 2026