---
title: "Reward"
description: "客户可用的奖励，包含了奖励的基本信息。"
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/member-system/objects/reward'
  md: 'https://developer.shopline.com/zh-hans-cn/docs/admin-graph-ql-api/member-system/objects/reward.md'
---
# Reward

客户可用的奖励，包含了奖励的基本信息。

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

## Type Signature

`Reward`

## Fields

* `autoStackLimit`

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

  是否允许与自动折扣叠加使用。

* `benefitsCode`

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

  权益折扣码

* `benefitsDetails`

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

  当 rewardType 为 CASHBACK，PERCENTAGE_DISCOUNT，
  CASH_VOUCHER，FREE_SHIPPING 时，表示这些优惠对应的折扣值，比如优惠x%

* `benefitsUsageInstructionType`

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

  权益使用条件类型 

* `codeStackLimit`

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

  是否允许与折扣码叠加使用。

* `couponStatus`

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

  是否可用。

* `couponStatusDetail`

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

  仅 couponStatus= false时有意义。

* `couponUsageScope`

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

  折扣码使用范围。

* `redeemPointsValue`

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

  积分兑换奖励时，使用的积分数。仅当 rewardSource = POINTS_REDEMPTION 时有意义。

* `rewardAcquireTime`

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

  奖励获取时间

* `rewardExpiryTime`

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

  奖励失效时间。当字段为空时，表示永久有效

* `rewardScene`

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

  奖励场景。

* `rewardSource`

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

  奖励来源。

* `rewardType`

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

  奖励类型。

* `usageLimits`

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

  当 rewardType 为 CASHBACK，PERCENTAGE_DISCOUNT，
  CASH_VOUCHER，FREE_SHIPPING 和 FREE_PRODUCT 时，表示这些优惠的使用次数限制，null代表无限使用

## 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/zh-hans-cn/docs/admin-graph-ql-api/member-system/objects/customer-rewards-info-connection.md).nodes

  节点列表

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

  节点信息

## Error Handling

关于更多通用错误码说明，参考：[状态码和错误码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes)。