API atual/Referência completa/Sessões ao vivo

Produtos em destaque

Adiciona e remove produtos da vitrine que aparece ao lado da transmissão.

Adicionar produto em destaque

Adiciona um produto à vitrine que aparece ao lado da transmissão, com botão de comprar. O produto entra sempre no fim da lista. A vitrine exibe o item mais recente primeiro.

POST/api/v1/admin/live-sessions/{id}/featured-productsAdmin

Coloca um produto na vitrine da sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

product_iduuidobrigatório

Produto do catálogo.

positioninteger

Aceito, mas ignorado: a posição é sempre a última.

Exemplo de requisição (Adicionar produto)

bash

curl -X POST "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/featured-products" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d"
}'

Resposta (Adicionar produto)

200Produto adicionado

json

{
  "message": "added"
}

Erros (Adicionar produto)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
409	O produto já está na vitrine.	`{"error":"FEATURED_PRODUCT_ALREADY_EXISTS","detail":"product is already featured in this session"}`
400	Corpo inválido, `product_id` vazio, ou produto/sessão inexistente.	`{"error":"FEATURED_PRODUCT_ADD_FAILED","detail":"o registro referenciado não existe (campo relacionado a \"session_products_product_id\"). Crie ou confira esse registro antes de vinculá-lo."}`

Remover produto em destaque

Remove o produto da vitrine. O produto continua no catálogo. Remover um produto que não está na vitrine não dá erro.

DELETE/api/v1/admin/live-sessions/{id}/featured-products/{productId}Admin

Tira um produto da vitrine da sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

productIduuidobrigatório

Produto a remover.

Exemplo de requisição (Remover produto)

bash

curl -X DELETE "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/featured-products/7bc1d5e9-a9a4-457b-866f-bbb3879d258d" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Remover produto)

200Produto removido

json

{
  "message": "removed"
}

Erros (Remover produto)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
400	`productId` ou `id` que não são UUID, ou falha de banco.	`{"error":"FEATURED_PRODUCT_REMOVE_FAILED","detail":"..."}`

Veja também

Produtos em destaque

Adiciona e remove produtos da vitrine que aparece ao lado da transmissão.

Adicionar produto em destaque

Adiciona um produto à vitrine que aparece ao lado da transmissão, com botão de comprar. O produto entra sempre no fim da lista. A vitrine exibe o item mais recente primeiro.

POST/api/v1/admin/live-sessions/{id}/featured-productsAdmin

Coloca um produto na vitrine da sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

product_iduuidobrigatório

Produto do catálogo.

positioninteger

Aceito, mas ignorado: a posição é sempre a última.

Exemplo de requisição (Adicionar produto)

bash

curl -X POST "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/featured-products" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d"
}'

Resposta (Adicionar produto)

200Produto adicionado

json

{
  "message": "added"
}

Erros (Adicionar produto)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
409	O produto já está na vitrine.	`{"error":"FEATURED_PRODUCT_ALREADY_EXISTS","detail":"product is already featured in this session"}`
400	Corpo inválido, `product_id` vazio, ou produto/sessão inexistente.	`{"error":"FEATURED_PRODUCT_ADD_FAILED","detail":"o registro referenciado não existe (campo relacionado a \"session_products_product_id\"). Crie ou confira esse registro antes de vinculá-lo."}`

Remover produto em destaque

Remove o produto da vitrine. O produto continua no catálogo. Remover um produto que não está na vitrine não dá erro.

DELETE/api/v1/admin/live-sessions/{id}/featured-products/{productId}Admin

Tira um produto da vitrine da sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

productIduuidobrigatório

Produto a remover.

Exemplo de requisição (Remover produto)

bash

curl -X DELETE "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/featured-products/7bc1d5e9-a9a4-457b-866f-bbb3879d258d" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Remover produto)

200Produto removido

json

{
  "message": "removed"
}

Erros (Remover produto)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
400	`productId` ou `id` que não são UUID, ou falha de banco.	`{"error":"FEATURED_PRODUCT_REMOVE_FAILED","detail":"..."}`