API atual/Referência completa/Lives (Live Commerce)

Produtos em destaque

Adiciona ou remove produtos da vitrine mostrada ao lado do vídeo da live.

Os produtos em destaque são a vitrine da live: cada um aparece com foto, preço e botão de compra enquanto o vídeo roda. Estas rotas exigem um privilégio de catálogo do seller, não o de configurações.

Destacar um produto

POST/api/v1/vendor/live-sessions/{id}/featured-productsSeller

Adiciona um produto à vitrine da sessão

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da sessão.

Corpo da requisição

product_iduuidobrigatório

Id do produto a destacar.

positioninteger

Aceito mas ignorado: o produto entra no fim da lista (maior posição + 1).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/live-sessions/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/featured-products" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "1c5e8a30-92b4-4d6f-8e21-5a7b9c0d3e44"
}'

200Produto adicionado

json

{
  "message": "added"
}

Remover um destaque

DELETE/api/v1/vendor/live-sessions/{id}/featured-products/{productId}Seller

Remove um produto da vitrine da sessão

O produto continua no catálogo; só sai da vitrine desta sessão. Remover um produto que não estava destacado também responde 200.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da sessão.

productIduuidobrigatório

Id do produto.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/vendor/live-sessions/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/featured-products/1c5e8a30-92b4-4d6f-8e21-5a7b9c0d3e44" \
  -H "Authorization: Bearer $TOKEN"

200Produto removido

json

{
  "message": "removed"
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário do seller (equipe) não tem nenhum dos privilégios exigidos. O dono da loja nunca recebe este erro.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog","vendor_view_catalog","vendor_manage_products","vendor_manage_master","vendor_manage_mix","vendor_manage_quotes","vendor_manage_features","vendor_import_products"]}`
403	O módulo Live Commerce está desligado nesta loja.	`{"error":"module_disabled","module":"live-commerce"}`
404	O id não é um UUID ou a sessão não existe.	`{"error":"LIVE_SESSION_NOT_FOUND"}`
403	A sessão pertence a outro seller.	`{"error":"SESSION_OWNERSHIP_REQUIRED"}`
409	O produto já está na vitrine desta sessão.	`{"error":"FEATURED_PRODUCT_ALREADY_EXISTS","detail":"product is already featured in this session"}`
400	`product_id` ausente ou que não existe, ou JSON inválido.	`{"error":"FEATURED_PRODUCT_ADD_FAILED","detail":"session_id and product_id are required"}`

Veja também

Produtos em destaque

Adiciona ou remove produtos da vitrine mostrada ao lado do vídeo da live.

Destacar um produto

POST/api/v1/vendor/live-sessions/{id}/featured-productsSeller

Adiciona um produto à vitrine da sessão

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da sessão.

Corpo da requisição

product_iduuidobrigatório

Id do produto a destacar.

positioninteger

Aceito mas ignorado: o produto entra no fim da lista (maior posição + 1).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/live-sessions/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/featured-products" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "1c5e8a30-92b4-4d6f-8e21-5a7b9c0d3e44"
}'

200Produto adicionado

json

{
  "message": "added"
}

Remover um destaque

DELETE/api/v1/vendor/live-sessions/{id}/featured-products/{productId}Seller

Remove um produto da vitrine da sessão

O produto continua no catálogo; só sai da vitrine desta sessão. Remover um produto que não estava destacado também responde 200.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da sessão.

productIduuidobrigatório

Id do produto.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/vendor/live-sessions/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/featured-products/1c5e8a30-92b4-4d6f-8e21-5a7b9c0d3e44" \
  -H "Authorization: Bearer $TOKEN"

200Produto removido

json

{
  "message": "removed"
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário do seller (equipe) não tem nenhum dos privilégios exigidos. O dono da loja nunca recebe este erro.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog","vendor_view_catalog","vendor_manage_products","vendor_manage_master","vendor_manage_mix","vendor_manage_quotes","vendor_manage_features","vendor_import_products"]}`
403	O módulo Live Commerce está desligado nesta loja.	`{"error":"module_disabled","module":"live-commerce"}`
404	O id não é um UUID ou a sessão não existe.	`{"error":"LIVE_SESSION_NOT_FOUND"}`
403	A sessão pertence a outro seller.	`{"error":"SESSION_OWNERSHIP_REQUIRED"}`
409	O produto já está na vitrine desta sessão.	`{"error":"FEATURED_PRODUCT_ALREADY_EXISTS","detail":"product is already featured in this session"}`
400	`product_id` ausente ou que não existe, ou JSON inválido.	`{"error":"FEATURED_PRODUCT_ADD_FAILED","detail":"session_id and product_id are required"}`