Get Packages for Online Store

Request

Public endpoint that gets packages for use in the online store

Path

tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

Restrictions

membership_package_idsArray of strings, >= 0 items(Membership Packages)required

membership_package_restrictionstring(Membership Package Restriction)

Enum:"exclude""include""none"

membership_type_idsArray of strings, >= 0 items(Membership Types)required

membership_type_restrictionstring(Membership Type Restriction)

Enum:"exclude""include""none"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/packages/{tenantId}/public/onlineStore' \
  -H 'Content-Type: application/json' \
  -d '{
    "membership_package_ids": [
      "string"
    ],
    "membership_package_restriction": "exclude",
    "membership_type_ids": [
      "string"
    ],
    "membership_type_restriction": "exclude"
  }'

Responses

The store was retrieved

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

packagesArray of objects

typesArray of objects

Response

{
  "packages": [
    { … }
  ],
  "types": [
    { … }
  ]
}