API atual/Referência completa/Qualidade do catálogo

Resumo e fila de qualidade

Mostra a nota média dos produtos do seller, os critérios mais fracos e a fila de produtos a melhorar, e recalcula as notas.

Comece por aqui para decidir o que corrigir. summary dá o panorama; products entrega a lista de trabalho já ordenada; recompute força a atualização das notas depois de uma grande carga.

Resumo

GET/api/v1/vendor/catalog-quality/summarySeller

Resumo da qualidade

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição (resumo)

bash

curl "$BASE_URL/api/v1/vendor/catalog-quality/summary" \
  -H "Authorization: Bearer $TOKEN"

Resposta (resumo)

200Resumo

json

{
  "avg_score": 70,
  "histogram": [
    {
      "bucket": "0-20",
      "count": 0
    },
    {
      "bucket": "21-40",
      "count": 1
    },
    {
      "bucket": "41-60",
      "count": 12
    },
    {
      "bucket": "61-80",
      "count": 40
    },
    {
      "bucket": "81-100",
      "count": 5
    }
  ],
  "top_issues": [
    {
      "dim": "photos",
      "count": 30
    },
    {
      "dim": "description",
      "count": 22
    },
    {
      "dim": "attributes",
      "count": 1
    },
    {
      "dim": "seo",
      "count": 50
    },
    {
      "dim": "price",
      "count": 0
    },
    {
      "dim": "variations",
      "count": 1
    }
  ],
  "by_vendor": []
}

Campos da resposta

avg_scoreinteger

Nota média dos seus produtos.

histogramarray

Quantos produtos em cada faixa: 0-20, 21-40, 41-60, 61-80, 81-100.

top_issuesarray

Para cada critério (dim), quantos produtos estão abaixo do máximo dele.

by_vendorarray

Sempre vazio para o seller.

Erros (resumo)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`

Fila por impacto

GET/api/v1/vendor/catalog-quality/productsSeller

Fila de produtos por impacto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de consulta

dimstring

photosdescriptionattributesseopricevariations

Só produtos com nota baixa neste critério (veja o aviso abaixo).

max_scoreinteger

Só produtos com nota até este valor. 0 ou ausente = sem limite.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 25

Itens por página, de 1 a 100.

Exemplo de requisição (fila)

bash

curl "$BASE_URL/api/v1/vendor/catalog-quality/products?max_score=60&per_page=25" \
  -H "Authorization: Bearer $TOKEN"

Resposta (fila)

200Fila

json

{
  "products": [
    {
      "product_id": "c3f92551-9dda-4fc7-b518-353d1c4e4035",
      "name": "Notebook Slim Rosa",
      "image_url": "/uploads/dfe2555e/notebook.png",
      "score": 70,
      "dims": {
        "photos": 15,
        "description": 0,
        "attributes": 25,
        "seo": 10,
        "price": 10,
        "variations": 10
      },
      "views_30d": 4,
      "impact": 120,
      "needs_photo": false
    }
  ],
  "total": 1
}

Campos da resposta

productsarray

Produtos do maior para o menor impact.

product_idstring (uuid)

Produto.

namestring

Nome.

image_urlstring | null

Imagem principal.

scoreinteger

Nota de 0 a 100.

dimsobject

Pontos por critério: photos, description, attributes, seo, price, variations.

views_30dinteger

Visitas nos últimos 30 dias.

impactinteger

Prioridade: (100 - nota) vezes um fator de visitas. Maior = melhorar antes.

needs_photoboolean

true se o produto não tem nenhuma imagem.

totalinteger

Total que atende ao filtro.

Erros (fila)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`

Recalcular

Recalcula a nota de todos os seus produtos em segundo plano. A resposta é imediata e não espera o fim.

POST/api/v1/vendor/catalog-quality/recomputeSeller

Recalcular as notas

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição (recalcular)

bash

curl -X POST "$BASE_URL/api/v1/vendor/catalog-quality/recompute" \
  -H "Authorization: Bearer $TOKEN"

Resposta (recalcular)

202Recálculo na fila

json

{
  "status": "queued"
}

Campos da resposta

statusstring

Sempre queued.

Erros (recalcular)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`

Veja também

Qualidade do catálogo: visão geral

API atual/Referência completa/Qualidade do catálogo

Resumo e fila de qualidade

Mostra a nota média dos produtos do seller, os critérios mais fracos e a fila de produtos a melhorar, e recalcula as notas.

Comece por aqui para decidir o que corrigir. summary dá o panorama; products entrega a lista de trabalho já ordenada; recompute força a atualização das notas depois de uma grande carga.

Resumo

GET/api/v1/vendor/catalog-quality/summarySeller

Resumo da qualidade

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição (resumo)

bash

curl "$BASE_URL/api/v1/vendor/catalog-quality/summary" \
  -H "Authorization: Bearer $TOKEN"

Resposta (resumo)

200Resumo

json

{
  "avg_score": 70,
  "histogram": [
    {
      "bucket": "0-20",
      "count": 0
    },
    {
      "bucket": "21-40",
      "count": 1
    },
    {
      "bucket": "41-60",
      "count": 12
    },
    {
      "bucket": "61-80",
      "count": 40
    },
    {
      "bucket": "81-100",
      "count": 5
    }
  ],
  "top_issues": [
    {
      "dim": "photos",
      "count": 30
    },
    {
      "dim": "description",
      "count": 22
    },
    {
      "dim": "attributes",
      "count": 1
    },
    {
      "dim": "seo",
      "count": 50
    },
    {
      "dim": "price",
      "count": 0
    },
    {
      "dim": "variations",
      "count": 1
    }
  ],
  "by_vendor": []
}

Campos da resposta

avg_scoreinteger

Nota média dos seus produtos.

histogramarray

Quantos produtos em cada faixa: 0-20, 21-40, 41-60, 61-80, 81-100.

top_issuesarray

Para cada critério (dim), quantos produtos estão abaixo do máximo dele.

by_vendorarray

Sempre vazio para o seller.

Erros (resumo)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`

Fila por impacto

GET/api/v1/vendor/catalog-quality/productsSeller

Fila de produtos por impacto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de consulta

dimstring

photosdescriptionattributesseopricevariations

Só produtos com nota baixa neste critério (veja o aviso abaixo).

max_scoreinteger

Só produtos com nota até este valor. 0 ou ausente = sem limite.

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 25

Itens por página, de 1 a 100.

Exemplo de requisição (fila)

bash

curl "$BASE_URL/api/v1/vendor/catalog-quality/products?max_score=60&per_page=25" \
  -H "Authorization: Bearer $TOKEN"

Resposta (fila)

200Fila

json

{
  "products": [
    {
      "product_id": "c3f92551-9dda-4fc7-b518-353d1c4e4035",
      "name": "Notebook Slim Rosa",
      "image_url": "/uploads/dfe2555e/notebook.png",
      "score": 70,
      "dims": {
        "photos": 15,
        "description": 0,
        "attributes": 25,
        "seo": 10,
        "price": 10,
        "variations": 10
      },
      "views_30d": 4,
      "impact": 120,
      "needs_photo": false
    }
  ],
  "total": 1
}

Campos da resposta

productsarray

Produtos do maior para o menor impact.

product_idstring (uuid)

Produto.

namestring

Nome.

image_urlstring | null

Imagem principal.

scoreinteger

Nota de 0 a 100.

dimsobject

Pontos por critério: photos, description, attributes, seo, price, variations.

views_30dinteger

Visitas nos últimos 30 dias.

impactinteger

Prioridade: (100 - nota) vezes um fator de visitas. Maior = melhorar antes.

needs_photoboolean

true se o produto não tem nenhuma imagem.

totalinteger

Total que atende ao filtro.

Erros (fila)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`

Recalcular

Recalcula a nota de todos os seus produtos em segundo plano. A resposta é imediata e não espera o fim.

POST/api/v1/vendor/catalog-quality/recomputeSeller

Recalcular as notas

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição (recalcular)

bash

curl -X POST "$BASE_URL/api/v1/vendor/catalog-quality/recompute" \
  -H "Authorization: Bearer $TOKEN"

Resposta (recalcular)

202Recálculo na fila

json

{
  "status": "queued"
}

Campos da resposta

statusstring

Sempre queued.

Erros (recalcular)

Status	Quando	Corpo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	Token que não é de seller, ou usuário sem o privilégio exigido pela rota.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}`

Veja também

Qualidade do catálogo: visão geral