Producten
https://scintillating-wolf-799.eu-west-1.convex.site/v1/products Het aanbod van de omgeving. Toegangsproducten die niet te koop zijn blijven erbuiten, want die zouden in een aanbodlijst alleen verwarren.
Rechten: catalog:read. Deze gegevens gaan niet over personen.
Dit is het aanbod van een omgeving, zoals het op de betaalpagina's staat. Samen met de prijzen is dit het enige deel van de API dat geen persoonsgegevens bevat, dus het is wat je zonder bezwaar aan een websitebouwer kunt geven.
Toegangsproducten blijven erbuiten. Dat zijn producten die niet te koop zijn en alleen worden gebruikt om iemand handmatig toegang te geven; in een aanbodlijst zouden ze alleen verwarren.
Zonder de parameter status krijg je alles, inclusief inactieve producten. Toon je het huidige aanbod op een website, vraag dan status=active. Wie historie toont heeft de rest juist nodig, want een oud product hoort bij oude bestellingen.
Het veld accessDuration zegt hoe lang toegang geldt na aankoop, als type en value. Is het null, dan is de toegang onbeperkt. Een prijs kan die instelling overschrijven, dus kijk ook daar als het bedrag en de duur samen moeten kloppen.
Parameters
| Naam | Uitleg |
|---|---|
status | active, inactive of coming_soon. Zonder deze parameter komt alles mee. |
limit | Aantal items per pagina, 1 tot en met 500. Standaard 100. Een waarde daarbuiten geeft een fout in plaats van een stille correctie. |
cursor | De nextCursor uit het vorige antwoord. Blijf doorbladeren tot nextCursor null is, ook als een pagina niet vol zit. |
Voorbeeld
curl "https://scintillating-wolf-799.eu-west-1.convex.site/v1/products" \
-H "Authorization: Bearer <je sleutel>" Antwoord
{
"items": [
{
"id": "js7…",
"name": "Jaarlidmaatschap",
"slug": "jaarlidmaatschap",
"description": "Toegang tot alle trainingen en de community",
"status": "active",
"displayOrder": 1,
"accessDuration": {
"type": "months",
"value": 12
},
"createdAt": 1759276800000
}
],
"nextCursor": null
} Velden
| Veld | Type | Betekenis |
|---|---|---|
id | string | Vaste verwijzing naar dit product. |
name | string | Naam zoals de klant hem ziet. |
slug | string of null | Het adresdeel waaronder het product bij de klant staat. |
description | string of null | Korte omschrijving. |
status | string | active, inactive of coming_soon. |
displayOrder | getal | Volgorde in overzichten. |
accessDuration | object of null | Hoe lang toegang geldt na aankoop, als type en value. Null betekent onbeperkt. |
createdAt | getal | Aanmaakmoment. |
Veelgestelde vragen
- Waar staan de bedragen?
- Bij de prijzen. Een product kan meerdere prijzen hebben, bijvoorbeeld per maand en per jaar, dus het bedrag hoort daar en niet bij het product.
- Wat betekent status coming_soon?
- Het product is aangemaakt en zichtbaar, maar nog niet te koop. Handig om alvast aan te kondigen.
Hierna nodig
- Prijzen (GET /prices)
Werkt je aanroep niet zoals verwacht, kijk dan bij de foutcodes en wat ze betekenen. Heb je nog geen sleutel, dan legt de kennisbank uit hoe je er een aanmaakt.