OBJECT

Voucher

GraphQL Schema definition

1 type Voucher implements ObjectWithAttributes, Discount {
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 attributes: [Attribute!]! 
50 
51 #   Required permission: Voucher:read
52 # 
53 #   All elements are always returned
54 actions: [VoucherAction!]! 
55 
56 #   Required permission: AdminUser:read
57 adminUser: AdminUser 
58 
59 #   Required permission: Voucher:read
60 # 
61 #   Store restrictions apply.
62 clonedFrom: Voucher 
63 
64 #   Required permission: GiftCertificateGenerator:read
65 # 
66 #   Store restrictions apply.
67 createdFromGiftCertificateGenerator: GiftCertificateGenerator 
68 
69 #   Required permission: Market:read
70 # 
71 #   All elements are always returned
72 # 
73 #   Store restrictions apply.
74 markets: [Market!]! 
75 
76 #   Required permission: Store:read
77 # 
78 #   Store restrictions apply.
79 store: Store! 
80 
81 #   Required permission: Order:read
82 # 
83 #   Limit must be in range 1 - 200
84 # 
85 # Arguments
86 #   where: (self-explanatory)
87 #   sort: (self-explanatory)
88 #   limit: (self-explanatory)
89 #   page: (self-explanatory)
90 usages(where: AppliedVoucherFilter, sort: [AppliedVoucherSort!] = [orderId_ASC, voucherId_ASC, voucherActionResultId_ASC], limit: Int = 20, page: Int = 1): [AppliedVoucher!]! 
91 
92 combineWithOtherDiscounts: Boolean! 
93 
94 }

1	type Voucher implements ObjectWithAttributes, Discount {
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	attributes: [Attribute!]!
50
51	# Required permission: Voucher:read
52	#
53	# All elements are always returned
54	actions: [VoucherAction!]!
55
56	# Required permission: AdminUser:read
57	adminUser: AdminUser
58
59	# Required permission: Voucher:read
60	#
61	# Store restrictions apply.
62	clonedFrom: Voucher
63
64	# Required permission: GiftCertificateGenerator:read
65	#
66	# Store restrictions apply.
67	createdFromGiftCertificateGenerator: GiftCertificateGenerator
68
69	# Required permission: Market:read
70	#
71	# All elements are always returned
72	#
73	# Store restrictions apply.
74	markets: [Market!]!
75
76	# Required permission: Store:read
77	#
78	# Store restrictions apply.
79	store: Store!
80
81	# Required permission: Order:read
82	#
83	# Limit must be in range 1 - 200
84	#
85	# Arguments
86	# where: (self-explanatory)
87	# sort: (self-explanatory)
88	# limit: (self-explanatory)
89	# page: (self-explanatory)
90	usages(where: AppliedVoucherFilter, sort: [AppliedVoucherSort!] = [orderId_ASC, voucherId_ASC, voucherActionResultId_ASC], limit: Int = 20, page: Int = 1): [AppliedVoucher!]!
91
92	combineWithOtherDiscounts: Boolean!
93
94	}

Voucher

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by