OBJECT

Voucher

link GraphQL Schema definition

1type Voucher implements ObjectWithAttributes {
2id: Int!
3
4status: Status!
5
6name: String!
7
8method: VoucherMethod!
9
10type: VoucherType!
11
12code: String
13
14url: String
15
16conversionHTML: String
17
18combineWithOtherVouchers: Boolean!
19
20# Arguments
21# format: ISO-8601
22createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
23
24entryPointStrategy: VoucherEntryPointStrategy!
25
26maxUsages: Int
27
28priority: Int!
29
30reuse: Boolean!
31
32# Arguments
33# format: ISO-8601
34startAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
35
36# Arguments
37# format: ISO-8601
38stopAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
39
40successfulUsages: Int!
41
42# Arguments
43# format: ISO-8601
44updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
45
46# Required permission: Voucher.attributes:read
47#
48# All elements are always returned
49#
50# Arguments
51# where: (self-explanatory)
52attributes(where: AssignedAttributeFilter): [Attribute!]!
53
54# Required permission: Voucher:read
55#
56# All elements are always returned
57actions: [VoucherAction!]!
58
59# Required permission: AdminUser:read
60adminUser: AdminUser
61
62# Required permission: Voucher:read
63#
64# Store restrictions apply.
65clonedFrom: Voucher
66
67# Required permission: GiftCertificateGenerator:read
68#
69# Store restrictions apply.
70createdFromGiftCertificateGenerator: GiftCertificateGenerator
71
72# Required permission: Market:read
73#
74# All elements are always returned
75#
76# Store restrictions apply.
77markets: [Market!]!
78
79# Required permission: Store:read
80#
81# Store restrictions apply.
82store: Store!
83
84# Required permission: Order:read
85#
86# Limit must be in range 1 - 200
87#
88# Arguments
89# where: (self-explanatory)
90# sort: (self-explanatory)
91# limit: (self-explanatory)
92# page: (self-explanatory)
93usages(where: AppliedVoucherFilter, sort: [AppliedVoucherSort!] = [orderId_ASC, voucherId_ASC, voucherActionResultId_ASC], limit: Int = 20, page: Int = 1): [AppliedVoucher!]!
94
95# Get subvouchers connected to this voucher
96#
97# Limit must be in range 1 - 200
98#
99# Arguments
100# where: (self-explanatory)
101# limit: (self-explanatory)
102# page: (self-explanatory)
103subvouchers(where: SubvoucherFilter, limit: Int = 20, page: Int = 1): [Subvoucher!]!
104
105externalId: String
106
107}