---
title: "customerRewardsInfo"
description: >
  Query the rewards information that a single customer has received, including the number of remaining available rewards and reward applicability and restriction detail.
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/member-system/queries/customer-rewards-info'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/member-system/queries/customer-rewards-info.md'
---
# customerRewardsInfo

Query the rewards information that a single customer has received, including the number of remaining available rewards and reward applicability and restriction detail.

- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Query

## Arguments

* `after`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Returns elements following the specified cursor. The `first` argument must also be specified when using this argument.

* `before`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Returns elements preceding the specified cursor. The `last` argument must also be specified when using this argument.

* `first`

  [Int](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/int.md)

  Returns the first n elements in the list. 

* `last`

  [Int](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/int.md)

  Returns the last n elements in the list. 

* `reverse`

  [Boolean](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/boolean.md)

  Whether to reverse the order of the list. 
  
  ● true: reverse
  
  ● false: do not reverse
  
  Default value: false

* `customerId`

  [String!](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Gets the elements after the specified cursor.

## Returns

* `edges`

  [[CustomerRewardsInfoEdge!]](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/customer-rewards-info-edge.md)

  edges list

* `pageInfo`

  [PageInfo!](https://developer.shopline.com/docs/admin-graph-ql-api/common-objects/objects/page-info.md)

  Information to aid in pagination.

* `nodes`

  [[Reward]](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/reward.md)

  node list

## Examples

### Query the rewards information

Query the rewards information that a single customer has received, including the number of remaining available rewards and reward applicability and restriction detail.

**Request:**

```json
query {
  customerRewardsInfo(customerId: "gid://shopline/Customer/4602226680",first:200) {
    edges{
      cursor
      node{
        rewardScene
        rewardType
        redeemPointsValue
        couponUsageScope
        rewardExpiryTime
        rewardAcquireTime
        couponStatusDetail
        usageLimits
        benefitsUsageInstructionType
        autoStackLimit
        codeStackLimit
        couponStatus
        rewardSource
        benefitsDetails
      }
    }
    pageInfo{
      hasNextPage
      hasPreviousPage
      endCursor
      startCursor
    }
    nodes{
      rewardScene
      rewardType
      redeemPointsValue
      couponUsageScope
      rewardExpiryTime
      rewardAcquireTime
      couponStatusDetail
      usageLimits
      benefitsUsageInstructionType
      autoStackLimit
      codeStackLimit
      couponStatus
      rewardSource
      benefitsDetails
    }
  }
}
```

**Response:**

```json
{
  "data": {
    "data": {
      "customerRewardsInfo": {
        "edges": [
          {
            "cursor": "B7A7E871D4D391780F0FE9B19FF23AAEA1838123E1C8CBCF696365A9DE00CA884670C07462378A3C2FA13904C0A12EAD",
            "node": {
              "benefitsUsageInstructionType": "NONE",
              "codeStackLimit": true,
              "couponStatus": true,
              "couponUsageScope": "FOR_ALL",
              "rewardAcquireTime": "2024-07-25T05:17:32.578Z",
              "rewardScene": "LEVEL_UPGRADE",
              "rewardSource": "MEMBERSHIP_BENEFITS",
              "autoStackLimit": true,
              "couponStatusDetail": "EXPIRED",
              "redeemPointsValue": 0,
              "rewardExpiryTime": null,
              "rewardType": "CASH_VOUCHER",
              "usageLimits": 1,
              "benefitsDetails": "1000"
            }
          }
        ],
        "nodes": [
          {
            "rewardType": "CASH_VOUCHER",
            "benefitsDetails": "1000",
            "codeStackLimit": true,
            "couponStatusDetail": "EXPIRED",
            "couponUsageScope": "FOR_ALL",
            "rewardSource": "MEMBERSHIP_BENEFITS",
            "usageLimits": 1,
            "autoStackLimit": true,
            "benefitsUsageInstructionType": "NONE",
            "couponStatus": true,
            "redeemPointsValue": 0,
            "rewardAcquireTime": "2024-07-25T05:17:32.578Z",
            "rewardExpiryTime": null,
            "rewardScene": "LEVEL_UPGRADE"
          }
        ],
        "pageInfo": {
          "endCursor": "B7A7E871D4D391780F0FE9B19FF23AAEA1838123E1C8CBCF696365A9DE00CA884670C07462378A3C2FA13904C0A12EAD",
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "B7A7E871D4D391780F0FE9B19FF23AAEA1838123E1C8CBCF696365A9DE00CA884670C07462378A3C2FA13904C0A12EAD"
        }
      }
    },
    "extensions": {
      "cost": {
        "requestedQueryCost": 1401,
        "throttleStatus": {
          "currentlyAvailable": 48599,
          "maximumAvailable": 50000,
          "restoreRate": 50000
        },
        "actualQueryCost": 1401
      }
    }
  }
}
```

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes).