OBJECT

Voucher

GraphQL Schema definition

1 type Voucher implements ObjectWithAttributes {
2 id: Int! 
3 
4 status: Status! 
5 
6 name: String! 
7 
8 method: VoucherMethod! 
9 
10 type: VoucherType! 
11 
12 code: String 
13 
14 url: String 
15 
16 conversionHTML: String 
17 
18 combineWithOtherVouchers: Boolean! 
19 
20 # Arguments
21 #   format: ISO-8601
22 createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz 
23 
24 entryPointStrategy: VoucherEntryPointStrategy! 
25 
26 maxUsages: Int 
27 
28 priority: Int! 
29 
30 reuse: Boolean! 
31 
32 # Arguments
33 #   format: ISO-8601
34 startAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz 
35 
36 # Arguments
37 #   format: ISO-8601
38 stopAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz 
39 
40 successfulUsages: Int! 
41 
42 # Arguments
43 #   format: ISO-8601
44 updatedAt(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)
52 attributes(where: AssignedAttributeFilter): [Attribute!]! 
53 
54 #   Required permission: Voucher:read
55 # 
56 #   All elements are always returned
57 actions: [VoucherAction!]! 
58 
59 #   Required permission: AdminUser:read
60 adminUser: AdminUser 
61 
62 #   Required permission: Voucher:read
63 # 
64 #   Store restrictions apply.
65 clonedFrom: Voucher 
66 
67 #   Required permission: GiftCertificateGenerator:read
68 # 
69 #   Store restrictions apply.
70 createdFromGiftCertificateGenerator: GiftCertificateGenerator 
71 
72 #   Required permission: Market:read
73 # 
74 #   All elements are always returned
75 # 
76 #   Store restrictions apply.
77 markets: [Market!]! 
78 
79 #   Required permission: Store:read
80 # 
81 #   Store restrictions apply.
82 store: 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)
93 usages(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)
103 subvouchers(where: SubvoucherFilter, limit: Int = 20, page: Int = 1): [Subvoucher!]! 
104 
105 externalId: String 
106 
107 }

1	type Voucher implements ObjectWithAttributes {
2	id: Int!
3
4	status: Status!
5
6	name: String!
7
8	method: VoucherMethod!
9
10	type: VoucherType!
11
12	code: String
13
14	url: String
15
16	conversionHTML: String
17
18	combineWithOtherVouchers: Boolean!
19
20	# Arguments
21	# format: ISO-8601
22	createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
23
24	entryPointStrategy: VoucherEntryPointStrategy!
25
26	maxUsages: Int
27
28	priority: Int!
29
30	reuse: Boolean!
31
32	# Arguments
33	# format: ISO-8601
34	startAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
35
36	# Arguments
37	# format: ISO-8601
38	stopAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
39
40	successfulUsages: Int!
41
42	# Arguments
43	# format: ISO-8601
44	updatedAt(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)
52	attributes(where: AssignedAttributeFilter): [Attribute!]!
53
54	# Required permission: Voucher:read
55	#
56	# All elements are always returned
57	actions: [VoucherAction!]!
58
59	# Required permission: AdminUser:read
60	adminUser: AdminUser
61
62	# Required permission: Voucher:read
63	#
64	# Store restrictions apply.
65	clonedFrom: Voucher
66
67	# Required permission: GiftCertificateGenerator:read
68	#
69	# Store restrictions apply.
70	createdFromGiftCertificateGenerator: GiftCertificateGenerator
71
72	# Required permission: Market:read
73	#
74	# All elements are always returned
75	#
76	# Store restrictions apply.
77	markets: [Market!]!
78
79	# Required permission: Store:read
80	#
81	# Store restrictions apply.
82	store: 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)
93	usages(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)
103	subvouchers(where: SubvoucherFilter, limit: Int = 20, page: Int = 1): [Subvoucher!]!
104
105	externalId: String
106
107	}

Voucher

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by