Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceObjects

Coupon

typeCoupon

Fields

  1. fields
_id*ID!
applicableForMinimumExpense?Float

This is the minimum expense that is required to redeem the coupon

code*String!
commits?
createdAt*DateTime!

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

grantType?CouponGrantType
Value inGLOBALSPECIFIC_USERS
grantedUsers?

The users that are granted access to this coupon

isAutoGenerated*Boolean!
isDemo?Boolean
maxAllowedValue?Float

The maximum value that can be redeemed by a single user. If not provided or -1 then there is no limit.

tenant?String
updatedAt*DateTime!

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

usesLimit*Int!
validTill?DateTime

The valid till date. If not provided then the coupon is valid forever

value*Float!

The value of the coupon

valueType*CouponValueType!

The value type of the coupon. Can be either PRICE or PERCENTAGE

Value inPERCENTAGEPRICE

Usages

Field of
CouponsWithPagination.nodes
SDL
type Coupon {  _id: ID!  applicableForMinimumExpense: Float  code: String!  commits: [ResourceCommitHistoryReference!]  createdAt: DateTime!  grantType: CouponGrantType  grantedUsers: [User!]  isAutoGenerated: Boolean!  isDemo: Boolean  maxAllowedValue: Float  tenant: String  updatedAt: DateTime!  usesLimit: Int!  validTill: DateTime  value: Float!  valueType: CouponValueType!}