---
title: "Reward"
description: >
  All rewards available of the customer, including all basic information of rewards.
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/reward'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/reward.md'
---
# Reward

All rewards available of the customer, including all basic information of rewards. 

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

## Type Signature

`Reward`

## Fields

* `autoStackLimit`

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

  If the rewards allow stacking with automatic discounts.

* `benefitsCode`

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

  Benefit discount code.

* `benefitsDetails`

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

  When rewardType is CASHBACK, PERCENTAGE_DISCOUNT, CASH_VOUCHER, FREE_SHIPPING, it represents the discount value for these benefits, such as x% off.

* `benefitsUsageInstructionType`

  [BenefitsUsageInstructionType](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/benefits-usage-instruction-type.md)

  Benefit usage condition type.

* `codeStackLimit`

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

  If the rewards allow stacking with discount code.

* `couponStatus`

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

  Availability of the coupon. 

* `couponStatusDetail`

  [couponStatusDetail](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/coupon-status-detail.md)

  Relevant only when couponStatus = false.

* `couponUsageScope`

  [CouponUsageScope](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/enums/coupon-usage-scope.md)

  Discount code usage scope.

* `redeemPointsValue`

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

  The number of points used when redeeming rewards. Relevant only when rewardSource = POINTS_REDEMPTION.

* `rewardAcquireTime`

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

  Time when the reward was acquired.

* `rewardExpiryTime`

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

  Time when the reward expires. This field is empty when the reward does not expire.

* `rewardScene`

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

  Scene of rewards.

* `rewardSource`

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

  Source of the reward.

* `rewardType`

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

  Type of rewards

* `usageLimits`

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

  When rewardType is CASHBACK, PERCENTAGE_DISCOUNT, CASH_VOUCHER, FREE_SHIPPING, and FREE_PRODUCT, it indicates the usage limit for these discounts, and null indicates unlimited usage.

## Schema Definition

```graphql
type Reward { 
	autoStackLimit: Boolean
	benefitsCode: String
	benefitsDetails: String
	benefitsUsageInstructionType: BenefitsUsageInstructionType
	codeStackLimit: Boolean
	couponStatus: Boolean
	couponStatusDetail: couponStatusDetail
	couponUsageScope: CouponUsageScope
	redeemPointsValue: Int
	rewardAcquireTime: Date
	rewardExpiryTime: Date
	rewardScene: RewardScene
	rewardSource: RewardSource
	rewardType: RewardType
	usageLimits: Int 
}
```

## Field from

* [CustomerRewardsInfoConnection](https://developer.shopline.com/docs/admin-graph-ql-api/member-system/objects/customer-rewards-info-connection.md).nodes

  node list

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

  node information

## 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).