API atual/Referência completa/Produtos do seller

SEO do produto

Lê, altera e gera o slug, o título e a descrição de buscadores de um produto do seller.

SEO é o que os buscadores mostram do seu produto: endereço (slug), título e descrição. Deixe os campos vazios para a plataforma usar o nome e a descrição do produto.

Ler SEO

GET/api/v1/vendor/products/{id}/seoSeller

Ler o SEO do produto

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 produto.

Exemplo de requisição (ler)

bash

curl "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/seo" \
  -H "Authorization: Bearer $TOKEN"

Resposta (ler)

200SEO

json

{
  "slug": "camiseta-basica-algodao-preta",
  "seo_title": "Camiseta Básica Algodão Preta",
  "seo_description": "Camiseta 100% algodão.",
  "meta_keywords": "camiseta, algodão, preta"
}

Campos da resposta

slugstring

Trecho da URL pública do produto.

seo_titlestring

Título da página nos buscadores.

seo_descriptionstring

Descrição nos buscadores.

meta_keywordsstring

Palavras-chave.

canonical_urlstring

URL canônica, quando existe.

Erros (ler)

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"]}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`

Alterar SEO

Altera slug, título, descrição e palavras-chave. Mande só o que muda. Trocar o slug muda o endereço do produto, e a plataforma cria redirecionamentos 301 do endereço antigo para o novo.

PUT/api/v1/vendor/products/{id}/seoSeller

Alterar o SEO do produto

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 produto.

Corpo da requisição

slugstring

Novo slug. É normalizado (minúsculas, sem acento). Não pode ficar vazio nem repetir o de outro produto.

seo_titlestring

Título SEO.

seo_descriptionstring

Descrição SEO.

meta_keywordsstring

Palavras-chave.

Exemplo de requisição (alterar)

bash

curl -X PUT "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/seo" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "seo_title": "Camiseta Básica de Algodão | Loja Seller",
  "seo_description": "Camiseta 100% algodão em várias cores."
}'

Resposta (alterar)

200SEO atualizado

json

{
  "slug": "camiseta-basica-algodao-preta",
  "seo_title": "Camiseta Básica de Algodão | Loja Seller",
  "seo_description": "Camiseta 100% algodão em várias cores.",
  "meta_keywords": "camiseta, algodão, preta"
}

Campos da resposta

slugstring

Trecho da URL pública do produto.

seo_titlestring

Título da página nos buscadores.

seo_descriptionstring

Descrição nos buscadores.

meta_keywordsstring

Palavras-chave.

canonical_urlstring

URL canônica, quando existe.

Erros (alterar)

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	Nenhum campo de SEO no corpo.	`{"error":"no SEO fields to update","detail":"no SEO fields to update"}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`
500	Slug vazio ou já usado por outro produto (a mensagem diz qual).	`{"error":"failed to update product SEO","detail":"slug \"camiseta\" is already used by another product"}`

Monta slug, título (até 60 caracteres) e descrição (até 155) a partir do nome e da descrição do produto, ou do modelo de SEO da categoria quando ele existe, e grava o resultado. Não é uma sugestão: a chamada já salva.

POST/api/v1/vendor/products/{id}/seo/generateSeller

Gerar o SEO do produto

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 produto.

Exemplo de requisição (gerar)

bash

curl -X POST "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/seo/generate" \
  -H "Authorization: Bearer $TOKEN"

Resposta (gerar)

200SEO gerado e gravado

json

{
  "slug": "camiseta-basica-algodao-preta",
  "seo_title": "Camiseta Básica Algodão Preta",
  "seo_description": "Camiseta 100% algodão.",
  "meta_keywords": "camiseta, algodão, preta"
}

Campos da resposta

slugstring

Trecho da URL pública do produto.

seo_titlestring

Título da página nos buscadores.

seo_descriptionstring

Descrição nos buscadores.

meta_keywordsstring

Palavras-chave.

canonical_urlstring

URL canônica, quando existe.

Erros (gerar)

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"]}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`
500	Falha ao gerar ou gravar (por exemplo, slug gerado já usado).	`{"error":"failed to generate product SEO","detail":"..."}`

Veja também

Produtos do seller: visão geral

API atual/Referência completa/Produtos do seller

SEO do produto

Lê, altera e gera o slug, o título e a descrição de buscadores de um produto do seller.

SEO é o que os buscadores mostram do seu produto: endereço (slug), título e descrição. Deixe os campos vazios para a plataforma usar o nome e a descrição do produto.

Ler SEO

GET/api/v1/vendor/products/{id}/seoSeller

Ler o SEO do produto

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 produto.

Exemplo de requisição (ler)

bash

curl "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/seo" \
  -H "Authorization: Bearer $TOKEN"

Resposta (ler)

200SEO

json

{
  "slug": "camiseta-basica-algodao-preta",
  "seo_title": "Camiseta Básica Algodão Preta",
  "seo_description": "Camiseta 100% algodão.",
  "meta_keywords": "camiseta, algodão, preta"
}

Campos da resposta

slugstring

Trecho da URL pública do produto.

seo_titlestring

Título da página nos buscadores.

seo_descriptionstring

Descrição nos buscadores.

meta_keywordsstring

Palavras-chave.

canonical_urlstring

URL canônica, quando existe.

Erros (ler)

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"]}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`

Alterar SEO

Altera slug, título, descrição e palavras-chave. Mande só o que muda. Trocar o slug muda o endereço do produto, e a plataforma cria redirecionamentos 301 do endereço antigo para o novo.

PUT/api/v1/vendor/products/{id}/seoSeller

Alterar o SEO do produto

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 produto.

Corpo da requisição

slugstring

Novo slug. É normalizado (minúsculas, sem acento). Não pode ficar vazio nem repetir o de outro produto.

seo_titlestring

Título SEO.

seo_descriptionstring

Descrição SEO.

meta_keywordsstring

Palavras-chave.

Exemplo de requisição (alterar)

bash

curl -X PUT "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/seo" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "seo_title": "Camiseta Básica de Algodão | Loja Seller",
  "seo_description": "Camiseta 100% algodão em várias cores."
}'

Resposta (alterar)

200SEO atualizado

json

{
  "slug": "camiseta-basica-algodao-preta",
  "seo_title": "Camiseta Básica de Algodão | Loja Seller",
  "seo_description": "Camiseta 100% algodão em várias cores.",
  "meta_keywords": "camiseta, algodão, preta"
}

Campos da resposta

slugstring

Trecho da URL pública do produto.

seo_titlestring

Título da página nos buscadores.

seo_descriptionstring

Descrição nos buscadores.

meta_keywordsstring

Palavras-chave.

canonical_urlstring

URL canônica, quando existe.

Erros (alterar)

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	Nenhum campo de SEO no corpo.	`{"error":"no SEO fields to update","detail":"no SEO fields to update"}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`
500	Slug vazio ou já usado por outro produto (a mensagem diz qual).	`{"error":"failed to update product SEO","detail":"slug \"camiseta\" is already used by another product"}`

Gerar SEO

POST/api/v1/vendor/products/{id}/seo/generateSeller

Gerar o SEO do produto

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 produto.

Exemplo de requisição (gerar)

bash

curl -X POST "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/seo/generate" \
  -H "Authorization: Bearer $TOKEN"

Resposta (gerar)

200SEO gerado e gravado

json

{
  "slug": "camiseta-basica-algodao-preta",
  "seo_title": "Camiseta Básica Algodão Preta",
  "seo_description": "Camiseta 100% algodão.",
  "meta_keywords": "camiseta, algodão, preta"
}

Campos da resposta

slugstring

Trecho da URL pública do produto.

seo_titlestring

Título da página nos buscadores.

seo_descriptionstring

Descrição nos buscadores.

meta_keywordsstring

Palavras-chave.

canonical_urlstring

URL canônica, quando existe.

Erros (gerar)

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"]}`
403	O produto existe mas é de outro seller (ou da loja).	`{"error":"you do not have access to this product"}`
404	Produto não existe.	`{"error":"product not found"}`
500	Falha ao gerar ou gravar (por exemplo, slug gerado já usado).	`{"error":"failed to generate product SEO","detail":"..."}`

Veja também

Produtos do seller: visão geral