Vai al contenuto

Atualiza products

PUT/api/products/{id}

Auth
Richiede un token
Chi può:
owner
admin
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

Owner ou admin. Aceita `directLinkEnabled` (boolean opcional) para ligar ou desligar a compra por link direto de um produto avulso; omitido, mantém o valor atual. `prerequisiteGroupIds` (array de UUID opcional) substitui os planos que o adicional exige; `[]` limpa, omitido mantém. Mesmas validações da criação: grupo de outra comunidade ou grupo em que o produto está dá 400. A resposta traz `prerequisiteGroupIds`. **Obsoleto na escrita (F-37):** prefira `addOnProductIds` no plano; este campo continua aceito e gravando. `commitmentMonths` (1 a 36, ou `null` para tirar o contrato) muda a duração do contrato (F-35); omitido, mantém. É conferido contra o produto depois da atualização: só `SUBSCRIPTION` `MONTHLY` (senão 400, `param = commitmentMonths`). Vale para assinaturas novas e para a renovação do contrato das existentes; uma assinatura feita sem contrato continua sem. `installmentInterestPayer` (`BUYER` ou `ORGANIZATION`; F-43): quem paga os juros de parcelamento no cartão. Ausente não muda. **`status: ACTIVE` é publicar** e segue as regras de `POST .../publish`: sem informações comerciais `APPROVED`, 403 com a mensagem traduzida que aponta onde preenchê-las; com a moeda do produto diferente da do país aprovado, 400 (`param = currency`). As mesmas regras valem ao trocar `currency` de um produto já `ACTIVE`. Editar qualquer outro campo, de rascunho ou de produto no ar, não exige aprovação.

Parametri

NomeDoveTipoDescrizione
idobbligatoriopathstring

Header

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

Corpo della richiesta application/json

NomeTipoDescrizione
titlefacoltativostring
descriptionfacoltativostringHTML.
shortDescriptionfacoltativostring
internalNamefacoltativostringNome visto só pela equipe.
bannerUrlfacoltativostring (uri)
featuredImageUrlfacoltativostring (uri)
slugfacoltativostring
typefacoltativoSUBSCRIPTION | ONE_TIME | INSTALLMENT
pricefacoltativonumber≥ 0.01
billingIntervalfacoltativoHOURLY | DAILY | WEEKLY | MONTHLY | YEARLYSó para `SUBSCRIPTION`.
trialDaysfacoltativointeger≥ 0, ≤ 365
requiresCardForTrialfacoltativoboolean
allowCancellationfacoltativoboolean
commitmentMonthsfacoltativointegerFidelidade (F-35). Só `SUBSCRIPTION` `MONTHLY`. · ≥ 1, ≤ 36
installmentsfacoltativointegerPara `INSTALLMENT`. · ≥ 2, ≤ 24
installmentPricefacoltativonumber≥ 0.01
allowedPaymentMethodsfacoltativostring[]Métodos aceitos no checkout, como `CREDIT_CARD`, `PIX` e `BOLETO`.
maxInstallmentsfacoltativointeger≥ 1, ≤ 12
installmentInterestPayerfacoltativoBUYER | ORGANIZATION
feePayerfacoltativoORGANIZATION | BUYER
accessDurationfacoltativointegerDias de acesso; ausente = vitalício. · ≥ 1
hasStockfacoltativoboolean
stockQuantityfacoltativointeger≥ 0
isHighlightedfacoltativoboolean
directLinkEnabledfacoltativoboolean
sortOrderfacoltativointeger≥ 0
spaceIdsfacoltativostring (uuid)[]
subscriptionGroupIdsfacoltativostring (uuid)[]
prerequisiteGroupIdsfacoltativostring (uuid)[]Obsoleto na escrita (F-37); prefira `addOnProductIds` no plano.
thankYouMessagefacoltativostringmax 5000
redirectUrlfacoltativostring (uri)
metadatafacoltativoobject

Risposte

CodiceDescrizione
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Esempio con curl

curl -X PUT "https://api.memberfy.net/api/products/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'