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

Trabalhos de revisão

Cria, acompanha e cancela um trabalho de revisão em que a IA propõe novos textos para produtos do seller.

Um trabalho de revisão agrupa vários produtos. Ele passa por queued, running e termina em review, quando as propostas estão prontas. Na rota o caminho diz fix-jobs, mas este é o trabalho de revisão assistida.

Criar revisão

Cria o trabalho e o executa em segundo plano. Para cada produto, a IA propõe novos valores para os campos pedidos, sem gravar. A resposta devolve só o job_id.

POST/api/v1/vendor/catalog-quality/review-jobsSeller

Criar um trabalho de revisão

Cabeçalhos

Authorizationstringobrigatório

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

Corpo da requisição

product_idsarray of stringobrigatório

Produtos a revisar. Todos precisam ser seus.

fieldsarray of stringobrigatório

descriptionshort_descseo_titleseo_description

Campos a propor. Os fora da lista são descartados.

Exemplo de requisição (criar)

bash

curl -X POST "$BASE_URL/api/v1/vendor/catalog-quality/review-jobs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_ids": [
    "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
    "0d6c7b0e-3f55-4d2c-9f0e-1d3b6d1f6a10"
  ],
  "fields": [
    "description",
    "seo_title"
  ]
}'

Resposta (criar)

202Trabalho criado

json

{
  "job_id": "8c7b6a50-0001-4d2e-9f3a-4b5c6d7e8f90"
}

Campos da resposta

job_idstring (uuid)

Id do trabalho. Use nas demais rotas como {id}.

Erros (criar)

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"]}`
400	`product_ids` ausente ou vazio, ou corpo inválido.	`{"error":"product_ids required"}`
403	O recurso de preenchimento por IA não está disponível na loja.	`{"error":"ai fix unavailable","detail":"AI Product Fill is not available"}`
404	Algum produto não é seu.	`{"error":"not found"}`
422	Nenhum campo permitido em `fields`.	`{"error":"failed","detail":"no allowed fields"}`

Consultar o trabalho

GET/api/v1/vendor/catalog-quality/fix-jobs/{id}Seller

Consultar o andamento

Cabeçalhos

Authorizationstringobrigatório

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

Parâmetros de caminho

idstring (uuid)obrigatório

Id do trabalho de revisão (job_id).

Exemplo de requisição (consultar)

bash

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

Resposta (consultar)

200Trabalho

json

{
  "id": "8c7b6a50-0001-4d2e-9f3a-4b5c6d7e8f90",
  "status": "review",
  "fields": [
    "description",
    "seo_title"
  ],
  "total": 2,
  "processed": 2,
  "succeeded": 0,
  "failed": 0,
  "processed_items": 2,
  "failed_items": 0
}

Campos da resposta

idstring (uuid)

Id do trabalho.

statusstring

queuedrunningreviewapplyingdonecancelled

Fase do trabalho.

fieldsarray of string

Campos que a revisão propõe.

totalinteger

Produtos no trabalho.

processedinteger

Produtos já processados.

succeededinteger

Processados com sucesso.

failedinteger

Processados com falha.

processed_itemsinteger

Apelido de processed.

failed_itemsinteger

Apelido de failed.

Erros (consultar)

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"]}`
404	O trabalho não existe ou é de outro seller.	`{"error":"not found"}`

Cancelar

POST/api/v1/vendor/catalog-quality/fix-jobs/{id}/cancelSeller

Cancelar o trabalho

Cabeçalhos

Authorizationstringobrigatório

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

Parâmetros de caminho

idstring (uuid)obrigatório

Id do trabalho de revisão (job_id).

Exemplo de requisição (cancelar)

bash

curl -X POST "$BASE_URL/api/v1/vendor/catalog-quality/fix-jobs/$JOB_ID/cancel" \
  -H "Authorization: Bearer $TOKEN"

Resposta (cancelar)

200Cancelado

json

{
  "status": "cancelled"
}

Campos da resposta

statusstring

Sempre cancelled na resposta.

Erros (cancelar)

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"]}`
404	O trabalho não existe ou é de outro seller.	`{"error":"not found"}`

Veja também

Qualidade do catálogo: visão geral

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

Trabalhos de revisão

Cria, acompanha e cancela um trabalho de revisão em que a IA propõe novos textos para produtos do seller.

Criar revisão

Cria o trabalho e o executa em segundo plano. Para cada produto, a IA propõe novos valores para os campos pedidos, sem gravar. A resposta devolve só o job_id.

POST/api/v1/vendor/catalog-quality/review-jobsSeller

Criar um trabalho de revisão

Cabeçalhos

Authorizationstringobrigatório

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

Corpo da requisição

product_idsarray of stringobrigatório

Produtos a revisar. Todos precisam ser seus.

fieldsarray of stringobrigatório

descriptionshort_descseo_titleseo_description

Campos a propor. Os fora da lista são descartados.

Exemplo de requisição (criar)

bash

curl -X POST "$BASE_URL/api/v1/vendor/catalog-quality/review-jobs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_ids": [
    "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
    "0d6c7b0e-3f55-4d2c-9f0e-1d3b6d1f6a10"
  ],
  "fields": [
    "description",
    "seo_title"
  ]
}'

Resposta (criar)

202Trabalho criado

json

{
  "job_id": "8c7b6a50-0001-4d2e-9f3a-4b5c6d7e8f90"
}

Campos da resposta

job_idstring (uuid)

Id do trabalho. Use nas demais rotas como {id}.

Erros (criar)

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"]}`
400	`product_ids` ausente ou vazio, ou corpo inválido.	`{"error":"product_ids required"}`
403	O recurso de preenchimento por IA não está disponível na loja.	`{"error":"ai fix unavailable","detail":"AI Product Fill is not available"}`
404	Algum produto não é seu.	`{"error":"not found"}`
422	Nenhum campo permitido em `fields`.	`{"error":"failed","detail":"no allowed fields"}`

Consultar o trabalho

GET/api/v1/vendor/catalog-quality/fix-jobs/{id}Seller

Consultar o andamento

Cabeçalhos

Authorizationstringobrigatório

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

Parâmetros de caminho

idstring (uuid)obrigatório

Id do trabalho de revisão (job_id).

Exemplo de requisição (consultar)

bash

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

Resposta (consultar)

200Trabalho

json

{
  "id": "8c7b6a50-0001-4d2e-9f3a-4b5c6d7e8f90",
  "status": "review",
  "fields": [
    "description",
    "seo_title"
  ],
  "total": 2,
  "processed": 2,
  "succeeded": 0,
  "failed": 0,
  "processed_items": 2,
  "failed_items": 0
}

Campos da resposta

idstring (uuid)

Id do trabalho.

statusstring

queuedrunningreviewapplyingdonecancelled

Fase do trabalho.

fieldsarray of string

Campos que a revisão propõe.

totalinteger

Produtos no trabalho.

processedinteger

Produtos já processados.

succeededinteger

Processados com sucesso.

failedinteger

Processados com falha.

processed_itemsinteger

Apelido de processed.

failed_itemsinteger

Apelido de failed.

Erros (consultar)

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"]}`
404	O trabalho não existe ou é de outro seller.	`{"error":"not found"}`

Cancelar

POST/api/v1/vendor/catalog-quality/fix-jobs/{id}/cancelSeller

Cancelar o trabalho

Cabeçalhos

Authorizationstringobrigatório

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

Parâmetros de caminho

idstring (uuid)obrigatório

Id do trabalho de revisão (job_id).

Exemplo de requisição (cancelar)

bash

curl -X POST "$BASE_URL/api/v1/vendor/catalog-quality/fix-jobs/$JOB_ID/cancel" \
  -H "Authorization: Bearer $TOKEN"

Resposta (cancelar)

200Cancelado

json

{
  "status": "cancelled"
}

Campos da resposta

statusstring

Sempre cancelled na resposta.

Erros (cancelar)

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"]}`
404	O trabalho não existe ou é de outro seller.	`{"error":"not found"}`

Veja também

Qualidade do catálogo: visão geral