benefitsOfMembership

query

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Query the membership types of all levels currently used in the store, as well as the corresponding upgrade thresholds, validity periods, etc.

Arguments

levelCode ● String

The encoding of the grade. Maximum length: 25

Return

benefitsInfo ● [BenefitsInfo]

Basic information about membership level benefits.

customPrivileges ● [CustomPrivilege]

Basic information about membership level custom previleges.

Status and error codes

For detailed information about common codes, see Status and error codes.

Example

query benefitsOfMembership

Code

query {
  benefitsOfMembership(levelCode:"gid://shopline/Membership/MLC6568224957444662294") {
    benefitsInfo{
      benefitsDescription
      benefitsIssuranceType
      benefitsUsageInstructionValue
      benefitsExpiryDateValue
      specificDate
      fixedDate
      birthBenefitsReleaseType
      rewardType
      benefitsStatus
      benefitsExpiryDateType
      benefitsIcon
      periodicallyMonths
      usageLimitsType
      daysBefore
      specificProductIds
      periodicallyDays
      autoStackLimit
      benefitsUsageInstructionType
      codeStackLimit
      productsApplicableType
      benefitsName
      usageLimitsTimes
      specificCategoryList
      benefitsDetails
    }
    customPrivileges{
      privilegeDescription
      benefitsIcon
      privilegeName
    }
  }
}

Response

{
	"data": {
		"benefitsOfMembership": {
			"benefitsInfo": [
				{
					"benefitsDetails": "1000",
					"benefitsUsageInstructionValue": "10000",
					"specificCategoryList": null,
					"usageLimitsType": "UNLIMITED",
					"autoStackLimit": true,
					"benefitsExpiryDateType": null,
					"benefitsName": null,
					"benefitsStatus": "ACTIVE",
					"benefitsUsageInstructionType": "MIN_PURCHASE_AMOUNT",
					"codeStackLimit": true,
					"periodicallyDays": null,
					"specificProductIds": null,
					"benefitsDescription": null,
					"benefitsExpiryDateValue": null,
					"birthBenefitsReleaseType": null,
					"daysBefore": null,
					"fixedDate": null,
					"periodicallyMonths": null,
					"rewardType": "CASH_VOUCHER",
					"specificDate": null,
					"benefitsIcon": null,
					"benefitsIssuranceType": null,
					"productsApplicableType": "ALL",
					"usageLimitsTimes": null
				},
				{
					"benefitsDescription": null,
					"benefitsExpiryDateType": null,
					"benefitsName": null,
					"periodicallyDays": null,
					"rewardType": "POINTS",
					"usageLimitsType": "UNLIMITED",
					"autoStackLimit": false,
					"benefitsDetails": "10",
					"benefitsStatus": "ACTIVE",
					"birthBenefitsReleaseType": null,
					"daysBefore": null,
					"periodicallyMonths": null,
					"specificDate": null,
					"specificProductIds": null,
					"benefitsIcon": "BENEFIT_2",
					"benefitsUsageInstructionType": null,
					"fixedDate": null,
					"specificCategoryList": null,
					"benefitsExpiryDateValue": null,
					"benefitsIssuranceType": null,
					"benefitsUsageInstructionValue": null,
					"codeStackLimit": false,
					"productsApplicableType": "ALL",
					"usageLimitsTimes": null
				}
			],
			"customPrivileges": []
		}
	}
}

Was this article helpful to you?

SHOPLINE

Legal