Class: ShopifyAPI::Order

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2022_04/order.rb,
lib/shopify_api/rest/resources/2022_07/order.rb,
lib/shopify_api/rest/resources/2022_10/order.rb,
lib/shopify_api/rest/resources/2023_01/order.rb,
lib/shopify_api/rest/resources/2023_04/order.rb,
lib/shopify_api/rest/resources/2023_07/order.rb,
lib/shopify_api/rest/resources/2023_10/order.rb,
lib/shopify_api/rest/resources/2024_01/order.rb,
lib/shopify_api/rest/resources/2024_04/order.rb,
lib/shopify_api/rest/resources/2024_07/order.rb,
lib/shopify_api/rest/resources/2024_10/order.rb,
lib/shopify_api/rest/resources/2025_01/order.rb,
lib/shopify_api/rest/resources/2025_04/order.rb

Instance Attribute Summary collapse

Attributes inherited from Rest::Base

#errors, #original_state

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rest::Base

api_call_limit, base_find, class_name, create_instance, create_instances_from_response, #delete, get_path, get_path_ids, has_many?, has_one?, inherited, json_body_name, json_response_body_names, #method_missing, next_page?, next_page_info, prev_page?, prev_page_info, primary_key, read_only_attributes, request, #respond_to_missing?, retry_request_after, #save, #save!, #to_hash

Constructor Details

#initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) ⇒ Order

Returns a new instance of Order.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 19

def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

  @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
  @app_id = T.let(nil, T.nilable(Integer))
  @billing_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @browser_ip = T.let(nil, T.nilable(String))
  @buyer_accepts_marketing = T.let(nil, T.nilable(T::Boolean))
  @cancel_reason = T.let(nil, T.nilable(String))
  @cancelled_at = T.let(nil, T.nilable(String))
  @cart_token = T.let(nil, T.nilable(String))
  @checkout_token = T.let(nil, T.nilable(String))
  @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @closed_at = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(String))
  @current_subtotal_price = T.let(nil, T.nilable(String))
  @current_subtotal_price_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @current_total_discounts = T.let(nil, T.nilable(String))
  @current_total_discounts_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @current_total_duties_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @current_total_price = T.let(nil, T.nilable(String))
  @current_total_price_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @current_total_tax = T.let(nil, T.nilable(String))
  @current_total_tax_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @customer = T.let(nil, T.nilable(Customer))
  @customer_locale = T.let(nil, T.nilable(String))
  @discount_applications = T.let(nil, T.nilable(T::Array[T.untyped]))
  @discount_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
  @email = T.let(nil, T.nilable(String))
  @estimated_taxes = T.let(nil, T.nilable(T::Boolean))
  @financial_status = T.let(nil, T.nilable(String))
  @fulfillment_status = T.let(nil, T.nilable(String))
  @fulfillments = T.let(nil, T.nilable(T::Array[T.untyped]))
  @gateway = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @landing_site = T.let(nil, T.nilable(String))
  @location_id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @note = T.let(nil, T.nilable(String))
  @note_attributes = T.let(nil, T.nilable(T::Array[T.untyped]))
  @number = T.let(nil, T.nilable(Integer))
  @order_number = T.let(nil, T.nilable(Integer))
  @order_status_url = T.let(nil, T.nilable(String))
  @original_total_duties_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @payment_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @payment_gateway_names = T.let(nil, T.nilable(T::Array[T.untyped]))
  @payment_terms = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @phone = T.let(nil, T.nilable(String))
  @presentment_currency = T.let(nil, T.nilable(String))
  @processed_at = T.let(nil, T.nilable(String))
  @processing_method = T.let(nil, T.nilable(String))
  @referring_site = T.let(nil, T.nilable(String))
  @refunds = T.let(nil, T.nilable(T::Array[T.untyped]))
  @shipping_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @shipping_lines = T.let(nil, T.nilable(T::Array[T.untyped]))
  @source_identifier = T.let(nil, T.nilable(String))
  @source_name = T.let(nil, T.nilable(String))
  @source_url = T.let(nil, T.nilable(String))
  @subtotal_price = T.let(nil, T.nilable(String))
  @subtotal_price_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @tags = T.let(nil, T.nilable(String))
  @tax_lines = T.let(nil, T.nilable(T::Array[T.untyped]))
  @taxes_included = T.let(nil, T.nilable(T::Boolean))
  @test = T.let(nil, T.nilable(T::Boolean))
  @token = T.let(nil, T.nilable(String))
  @total_discounts = T.let(nil, T.nilable(String))
  @total_discounts_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @total_line_items_price = T.let(nil, T.nilable(String))
  @total_line_items_price_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @total_outstanding = T.let(nil, T.nilable(String))
  @total_price = T.let(nil, T.nilable(String))
  @total_price_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @total_shipping_price_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @total_tax = T.let(nil, T.nilable(T.any(String, Float)))
  @total_tax_set = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @total_tip_received = T.let(nil, T.nilable(String))
  @total_weight = T.let(nil, T.nilable(Integer))
  @updated_at = T.let(nil, T.nilable(String))
  @user_id = T.let(nil, T.nilable(Integer))

  super(session: session, from_hash: from_hash)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ShopifyAPI::Rest::Base

Instance Attribute Details

#app_id ⇒ Object (readonly)

Returns the value of attribute app_id.



125
126
127
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 125

def app_id
  @app_id
end

#billing_address ⇒ Object (readonly)

Returns the value of attribute billing_address.



127
128
129
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 127

def billing_address
  @billing_address
end

#browser_ip ⇒ Object (readonly)

Returns the value of attribute browser_ip.



129
130
131
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 129

def browser_ip
  @browser_ip
end

#buyer_accepts_marketing ⇒ Object (readonly)

Returns the value of attribute buyer_accepts_marketing.



131
132
133
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 131

def buyer_accepts_marketing
  @buyer_accepts_marketing
end

#cancel_reason ⇒ Object (readonly)

Returns the value of attribute cancel_reason.



133
134
135
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 133

def cancel_reason
  @cancel_reason
end

#cancelled_at ⇒ Object (readonly)

Returns the value of attribute cancelled_at.



135
136
137
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 135

def cancelled_at
  @cancelled_at
end

#cart_token ⇒ Object (readonly)

Returns the value of attribute cart_token.



137
138
139
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 137

def cart_token
  @cart_token
end

#checkout_token ⇒ Object (readonly)

Returns the value of attribute checkout_token.



139
140
141
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 139

def checkout_token
  @checkout_token
end

#client_details ⇒ Object (readonly)

Returns the value of attribute client_details.



141
142
143
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 141

def client_details
  @client_details
end

#closed_at ⇒ Object (readonly)

Returns the value of attribute closed_at.



143
144
145
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 143

def closed_at
  @closed_at
end

#company ⇒ Object (readonly)

Returns the value of attribute company.



148
149
150
 
# File 'lib/shopify_api/rest/resources/2023_01/order.rb', line 148

def company
  @company
end

#confirmation_number ⇒ Object (readonly)

Returns the value of attribute confirmation_number.



146
147
148
 
# File 'lib/shopify_api/rest/resources/2022_07/order.rb', line 146

def confirmation_number
  @confirmation_number
end

#confirmed ⇒ Object (readonly)

Returns the value of attribute confirmed.



157
158
159
 
# File 'lib/shopify_api/rest/resources/2025_01/order.rb', line 157

def confirmed
  @confirmed
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



145
146
147
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 145

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



147
148
149
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 147

def currency
  @currency
end

#current_subtotal_price ⇒ Object (readonly)

Returns the value of attribute current_subtotal_price.



149
150
151
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 149

def current_subtotal_price
  @current_subtotal_price
end

#current_subtotal_price_set ⇒ Object (readonly)

Returns the value of attribute current_subtotal_price_set.



151
152
153
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 151

def current_subtotal_price_set
  @current_subtotal_price_set
end

#current_total_additional_fees_set ⇒ Object (readonly)

Returns the value of attribute current_total_additional_fees_set.



160
161
162
 
# File 'lib/shopify_api/rest/resources/2023_04/order.rb', line 160

def current_total_additional_fees_set
  @current_total_additional_fees_set
end

#current_total_discounts ⇒ Object (readonly)

Returns the value of attribute current_total_discounts.



153
154
155
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 153

def current_total_discounts
  @current_total_discounts
end

#current_total_discounts_set ⇒ Object (readonly)

Returns the value of attribute current_total_discounts_set.



155
156
157
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 155

def current_total_discounts_set
  @current_total_discounts_set
end

#current_total_duties_set ⇒ Object (readonly)

Returns the value of attribute current_total_duties_set.



157
158
159
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 157

def current_total_duties_set
  @current_total_duties_set
end

#current_total_price ⇒ Object (readonly)

Returns the value of attribute current_total_price.



159
160
161
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 159

def current_total_price
  @current_total_price
end

#current_total_price_set ⇒ Object (readonly)

Returns the value of attribute current_total_price_set.



161
162
163
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 161

def current_total_price_set
  @current_total_price_set
end

#current_total_tax ⇒ Object (readonly)

Returns the value of attribute current_total_tax.



163
164
165
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 163

def current_total_tax
  @current_total_tax
end

#current_total_tax_set ⇒ Object (readonly)

Returns the value of attribute current_total_tax_set.



165
166
167
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 165

def current_total_tax_set
  @current_total_tax_set
end

#customer ⇒ Object (readonly)

Returns the value of attribute customer.



167
168
169
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 167

def customer
  @customer
end

#customer_locale ⇒ Object (readonly)

Returns the value of attribute customer_locale.



169
170
171
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 169

def customer_locale
  @customer_locale
end

#discount_applications ⇒ Object (readonly)

Returns the value of attribute discount_applications.



171
172
173
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 171

def discount_applications
  @discount_applications
end

#discount_codes ⇒ Object (readonly)

Returns the value of attribute discount_codes.



173
174
175
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 173

def discount_codes
  @discount_codes
end

#duties_included ⇒ Object (readonly)

Returns the value of attribute duties_included.



191
192
193
 
# File 'lib/shopify_api/rest/resources/2025_01/order.rb', line 191

def duties_included
  @duties_included
end

#email ⇒ Object (readonly)

Returns the value of attribute email.



175
176
177
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 175

def email
  @email
end

#estimated_taxes ⇒ Object (readonly)

Returns the value of attribute estimated_taxes.



177
178
179
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 177

def estimated_taxes
  @estimated_taxes
end

#financial_status ⇒ Object (readonly)

Returns the value of attribute financial_status.



179
180
181
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 179

def financial_status
  @financial_status
end

#fulfillment_status ⇒ Object (readonly)

Returns the value of attribute fulfillment_status.



181
182
183
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 181

def fulfillment_status
  @fulfillment_status
end

#fulfillments ⇒ Object (readonly)

Returns the value of attribute fulfillments.



183
184
185
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 183

def fulfillments
  @fulfillments
end

#gateway ⇒ Object (readonly)

Returns the value of attribute gateway.



185
186
187
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 185

def gateway
  @gateway
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



187
188
189
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 187

def id
  @id
end

#landing_site ⇒ Object (readonly)

Returns the value of attribute landing_site.



189
190
191
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 189

def landing_site
  @landing_site
end

#line_items ⇒ Object (readonly)

Returns the value of attribute line_items.



123
124
125
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 123

def line_items
  @line_items
end

#location_id ⇒ Object (readonly)

Returns the value of attribute location_id.



191
192
193
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 191

def location_id
  @location_id
end

#merchant_business_entity_id ⇒ Object (readonly)

Returns the value of attribute merchant_business_entity_id.



209
210
211
 
# File 'lib/shopify_api/rest/resources/2025_01/order.rb', line 209

def merchant_business_entity_id
  @merchant_business_entity_id
end

#merchant_of_record_app_id ⇒ Object (readonly)

Returns the value of attribute merchant_of_record_app_id.



197
198
199
 
# File 'lib/shopify_api/rest/resources/2022_10/order.rb', line 197

def merchant_of_record_app_id
  @merchant_of_record_app_id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



193
194
195
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 193

def name
  @name
end

#note ⇒ Object (readonly)

Returns the value of attribute note.



195
196
197
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 195

def note
  @note
end

#note_attributes ⇒ Object (readonly)

Returns the value of attribute note_attributes.



197
198
199
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 197

def note_attributes
  @note_attributes
end

#number ⇒ Object (readonly)

Returns the value of attribute number.



199
200
201
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 199

def number
  @number
end

#order_number ⇒ Object (readonly)

Returns the value of attribute order_number.



201
202
203
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 201

def order_number
  @order_number
end

#order_status_url ⇒ Object (readonly)

Returns the value of attribute order_status_url.



203
204
205
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 203

def order_status_url
  @order_status_url
end

#original_total_additional_fees_set ⇒ Object (readonly)

Returns the value of attribute original_total_additional_fees_set.



216
217
218
 
# File 'lib/shopify_api/rest/resources/2023_04/order.rb', line 216

def original_total_additional_fees_set
  @original_total_additional_fees_set
end

#original_total_duties_set ⇒ Object (readonly)

Returns the value of attribute original_total_duties_set.



205
206
207
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 205

def original_total_duties_set
  @original_total_duties_set
end

#payment_details ⇒ Object (readonly)

Returns the value of attribute payment_details.



207
208
209
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 207

def payment_details
  @payment_details
end

#payment_gateway_names ⇒ Object (readonly)

Returns the value of attribute payment_gateway_names.



209
210
211
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 209

def payment_gateway_names
  @payment_gateway_names
end

#payment_terms ⇒ Object (readonly)

Returns the value of attribute payment_terms.



211
212
213
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 211

def payment_terms
  @payment_terms
end

#phone ⇒ Object (readonly)

Returns the value of attribute phone.



213
214
215
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 213

def phone
  @phone
end

#po_number ⇒ Object (readonly)

Returns the value of attribute po_number.



227
228
229
 
# File 'lib/shopify_api/rest/resources/2023_07/order.rb', line 227

def po_number
  @po_number
end

#presentment_currency ⇒ Object (readonly)

Returns the value of attribute presentment_currency.



215
216
217
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 215

def presentment_currency
  @presentment_currency
end

#processed_at ⇒ Object (readonly)

Returns the value of attribute processed_at.



217
218
219
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 217

def processed_at
  @processed_at
end

#processing_method ⇒ Object (readonly)

Returns the value of attribute processing_method.



219
220
221
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 219

def processing_method
  @processing_method
end

#referring_site ⇒ Object (readonly)

Returns the value of attribute referring_site.



221
222
223
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 221

def referring_site
  @referring_site
end

#refunds ⇒ Object (readonly)

Returns the value of attribute refunds.



223
224
225
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 223

def refunds
  @refunds
end

#shipping_address ⇒ Object (readonly)

Returns the value of attribute shipping_address.



225
226
227
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 225

def shipping_address
  @shipping_address
end

#shipping_lines ⇒ Object (readonly)

Returns the value of attribute shipping_lines.



227
228
229
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 227

def shipping_lines
  @shipping_lines
end

#source_identifier ⇒ Object (readonly)

Returns the value of attribute source_identifier.



229
230
231
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 229

def source_identifier
  @source_identifier
end

#source_name ⇒ Object (readonly)

Returns the value of attribute source_name.



231
232
233
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 231

def source_name
  @source_name
end

#source_url ⇒ Object (readonly)

Returns the value of attribute source_url.



233
234
235
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 233

def source_url
  @source_url
end

#subtotal_price ⇒ Object (readonly)

Returns the value of attribute subtotal_price.



235
236
237
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 235

def subtotal_price
  @subtotal_price
end

#subtotal_price_set ⇒ Object (readonly)

Returns the value of attribute subtotal_price_set.



237
238
239
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 237

def subtotal_price_set
  @subtotal_price_set
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



239
240
241
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 239

def tags
  @tags
end

#tax_lines ⇒ Object (readonly)

Returns the value of attribute tax_lines.



241
242
243
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 241

def tax_lines
  @tax_lines
end

#taxes_included ⇒ Object (readonly)

Returns the value of attribute taxes_included.



243
244
245
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 243

def taxes_included
  @taxes_included
end

#test ⇒ Object (readonly)

Returns the value of attribute test.



245
246
247
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 245

def test
  @test
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



247
248
249
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 247

def token
  @token
end

#total_cash_rounding_payment_adjustment_set ⇒ Object (readonly)

Returns the value of attribute total_cash_rounding_payment_adjustment_set.



269
270
271
 
# File 'lib/shopify_api/rest/resources/2025_01/order.rb', line 269

def total_cash_rounding_payment_adjustment_set
  @total_cash_rounding_payment_adjustment_set
end

#total_cash_rounding_refund_adjustment_set ⇒ Object (readonly)

Returns the value of attribute total_cash_rounding_refund_adjustment_set.



271
272
273
 
# File 'lib/shopify_api/rest/resources/2025_01/order.rb', line 271

def total_cash_rounding_refund_adjustment_set
  @total_cash_rounding_refund_adjustment_set
end

#total_discounts ⇒ Object (readonly)

Returns the value of attribute total_discounts.



249
250
251
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 249

def total_discounts
  @total_discounts
end

#total_discounts_set ⇒ Object (readonly)

Returns the value of attribute total_discounts_set.



251
252
253
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 251

def total_discounts_set
  @total_discounts_set
end

#total_line_items_price ⇒ Object (readonly)

Returns the value of attribute total_line_items_price.



253
254
255
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 253

def total_line_items_price
  @total_line_items_price
end

#total_line_items_price_set ⇒ Object (readonly)

Returns the value of attribute total_line_items_price_set.



255
256
257
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 255

def total_line_items_price_set
  @total_line_items_price_set
end

#total_outstanding ⇒ Object (readonly)

Returns the value of attribute total_outstanding.



257
258
259
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 257

def total_outstanding
  @total_outstanding
end

#total_price ⇒ Object (readonly)

Returns the value of attribute total_price.



259
260
261
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 259

def total_price
  @total_price
end

#total_price_set ⇒ Object (readonly)

Returns the value of attribute total_price_set.



261
262
263
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 261

def total_price_set
  @total_price_set
end

#total_shipping_price_set ⇒ Object (readonly)

Returns the value of attribute total_shipping_price_set.



263
264
265
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 263

def total_shipping_price_set
  @total_shipping_price_set
end

#total_tax ⇒ Object (readonly)

Returns the value of attribute total_tax.



265
266
267
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 265

def total_tax
  @total_tax
end

#total_tax_set ⇒ Object (readonly)

Returns the value of attribute total_tax_set.



267
268
269
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 267

def total_tax_set
  @total_tax_set
end

#total_tip_received ⇒ Object (readonly)

Returns the value of attribute total_tip_received.



269
270
271
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 269

def total_tip_received
  @total_tip_received
end

#total_weight ⇒ Object (readonly)

Returns the value of attribute total_weight.



271
272
273
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 271

def total_weight
  @total_weight
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



273
274
275
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 273

def updated_at
  @updated_at
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



275
276
277
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 275

def user_id
  @user_id
end

Class Method Details

.all(ids: nil, limit: nil, since_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, processed_at_min: nil, processed_at_max: nil, attribution_app_id: nil, name: nil, status: nil, financial_status: nil, fulfillment_status: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 337

def all(
  ids: nil,
  limit: nil,
  since_id: nil,
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  processed_at_min: nil,
  processed_at_max: nil,
  attribution_app_id: nil,
  status: nil,
  financial_status: nil,
  fulfillment_status: nil,
  fields: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {ids: ids, limit: limit, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, processed_at_min: processed_at_min, processed_at_max: processed_at_max, attribution_app_id: attribution_app_id, status: status, financial_status: financial_status, fulfillment_status: fulfillment_status, fields: fields}.merge(kwargs).compact,
  )

  T.cast(response, T::Array[Order])
end

.count(created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, status: nil, financial_status: nil, fulfillment_status: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 377

def count(
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  status: nil,
  financial_status: nil,
  fulfillment_status: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {},
    params: {created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, status: status, financial_status: financial_status, fulfillment_status: fulfillment_status}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end

.delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 304

def delete(
  id:,
  session: ShopifyAPI::Context.active_session
)
  request(
    http_method: :delete,
    operation: :delete,
    session: session,
    ids: {id: id},
    params: {},
  )
end

.find(id:, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 285

def find(
  id:,
  fields: nil,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id},
    params: {fields: fields},
  )
  T.cast(result[0], T.nilable(Order))
end

Instance Method Details

#cancel(amount: nil, currency: nil, restock: nil, reason: nil, email: nil, refund: nil, body: nil, **kwargs) ⇒ Object 



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 413

def cancel(
  amount: nil,
  currency: nil,
  restock: nil,
  reason: nil,
  email: nil,
  refund: nil,
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :cancel,
    session: @session,
    ids: {id: @id},
    params: {amount: amount, currency: currency, restock: restock, reason: reason, email: email, refund: refund}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end

#close(body: nil, **kwargs) ⇒ Object 



440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 440

def close(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :close,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end

#open(body: nil, **kwargs) ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/shopify_api/rest/resources/2022_04/order.rb', line 461

def open(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :open,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end