Aller au contenu

Define o modo e os produtos de um space Loja

PUT/api/storefront/spaces/{spaceId}

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
Clé d’API:
store:write
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.

Owner ou admin da comunidade do header. `mode: all` mostra todo avulso, plano público e adicional ativo da comunidade; `mode: selected` mostra só `productIds` (avulsos e adicionais) e `planIds` (planos inteiros). Cada lista substitui a sua parte da seleção, na ordem enviada; omitida, mantém a atual; `[]` limpa. Produtos em rascunho são aceitos e só aparecem quando ativos. Produto de outra comunidade ou excluído: 400 com `param = productIds`. Opção de cobrança (produto `SUBSCRIPTION` que não é adicional) em `productIds`: 400 com `param = productIds` (escolha o plano em `planIds`). Plano de outra comunidade ou excluído: 400 com `param = planIds`. Plano `link_only` é aceito e fica guardado, mas não aparece na Loja enquanto for Somente com link. A resposta tem a forma do `GET`.

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring (uuid)

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.

Corps de la requête application/json

NomTypeDescription
modefacultatifall | selected
productIdsfacultatifstring (uuid)[]
planIdsfacultatifstring (uuid)[]

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 PUT "https://api.memberfy.net/api/storefront/spaces/<spaceId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'