Aller au contenu

Detalha products por id

GET/api/products/{idOrSlug}

Auth
Jeton requis
Clé d’API:
store:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Traz `prerequisiteGroupIds`: os grupos de assinatura (planos) que o produto exige quando é um adicional; vazio quando não exige nenhum. Traz também `commitmentMonths` (duração do contrato em meses, ou `null`). Traz `pricingMode` (`MONEY`, `POINTS` ou `POINTS_OR_MONEY`) e `pointsPrice` (o preço em pontos, `null` em `MONEY`), para todos os papéis. **Quem vê o quê:** owner, admin, finance e SuperAdmin recebem o produto completo. A gestão recebe também `activeSubscriptionsCount` (assinaturas em vigor: `ACTIVE`, `TRIALING`, `PAST_DUE` ou `PAUSED`). Qualquer outro papel recebe só o público (sem `hasStock`, `stockQuantity`, `internalName`, `totalSales`, `activeSubscriptionsCount`, `metadata`, `requiresApproval`; com `soldOut`), e um produto que não está `ACTIVE` responde 404.

Paramètres

NomEmplacementTypeDescription
idOrSlugobligatoirepathstring

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

StatutDescription
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/products/<idOrSlug>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"