storeMembershipType
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 levels and paid membership types created in the membership mechanism currently used in the store, as well as the corresponding upgrade thresholds, validity periods, etc.
Return
If the benefit is active.
The code of level membership.
The icon of the level.
The name of level membership. Up to 25 characters.
Relevant only when membershipType = LEVEL. Higher the filed indicates a higher level.
Threshold amount for the level when membershipType = LEVEL.
Lock-in amount for the level when membershipType = LEVEL.
Lock-in type for the level when membershipType = LEVEL.
The current active membership mechanism of the store, and all levels below are in this type of mechanism.
Time unit of the paid membership validity.
Time value of the paid membership validity.
Price for the paid membership when membershipType = PAID.
Threshold type for the level when membershipType = LEVEL.
Status and error codes
For detailed information about common codes, see Status and error codes.
Example
query storeMembership Type
Code
query {
storeMembershipType {
levelCode
levelName
membershipType
levelOrder
levelIcon
upgradeStandard
levelThreshold
lockinStandard
lockinRule
paidPrice
paidExpiryDateType
paidExpiryDateValue
}
}
Response
{
"data": {
"storeMembershipType": [
{
"lockinRule": "0",
"lockinStandard": "ACCUMULATED",
"membershipType": "LEVEL",
"paidExpiryDateValue": null,
"paidPrice": null,
"levelIcon": "LEVEL_2",
"levelOrder": 1,
"levelThreshold": "10000",
"paidExpiryDateType": null,
"upgradeStandard": "ACCUMULATED",
"levelCode": "gid://shopline/Membership/MLC6568224957444662294",
"levelName": "membership_level_1"
},
{
"paidExpiryDateType": null,
"upgradeStandard": "ACCUMULATED",
"levelIcon": "LEVEL_3",
"levelOrder": 2,
"levelThreshold": "20000",
"paidExpiryDateValue": null,
"paidPrice": null,
"levelCode": "gid://shopline/Membership/MLC6568226048886449178",
"levelName": "membership_level_2",
"lockinRule": "0",
"lockinStandard": "ACCUMULATED",
"membershipType": "LEVEL"
}
]
},
"extensions": {
"dataloader": {
"individual-statistics": {
"LD-com.shopline.pixiu.psm.graphql.api.service.CollectionQueryGqlService-checkInCollectionForLoader": {
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadCount": 0,
"loadErrorCount": 0,
"loadErrorRatio": 0,
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.DescriptionQueryGqlService-get": {
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadCount": 0,
"loadErrorCount": 0,
"loadErrorRatio": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.ProductQueryGqlService-optionsForLoader": {
"batchInvokeCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"loadErrorCount": 0,
"batchLoadCount": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadCount": 0,
"loadErrorRatio": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.ShopQueryGqlService-maxProductOptions": {
"loadErrorCount": 0,
"loadErrorRatio": 0,
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0,
"loadCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0
},
"LD-com.joyy.shopline.soul.appstore.api.service.publication.PublicationQueryGQLService-publicationsForLoader": {
"batchLoadCount": 0,
"batchLoadExceptionRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadErrorCount": 0,
"batchInvokeCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadRatio": 0,
"loadCount": 0,
"loadErrorRatio": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.CollectionQueryGqlService-checkHasProductForLoader": {
"loadErrorCount": 0,
"loadErrorRatio": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"cacheHitRatio": 0,
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"loadCount": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.CollectionQueryGqlService-seoLoader": {
"batchInvokeCount": 0,
"loadCount": 0,
"loadErrorRatio": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadErrorCount": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.InventoryQueryGqlService-listItemForLoader": {
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"cacheHitRatio": 0,
"loadCount": 0,
"loadErrorCount": 0,
"loadErrorRatio": 0,
"batchLoadExceptionCount": 0,
"cacheHitCount": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.InventoryQueryGqlService-listLevelByVariantForLoader": {
"batchInvokeCount": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadErrorCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"loadCount": 0,
"loadErrorRatio": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.ProductQueryGqlService-inMarketForLoader": {
"batchInvokeCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"loadCount": 0,
"loadErrorCount": 0,
"batchLoadCount": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadErrorRatio": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.ProductQueryGqlService-onlineStoreUrlForLoader": {
"batchInvokeCount": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadErrorRatio": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"loadCount": 0,
"loadErrorCount": 0
},
"LD-com.shopline.pixiu.psm.graphql.api.service.ShopQueryGqlService-maxProductVariants": {
"cacheHitCount": 0,
"loadErrorCount": 0,
"loadErrorRatio": 0,
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0,
"cacheHitRatio": 0,
"loadCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0
},
"LD-com.shopline.benefitrights.giftcard.graphql.api.service.ShopQueryGqlService-canCreateGiftCards": {
"cacheHitRatio": 0,
"loadErrorCount": 0,
"loadCount": 0,
"loadErrorRatio": 0,
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0
},
"LD-com.shopline.ec.merchant.ugc.i18n.api.interfaces.UgcI18nGraphqlApi-getUgcLocaleResources": {
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"loadCount": 0,
"loadErrorCount": 0,
"loadErrorRatio": 0,
"batchLoadExceptionCount": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0
}
},
"overall-statistics": {
"loadCount": 0,
"loadErrorCount": 0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0,
"batchLoadRatio": 0,
"cacheHitCount": 0,
"cacheHitRatio": 0,
"loadErrorRatio": 0,
"batchInvokeCount": 0,
"batchLoadCount": 0
}
},
"metrics": {
"dataFetcherMetrics": [
{
"dfServiceIdentity": "com.shopline.ec.openapi.interfaces.MemberGqlApi@getMemberLevelDef",
"dfErrorCode": null,
"dfProtocol": "dubbo",
"dfRootCoordinate": "/storeMembershipType",
"dfRt": 161
}
],
"graphQLMetrics": {
"countryCode": null,
"includeDeprecatedField": false,
"merchantId": "4200114610",
"namespace": "admin",
"startTimeMillis": 1721892914103,
"storePlus": false,
"customizedClientIp": "218.253.130.212",
"operation": "QUERY",
"saleChannel": null,
"parseRt": 1,
"appId": "265337",
"appKey": "936eda168305ed82cee702c6822354ee6de2e802",
"clientIp": "218.253.130.212",
"fieldCount": 37,
"startParseTimeMillis": 1721892914103,
"storeId": "1641993455937",
"successType": "SUCCESS",
"errorFieldsCount": 0,
"ratelimitRemaining": 0,
"version": "v20241201",
"executionId": "9122c41f-2539-4f5a-a2dd-4523bbfd4962",
"loaderCount": 0,
"ratelimitPermits": 0,
"traceId": "d080ac286bd322e997073d280b7265b9",
"deepLevel": 2,
"endParseTimeMillis": 1721892914104,
"includeQuery": false,
"languageCode": null,
"rt": 176,
"tenant": "ec20"
}
},
"tracing": {
"execution": {
"resolvers": [
{
"path": [
"storeMembershipType"
],
"returnType": "[MemberLevel]",
"startOffset": 6046952,
"duration": 167971130,
"fieldName": "storeMembershipType",
"parentType": "Query"
},
{
"duration": 14794,
"fieldName": "levelCode",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"levelCode"
],
"returnType": "String",
"startOffset": 174208835
},
{
"returnType": "String",
"startOffset": 174274594,
"duration": 8223,
"fieldName": "levelName",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"levelName"
]
},
{
"fieldName": "membershipType",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"membershipType"
],
"returnType": "MembershipType",
"startOffset": 174328813,
"duration": 7996
},
{
"fieldName": "levelOrder",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"levelOrder"
],
"returnType": "Int",
"startOffset": 174387717,
"duration": 14000
},
{
"fieldName": "levelIcon",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"levelIcon"
],
"returnType": "String",
"startOffset": 174449343,
"duration": 6798
},
{
"returnType": "UpgradeStandard",
"startOffset": 174495394,
"duration": 6427,
"fieldName": "upgradeStandard",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"upgradeStandard"
]
},
{
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"levelThreshold"
],
"returnType": "String",
"startOffset": 174540793,
"duration": 6758,
"fieldName": "levelThreshold"
},
{
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"lockinStandard"
],
"returnType": "LockinStandard",
"startOffset": 174680374,
"duration": 8700,
"fieldName": "lockinStandard"
},
{
"startOffset": 174737086,
"duration": 5689,
"fieldName": "lockinRule",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"lockinRule"
],
"returnType": "UnsignedInt64"
},
{
"returnType": "UnsignedInt64",
"startOffset": 174794365,
"duration": 9186,
"fieldName": "paidPrice",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"paidPrice"
]
},
{
"duration": 7047,
"fieldName": "paidExpiryDateType",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"paidExpiryDateType"
],
"returnType": "PaidExpiryDateType",
"startOffset": 174850408
},
{
"returnType": "Int",
"startOffset": 174896474,
"duration": 6705,
"fieldName": "paidExpiryDateValue",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
0,
"paidExpiryDateValue"
]
},
{
"duration": 7068,
"fieldName": "levelCode",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"levelCode"
],
"returnType": "String",
"startOffset": 175010300
},
{
"path": [
"storeMembershipType",
1,
"levelName"
],
"returnType": "String",
"startOffset": 175056008,
"duration": 6594,
"fieldName": "levelName",
"parentType": "MemberLevel"
},
{
"startOffset": 175100520,
"duration": 6338,
"fieldName": "membershipType",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"membershipType"
],
"returnType": "MembershipType"
},
{
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"levelOrder"
],
"returnType": "Int",
"startOffset": 175145337,
"duration": 6610,
"fieldName": "levelOrder"
},
{
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"levelIcon"
],
"returnType": "String",
"startOffset": 175192060,
"duration": 6274,
"fieldName": "levelIcon"
},
{
"duration": 7611,
"fieldName": "upgradeStandard",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"upgradeStandard"
],
"returnType": "UpgradeStandard",
"startOffset": 175236869
},
{
"duration": 6686,
"fieldName": "levelThreshold",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"levelThreshold"
],
"returnType": "String",
"startOffset": 175283130
},
{
"duration": 6841,
"fieldName": "lockinStandard",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"lockinStandard"
],
"returnType": "LockinStandard",
"startOffset": 175380181
},
{
"duration": 9393,
"fieldName": "lockinRule",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"lockinRule"
],
"returnType": "UnsignedInt64",
"startOffset": 175435658
},
{
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"paidPrice"
],
"returnType": "UnsignedInt64",
"startOffset": 175489521,
"duration": 6462,
"fieldName": "paidPrice"
},
{
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"paidExpiryDateType"
],
"returnType": "PaidExpiryDateType",
"startOffset": 175534105,
"duration": 6167,
"fieldName": "paidExpiryDateType"
},
{
"startOffset": 175578374,
"duration": 6451,
"fieldName": "paidExpiryDateValue",
"parentType": "MemberLevel",
"path": [
"storeMembershipType",
1,
"paidExpiryDateValue"
],
"returnType": "Int"
}
]
},
"parsing": {
"startOffset": 415315,
"duration": 349023
},
"startTime": "2024-07-25T07:35:14.103Z",
"validation": {
"duration": 1052570,
"startOffset": 1689600
},
"version": 1,
"duration": 175708852,
"endTime": "2024-07-25T07:35:14.279Z"
}
}
}
Was this article helpful to you?
'%3e%3crect%20x='6'%20y='7.13049'%20width='13'%20height='10'%20rx='1'%20fill='black'/%3e%3cpath%20d='M12.4998%2012.936L-3.65042%200.604835L28.65%200.604838L12.4998%2012.936Z'%20stroke='white'%20stroke-linejoin='round'/%3e%3c/g%3e%3cdefs%3e%3cclipPath%20id='clip0_716_14611'%3e%3crect%20x='6'%20y='7.13049'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e)
'%3e%3crect%20x='5.63086'%20y='7.26086'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3cpath%20d='M12.1306%2013.0664L-4.01956%200.735206L28.2809%200.735209L12.1306%2013.0664Z'%20stroke='%231A2C42'%20stroke-linejoin='round'/%3e%3c/g%3e%3cdefs%3e%3cclipPath%20id='clip0_716_14599'%3e%3crect%20x='5.63086'%20y='7.26086'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e)