--- title: "benefitsOfMembership" description: > Query the benefits information of a single level or paid membership type, including the benefits applicability and restriction details. doc_type: graphql doc_category: storefront doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/storefront-api/member-system/queries/benefits-of-membership' md: 'https://developer.shopline.com/docs/storefront-api/member-system/queries/benefits-of-membership.md' --- # benefitsOfMembership Query the benefits information of a single level or paid membership type, including the benefits applicability and restriction details. - **API Version:** v20270301 - **API Type:** Storefront - **API Protocol:** GraphQL - **Operation Type:** Query ## Type Signature `Benefits` ## Arguments * `levelCode` [String!](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md) The code of level or paid membership. ## Returns * `benefitsInfo` [[BenefitsInfo]](https://developer.shopline.com/docs/storefront-api/member-system/objects/benefits-info.md) Basic information about membership level benefits. * `customPrivileges` [[CustomPrivilege]](https://developer.shopline.com/docs/storefront-api/member-system/objects/custom-privilege.md) Basic information about membership level custom previleges. ## Code Example ```graphql { benefitsOfMembership(levelCode ) { # Benefits fields } } ``` ## Examples ### query benefitsOfMembership Query the benefits information of a single level or paid membership type, including the benefits applicability and restriction details. **Request:** ```json query { benefitsOfMembership(levelCode:"gid://shopline/Membership/MLC6568224957444662294") { benefitsInfo{ benefitsIssuranceType benefitsDescription benefitsUsageInstructionValue specificDate benefitsExpiryDateValue fixedDate birthBenefitsReleaseType rewardType benefitsExpiryDateType periodicallyMonths benefitsIcon usageLimitsType daysBefore specificProductIds periodicallyDays benefitsUsageInstructionType autoStackLimit codeStackLimit productsApplicableType usageLimitsTimes benefitsName benefitsDetails specificCategoryList } customPrivileges{ privilegeDescription benefitsIcon privilegeName } } } ``` **Response:** ```json { "data": { "data": { "benefitsOfMembership": { "customPrivileges": [], "benefitsInfo": [ { "benefitsDescription": null, "benefitsName": null, "periodicallyMonths": null, "specificDate": null, "specificProductIds": null, "autoStackLimit": true, "benefitsDetails": "1000", "benefitsExpiryDateValue": null, "benefitsIssuranceType": null, "benefitsUsageInstructionType": "MIN_PURCHASE_AMOUNT", "specificCategoryList": null, "usageLimitsTimes": null, "usageLimitsType": "UNLIMITED", "benefitsExpiryDateType": null, "benefitsIcon": null, "birthBenefitsReleaseType": null, "daysBefore": null, "periodicallyDays": null, "rewardType": "CASH_VOUCHER", "benefitsUsageInstructionValue": "10000", "codeStackLimit": true, "fixedDate": null, "productsApplicableType": "ALL" }, { "specificCategoryList": null, "specificDate": null, "specificProductIds": null, "benefitsDetails": "10", "benefitsExpiryDateValue": null, "fixedDate": null, "autoStackLimit": false, "benefitsExpiryDateType": null, "benefitsIssuranceType": null, "benefitsName": null, "benefitsUsageInstructionValue": null, "daysBefore": null, "periodicallyMonths": null, "benefitsIcon": "BENEFIT_2", "benefitsUsageInstructionType": null, "codeStackLimit": false, "periodicallyDays": null, "productsApplicableType": "ALL", "rewardType": "POINTS", "usageLimitsTimes": null, "usageLimitsType": "UNLIMITED", "benefitsDescription": null, "birthBenefitsReleaseType": null } ] } }, "extensions": { "dataloader": { "individual-statistics": { "LD-com.shopline.pixiu.pcq.storefront.api.CollectionStorefrontQueryService-queryCollectionByProduct": { "cacheHitRatio": 0, "loadErrorRatio": 0, "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "loadCount": 0, "loadErrorCount": 0, "batchInvokeCount": 0, "batchLoadCount": 0, "batchLoadRatio": 0, "cacheHitCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.ProductStorefrontQueryV2Service-onlineStoreUrl": { "batchLoadRatio": 0, "loadCount": 0, "batchLoadExceptionRatio": 0, "cacheHitCount": 0, "cacheHitRatio": 0, "loadErrorCount": 0, "loadErrorRatio": 0, "batchInvokeCount": 0, "batchLoadCount": 0, "batchLoadExceptionCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.ProductStorefrontQueryV2Service-publishedAtForLoader": { "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "cacheHitCount": 0, "cacheHitRatio": 0, "loadErrorCount": 0, "loadErrorRatio": 0, "batchInvokeCount": 0, "batchLoadCount": 0, "batchLoadRatio": 0, "loadCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.ProductStorefrontQueryV2Service-template": { "batchLoadExceptionCount": 0, "batchLoadRatio": 0, "batchInvokeCount": 0, "batchLoadCount": 0, "batchLoadExceptionRatio": 0, "cacheHitCount": 0, "cacheHitRatio": 0, "loadCount": 0, "loadErrorCount": 0, "loadErrorRatio": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.ProductStorefrontQueryV2Service-variants": { "batchLoadCount": 0, "batchLoadRatio": 0, "cacheHitRatio": 0, "loadErrorCount": 0, "loadErrorRatio": 0, "batchInvokeCount": 0, "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "cacheHitCount": 0, "loadCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.ProductStorefrontQueryV2Service-variantsForLoader": { "batchInvokeCount": 0, "batchLoadCount": 0, "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "loadErrorRatio": 0, "batchLoadRatio": 0, "cacheHitCount": 0, "cacheHitRatio": 0, "loadCount": 0, "loadErrorCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.CollectionStorefrontQueryService-onlineStoreUrl": { "loadErrorCount": 0, "loadErrorRatio": 0, "batchLoadCount": 0, "batchLoadExceptionRatio": 0, "batchLoadRatio": 0, "cacheHitCount": 0, "batchInvokeCount": 0, "batchLoadExceptionCount": 0, "cacheHitRatio": 0, "loadCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.DescriptionQueryService-query": { "loadErrorRatio": 0, "batchInvokeCount": 0, "batchLoadRatio": 0, "cacheHitCount": 0, "loadErrorCount": 0, "batchLoadCount": 0, "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "cacheHitRatio": 0, "loadCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.ProductStorefrontQueryV2Service-images": { "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "batchLoadRatio": 0, "cacheHitCount": 0, "cacheHitRatio": 0, "loadErrorCount": 0, "loadErrorRatio": 0, "batchInvokeCount": 0, "batchLoadCount": 0, "loadCount": 0 }, "LD-com.shopline.pixiu.pcq.storefront.api.ProductStorefrontQueryV2Service-options": { "batchInvokeCount": 0, "cacheHitRatio": 0, "loadErrorCount": 0, "loadErrorRatio": 0, "batchLoadCount": 0, "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "batchLoadRatio": 0, "cacheHitCount": 0, "loadCount": 0 }, "LD-com.shopline.merchant.website.openapi.interfaces.OnlineStorefrontApi-commentsQuery": { "batchLoadRatio": 0, "cacheHitRatio": 0, "loadCount": 0, "loadErrorRatio": 0, "batchInvokeCount": 0, "batchLoadExceptionRatio": 0, "cacheHitCount": 0, "loadErrorCount": 0, "batchLoadCount": 0, "batchLoadExceptionCount": 0 } }, "overall-statistics": { "batchLoadExceptionCount": 0, "batchLoadExceptionRatio": 0, "cacheHitRatio": 0, "loadCount": 0, "loadErrorRatio": 0, "batchInvokeCount": 0, "batchLoadCount": 0, "batchLoadRatio": 0, "cacheHitCount": 0, "loadErrorCount": 0 } }, "metrics": { "dataFetcherMetrics": [ { "dfErrorCode": null, "dfProtocol": "dubbo", "dfRootCoordinate": "/benefitsOfMembership", "dfRt": 262, "dfServiceIdentity": "com.shopline.ec.openapi.interfaces.MemberStoreFrontApi@memberLevelBenefitQuery", "dfStartTime": 1721889875072 } ], "graphQLMetrics": { "includeQuery": false, "languageCode": null, "version": "v20241201", "appId": "265337", "appKey": "936eda168305ed82cee702c6822354ee6de2e802", "errorFieldsCount": 0, "executionId": "71a04ad1-131a-4e98-84e4-4b06ddf2a1f0", "includeDeprecatedField": false, "ratelimitRemaining": 1, "tenant": "ec20", "deepLevel": 3, "merchantId": "4200114610", "traceId": "2bb5b97f7e800c984835b443cd18c91f", "loaderCount": 0, "storeId": "1641993455937", "storePlus": false, "namespace": "storefront", "parseRt": 1, "ratelimitPermits": 1, "rt": 266, "saleChannel": null, "startTimeMillis": 1721889875069, "customizedClientIp": "218.253.130.212", "operation": "QUERY", "startParseTimeMillis": 1721889875069, "successType": "SUCCESS", "clientIp": "218.253.130.212", "countryCode": null, "fieldCount": 103, "endParseTimeMillis": 1721889875070 } }, "tracing": { "version": 1, "duration": 266325440, "endTime": "2024-07-25T06:44:35.335Z", "execution": { "resolvers": [ { "duration": 262455674, "fieldName": "benefitsOfMembership", "parentType": "Query", "path": [ "benefitsOfMembership" ], "returnType": "Benefits", "startOffset": 2920412 }, { "path": [ "benefitsOfMembership", "benefitsInfo" ], "returnType": "[BenefitsInfo]", "startOffset": 265541709, "duration": 7495, "fieldName": "benefitsInfo", "parentType": "Benefits" }, { "duration": 3336, "fieldName": "benefitsIssuranceType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsIssuranceType" ], "returnType": "BenefitsIssuranceType", "startOffset": 265586736 }, { "startOffset": 265605946, "duration": 2440, "fieldName": "benefitsDescription", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsDescription" ], "returnType": "String" }, { "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsUsageInstructionValue" ], "returnType": "String", "startOffset": 265619641, "duration": 5274, "fieldName": "benefitsUsageInstructionValue", "parentType": "BenefitsInfo" }, { "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "specificDate" ], "returnType": "String", "startOffset": 265636304, "duration": 2118, "fieldName": "specificDate" }, { "returnType": "Int", "startOffset": 265648955, "duration": 1831, "fieldName": "benefitsExpiryDateValue", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsExpiryDateValue" ] }, { "duration": 1976, "fieldName": "fixedDate", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "fixedDate" ], "returnType": "Int", "startOffset": 265660888 }, { "duration": 1884, "fieldName": "birthBenefitsReleaseType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "birthBenefitsReleaseType" ], "returnType": "BirthBenefitsReleaseType", "startOffset": 265673314 }, { "duration": 2016, "fieldName": "rewardType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "rewardType" ], "returnType": "RewardType", "startOffset": 265686294 }, { "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsExpiryDateType" ], "returnType": "BenefitsExpiryDateType", "startOffset": 265700980, "duration": 2284, "fieldName": "benefitsExpiryDateType", "parentType": "BenefitsInfo" }, { "fieldName": "periodicallyMonths", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "periodicallyMonths" ], "returnType": "Int", "startOffset": 265713123, "duration": 1807 }, { "duration": 1896, "fieldName": "benefitsIcon", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsIcon" ], "returnType": "String", "startOffset": 265724861 }, { "startOffset": 265736681, "duration": 1946, "fieldName": "usageLimitsType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "usageLimitsType" ], "returnType": "UsageLimitsType" }, { "fieldName": "daysBefore", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "daysBefore" ], "returnType": "Int", "startOffset": 265749674, "duration": 1977 }, { "duration": 1852, "fieldName": "specificProductIds", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "specificProductIds" ], "returnType": "String", "startOffset": 265761353 }, { "duration": 1819, "fieldName": "periodicallyDays", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "periodicallyDays" ], "returnType": "Int", "startOffset": 265773064 }, { "duration": 2191, "fieldName": "benefitsUsageInstructionType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsUsageInstructionType" ], "returnType": "BenefitsUsageInstructionType", "startOffset": 265784972 }, { "startOffset": 265799375, "duration": 2882, "fieldName": "autoStackLimit", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "autoStackLimit" ], "returnType": "Boolean" }, { "duration": 2818, "fieldName": "codeStackLimit", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "codeStackLimit" ], "returnType": "Boolean", "startOffset": 265817110 }, { "startOffset": 265832390, "duration": 2002, "fieldName": "productsApplicableType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "productsApplicableType" ], "returnType": "ProductsApplicableType" }, { "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "usageLimitsTimes" ], "returnType": "Int", "startOffset": 265844998, "duration": 1866, "fieldName": "usageLimitsTimes" }, { "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsName" ], "returnType": "String", "startOffset": 265856761, "duration": 2102, "fieldName": "benefitsName", "parentType": "BenefitsInfo" }, { "duration": 1949, "fieldName": "benefitsDetails", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "benefitsDetails" ], "returnType": "String", "startOffset": 265868548 }, { "returnType": "[String]", "startOffset": 265880674, "duration": 1957, "fieldName": "specificCategoryList", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 0, "specificCategoryList" ] }, { "duration": 2025, "fieldName": "benefitsIssuranceType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsIssuranceType" ], "returnType": "BenefitsIssuranceType", "startOffset": 265924227 }, { "duration": 1972, "fieldName": "benefitsDescription", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsDescription" ], "returnType": "String", "startOffset": 265936592 }, { "duration": 1806, "fieldName": "benefitsUsageInstructionValue", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsUsageInstructionValue" ], "returnType": "String", "startOffset": 265948532 }, { "fieldName": "specificDate", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "specificDate" ], "returnType": "String", "startOffset": 265965810, "duration": 1953 }, { "returnType": "Int", "startOffset": 265977731, "duration": 1837, "fieldName": "benefitsExpiryDateValue", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsExpiryDateValue" ] }, { "duration": 1776, "fieldName": "fixedDate", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "fixedDate" ], "returnType": "Int", "startOffset": 265989470 }, { "duration": 1806, "fieldName": "birthBenefitsReleaseType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "birthBenefitsReleaseType" ], "returnType": "BirthBenefitsReleaseType", "startOffset": 266001290 }, { "duration": 1980, "fieldName": "rewardType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "rewardType" ], "returnType": "RewardType", "startOffset": 266013018 }, { "fieldName": "benefitsExpiryDateType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsExpiryDateType" ], "returnType": "BenefitsExpiryDateType", "startOffset": 266030420, "duration": 1828 }, { "path": [ "benefitsOfMembership", "benefitsInfo", 1, "periodicallyMonths" ], "returnType": "Int", "startOffset": 266043360, "duration": 1793, "fieldName": "periodicallyMonths", "parentType": "BenefitsInfo" }, { "duration": 2093, "fieldName": "benefitsIcon", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsIcon" ], "returnType": "String", "startOffset": 266054948 }, { "duration": 1934, "fieldName": "usageLimitsType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "usageLimitsType" ], "returnType": "UsageLimitsType", "startOffset": 266067163 }, { "startOffset": 266079435, "duration": 1800, "fieldName": "daysBefore", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "daysBefore" ], "returnType": "Int" }, { "path": [ "benefitsOfMembership", "benefitsInfo", 1, "specificProductIds" ], "returnType": "String", "startOffset": 266090847, "duration": 1840, "fieldName": "specificProductIds", "parentType": "BenefitsInfo" }, { "duration": 1886, "fieldName": "periodicallyDays", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "periodicallyDays" ], "returnType": "Int", "startOffset": 266102420 }, { "duration": 1970, "fieldName": "benefitsUsageInstructionType", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsUsageInstructionType" ], "returnType": "BenefitsUsageInstructionType", "startOffset": 266118001 }, { "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "autoStackLimit" ], "returnType": "Boolean", "startOffset": 266129700, "duration": 1839, "fieldName": "autoStackLimit" }, { "path": [ "benefitsOfMembership", "benefitsInfo", 1, "codeStackLimit" ], "returnType": "Boolean", "startOffset": 266141609, "duration": 2040, "fieldName": "codeStackLimit", "parentType": "BenefitsInfo" }, { "path": [ "benefitsOfMembership", "benefitsInfo", 1, "productsApplicableType" ], "returnType": "ProductsApplicableType", "startOffset": 266153516, "duration": 1924, "fieldName": "productsApplicableType", "parentType": "BenefitsInfo" }, { "startOffset": 266165532, "duration": 1834, "fieldName": "usageLimitsTimes", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "usageLimitsTimes" ], "returnType": "Int" }, { "returnType": "String", "startOffset": 266177159, "duration": 1903, "fieldName": "benefitsName", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsName" ] }, { "returnType": "String", "startOffset": 266188732, "duration": 1991, "fieldName": "benefitsDetails", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "benefitsDetails" ] }, { "duration": 1845, "fieldName": "specificCategoryList", "parentType": "BenefitsInfo", "path": [ "benefitsOfMembership", "benefitsInfo", 1, "specificCategoryList" ], "returnType": "[String]", "startOffset": 266200774 }, { "fieldName": "customPrivileges", "parentType": "Benefits", "path": [ "benefitsOfMembership", "customPrivileges" ], "returnType": "[CustomPrivilege]", "startOffset": 266244282, "duration": 2309 } ] }, "parsing": { "duration": 349229, "startOffset": 383857 }, "startTime": "2024-07-25T06:44:35.069Z", "validation": { "duration": 486738, "startOffset": 1114339 } } } } } ``` ## Error Handling For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/storefront-api/overview.md#status-and-error-codes).