Class: ShopifyAPI::Order
- Inherits:
-
Rest::Base
- Object
- Rest::Base
- ShopifyAPI::Order
- Extended by:
- T::Sig
- Defined in:
- lib/shopify_api/rest/resources/2021_07/order.rb,
lib/shopify_api/rest/resources/2021_10/order.rb,
lib/shopify_api/rest/resources/2022_01/order.rb,
lib/shopify_api/rest/resources/2022_04/order.rb
Instance Attribute Summary collapse
-
#app_id ⇒ Object
readonly
Returns the value of attribute app_id.
-
#billing_address ⇒ Object
readonly
Returns the value of attribute billing_address.
-
#browser_ip ⇒ Object
readonly
Returns the value of attribute browser_ip.
-
#buyer_accepts_marketing ⇒ Object
readonly
Returns the value of attribute buyer_accepts_marketing.
-
#cancel_reason ⇒ Object
readonly
Returns the value of attribute cancel_reason.
-
#cancelled_at ⇒ Object
readonly
Returns the value of attribute cancelled_at.
-
#cart_token ⇒ Object
readonly
Returns the value of attribute cart_token.
-
#checkout_token ⇒ Object
readonly
Returns the value of attribute checkout_token.
-
#client_details ⇒ Object
readonly
Returns the value of attribute client_details.
-
#closed_at ⇒ Object
readonly
Returns the value of attribute closed_at.
-
#created_at ⇒ Object
readonly
Returns the value of attribute created_at.
-
#currency ⇒ Object
readonly
Returns the value of attribute currency.
-
#current_subtotal_price ⇒ Object
readonly
Returns the value of attribute current_subtotal_price.
-
#current_subtotal_price_set ⇒ Object
readonly
Returns the value of attribute current_subtotal_price_set.
-
#current_total_discounts ⇒ Object
readonly
Returns the value of attribute current_total_discounts.
-
#current_total_discounts_set ⇒ Object
readonly
Returns the value of attribute current_total_discounts_set.
-
#current_total_duties_set ⇒ Object
readonly
Returns the value of attribute current_total_duties_set.
-
#current_total_price ⇒ Object
readonly
Returns the value of attribute current_total_price.
-
#current_total_price_set ⇒ Object
readonly
Returns the value of attribute current_total_price_set.
-
#current_total_tax ⇒ Object
readonly
Returns the value of attribute current_total_tax.
-
#current_total_tax_set ⇒ Object
readonly
Returns the value of attribute current_total_tax_set.
-
#customer ⇒ Object
readonly
Returns the value of attribute customer.
-
#customer_locale ⇒ Object
readonly
Returns the value of attribute customer_locale.
-
#discount_applications ⇒ Object
readonly
Returns the value of attribute discount_applications.
-
#discount_codes ⇒ Object
readonly
Returns the value of attribute discount_codes.
-
#email ⇒ Object
readonly
Returns the value of attribute email.
-
#estimated_taxes ⇒ Object
readonly
Returns the value of attribute estimated_taxes.
-
#financial_status ⇒ Object
readonly
Returns the value of attribute financial_status.
-
#fulfillment_status ⇒ Object
readonly
Returns the value of attribute fulfillment_status.
-
#fulfillments ⇒ Object
readonly
Returns the value of attribute fulfillments.
-
#gateway ⇒ Object
readonly
Returns the value of attribute gateway.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#landing_site ⇒ Object
readonly
Returns the value of attribute landing_site.
-
#line_items ⇒ Object
readonly
Returns the value of attribute line_items.
-
#location_id ⇒ Object
readonly
Returns the value of attribute location_id.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#note ⇒ Object
readonly
Returns the value of attribute note.
-
#note_attributes ⇒ Object
readonly
Returns the value of attribute note_attributes.
-
#number ⇒ Object
readonly
Returns the value of attribute number.
-
#order_number ⇒ Object
readonly
Returns the value of attribute order_number.
-
#order_status_url ⇒ Object
readonly
Returns the value of attribute order_status_url.
-
#original_total_duties_set ⇒ Object
readonly
Returns the value of attribute original_total_duties_set.
-
#payment_details ⇒ Object
readonly
Returns the value of attribute payment_details.
-
#payment_gateway_names ⇒ Object
readonly
Returns the value of attribute payment_gateway_names.
-
#payment_terms ⇒ Object
readonly
Returns the value of attribute payment_terms.
-
#phone ⇒ Object
readonly
Returns the value of attribute phone.
-
#presentment_currency ⇒ Object
readonly
Returns the value of attribute presentment_currency.
-
#processed_at ⇒ Object
readonly
Returns the value of attribute processed_at.
-
#processing_method ⇒ Object
readonly
Returns the value of attribute processing_method.
-
#referring_site ⇒ Object
readonly
Returns the value of attribute referring_site.
-
#refunds ⇒ Object
readonly
Returns the value of attribute refunds.
-
#shipping_address ⇒ Object
readonly
Returns the value of attribute shipping_address.
-
#shipping_lines ⇒ Object
readonly
Returns the value of attribute shipping_lines.
-
#source_identifier ⇒ Object
readonly
Returns the value of attribute source_identifier.
-
#source_name ⇒ Object
readonly
Returns the value of attribute source_name.
-
#source_url ⇒ Object
readonly
Returns the value of attribute source_url.
-
#subtotal_price ⇒ Object
readonly
Returns the value of attribute subtotal_price.
-
#subtotal_price_set ⇒ Object
readonly
Returns the value of attribute subtotal_price_set.
-
#tags ⇒ Object
readonly
Returns the value of attribute tags.
-
#tax_lines ⇒ Object
readonly
Returns the value of attribute tax_lines.
-
#taxes_included ⇒ Object
readonly
Returns the value of attribute taxes_included.
-
#test ⇒ Object
readonly
Returns the value of attribute test.
-
#token ⇒ Object
readonly
Returns the value of attribute token.
-
#total_discounts ⇒ Object
readonly
Returns the value of attribute total_discounts.
-
#total_discounts_set ⇒ Object
readonly
Returns the value of attribute total_discounts_set.
-
#total_line_items_price ⇒ Object
readonly
Returns the value of attribute total_line_items_price.
-
#total_line_items_price_set ⇒ Object
readonly
Returns the value of attribute total_line_items_price_set.
-
#total_outstanding ⇒ Object
readonly
Returns the value of attribute total_outstanding.
-
#total_price ⇒ Object
readonly
Returns the value of attribute total_price.
-
#total_price_set ⇒ Object
readonly
Returns the value of attribute total_price_set.
-
#total_shipping_price_set ⇒ Object
readonly
Returns the value of attribute total_shipping_price_set.
-
#total_tax ⇒ Object
readonly
Returns the value of attribute total_tax.
-
#total_tax_set ⇒ Object
readonly
Returns the value of attribute total_tax_set.
-
#total_tip_received ⇒ Object
readonly
Returns the value of attribute total_tip_received.
-
#total_weight ⇒ Object
readonly
Returns the value of attribute total_weight.
-
#updated_at ⇒ Object
readonly
Returns the value of attribute updated_at.
-
#user_id ⇒ Object
readonly
Returns the value of attribute user_id.
Attributes inherited from Rest::Base
Class Method Summary collapse
- .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) ⇒ Object
- .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
- .delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object
- .find(id:, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object
Instance Method Summary collapse
- #cancel(amount: nil, currency: nil, restock: nil, reason: nil, email: nil, refund: nil, body: nil, **kwargs) ⇒ Object
- #close(body: nil, **kwargs) ⇒ Object
-
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Order
constructor
A new instance of Order.
- #open(body: nil, **kwargs) ⇒ Object
Methods inherited from Rest::Base
base_find, class_name, create_instance, create_instances_from_response, #delete, get_path, has_many?, has_one?, json_body_name, #method_missing, next_page?, next_page_info, prev_page?, prev_page_info, primary_key, read_only_attributes, request, #respond_to_missing?, #save, #save!, #to_hash
Constructor Details
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Order
Returns a new instance of Order.
12 13 14 15 16 17 18 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 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 12 def initialize(session: ShopifyAPI::Context.active_session) super(session: session) @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])) @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(Float)) @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)) 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.
116 117 118 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 116 def app_id @app_id end |
#billing_address ⇒ Object (readonly)
Returns the value of attribute billing_address.
118 119 120 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 118 def billing_address @billing_address end |
#browser_ip ⇒ Object (readonly)
Returns the value of attribute browser_ip.
120 121 122 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 120 def browser_ip @browser_ip end |
#buyer_accepts_marketing ⇒ Object (readonly)
Returns the value of attribute buyer_accepts_marketing.
122 123 124 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 122 def buyer_accepts_marketing @buyer_accepts_marketing end |
#cancel_reason ⇒ Object (readonly)
Returns the value of attribute cancel_reason.
124 125 126 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 124 def cancel_reason @cancel_reason end |
#cancelled_at ⇒ Object (readonly)
Returns the value of attribute cancelled_at.
126 127 128 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 126 def cancelled_at @cancelled_at end |
#cart_token ⇒ Object (readonly)
Returns the value of attribute cart_token.
128 129 130 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 128 def cart_token @cart_token end |
#checkout_token ⇒ Object (readonly)
Returns the value of attribute checkout_token.
130 131 132 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 130 def checkout_token @checkout_token end |
#client_details ⇒ Object (readonly)
Returns the value of attribute client_details.
132 133 134 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 132 def client_details @client_details end |
#closed_at ⇒ Object (readonly)
Returns the value of attribute closed_at.
134 135 136 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 134 def closed_at @closed_at end |
#created_at ⇒ Object (readonly)
Returns the value of attribute created_at.
136 137 138 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 136 def created_at @created_at end |
#currency ⇒ Object (readonly)
Returns the value of attribute currency.
138 139 140 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 138 def currency @currency end |
#current_subtotal_price ⇒ Object (readonly)
Returns the value of attribute current_subtotal_price.
140 141 142 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 140 def current_subtotal_price @current_subtotal_price end |
#current_subtotal_price_set ⇒ Object (readonly)
Returns the value of attribute current_subtotal_price_set.
142 143 144 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 142 def current_subtotal_price_set @current_subtotal_price_set end |
#current_total_discounts ⇒ Object (readonly)
Returns the value of attribute current_total_discounts.
144 145 146 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 144 def current_total_discounts @current_total_discounts end |
#current_total_discounts_set ⇒ Object (readonly)
Returns the value of attribute current_total_discounts_set.
146 147 148 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 146 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.
148 149 150 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 148 def current_total_duties_set @current_total_duties_set end |
#current_total_price ⇒ Object (readonly)
Returns the value of attribute current_total_price.
150 151 152 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 150 def current_total_price @current_total_price end |
#current_total_price_set ⇒ Object (readonly)
Returns the value of attribute current_total_price_set.
152 153 154 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 152 def current_total_price_set @current_total_price_set end |
#current_total_tax ⇒ Object (readonly)
Returns the value of attribute current_total_tax.
154 155 156 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 154 def current_total_tax @current_total_tax end |
#current_total_tax_set ⇒ Object (readonly)
Returns the value of attribute current_total_tax_set.
156 157 158 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 156 def current_total_tax_set @current_total_tax_set end |
#customer ⇒ Object (readonly)
Returns the value of attribute customer.
158 159 160 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 158 def customer @customer end |
#customer_locale ⇒ Object (readonly)
Returns the value of attribute customer_locale.
160 161 162 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 160 def customer_locale @customer_locale end |
#discount_applications ⇒ Object (readonly)
Returns the value of attribute discount_applications.
162 163 164 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 162 def discount_applications @discount_applications end |
#discount_codes ⇒ Object (readonly)
Returns the value of attribute discount_codes.
164 165 166 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 164 def discount_codes @discount_codes end |
#email ⇒ Object (readonly)
Returns the value of attribute email.
166 167 168 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 166 def email @email end |
#estimated_taxes ⇒ Object (readonly)
Returns the value of attribute estimated_taxes.
168 169 170 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 168 def estimated_taxes @estimated_taxes end |
#financial_status ⇒ Object (readonly)
Returns the value of attribute financial_status.
170 171 172 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 170 def financial_status @financial_status end |
#fulfillment_status ⇒ Object (readonly)
Returns the value of attribute fulfillment_status.
172 173 174 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 172 def fulfillment_status @fulfillment_status end |
#fulfillments ⇒ Object (readonly)
Returns the value of attribute fulfillments.
174 175 176 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 174 def fulfillments @fulfillments end |
#gateway ⇒ Object (readonly)
Returns the value of attribute gateway.
176 177 178 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 176 def gateway @gateway end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
178 179 180 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 178 def id @id end |
#landing_site ⇒ Object (readonly)
Returns the value of attribute landing_site.
180 181 182 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 180 def landing_site @landing_site end |
#line_items ⇒ Object (readonly)
Returns the value of attribute line_items.
114 115 116 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 114 def line_items @line_items end |
#location_id ⇒ Object (readonly)
Returns the value of attribute location_id.
182 183 184 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 182 def location_id @location_id end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
184 185 186 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 184 def name @name end |
#note ⇒ Object (readonly)
Returns the value of attribute note.
186 187 188 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 186 def note @note end |
#note_attributes ⇒ Object (readonly)
Returns the value of attribute note_attributes.
188 189 190 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 188 def note_attributes @note_attributes end |
#number ⇒ Object (readonly)
Returns the value of attribute number.
190 191 192 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 190 def number @number end |
#order_number ⇒ Object (readonly)
Returns the value of attribute order_number.
192 193 194 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 192 def order_number @order_number end |
#order_status_url ⇒ Object (readonly)
Returns the value of attribute order_status_url.
194 195 196 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 194 def order_status_url @order_status_url end |
#original_total_duties_set ⇒ Object (readonly)
Returns the value of attribute original_total_duties_set.
196 197 198 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 196 def original_total_duties_set @original_total_duties_set end |
#payment_details ⇒ Object (readonly)
Returns the value of attribute payment_details.
198 199 200 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 198 def payment_details @payment_details end |
#payment_gateway_names ⇒ Object (readonly)
Returns the value of attribute payment_gateway_names.
200 201 202 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 200 def payment_gateway_names @payment_gateway_names end |
#payment_terms ⇒ Object (readonly)
Returns the value of attribute payment_terms.
203 204 205 |
# File 'lib/shopify_api/rest/resources/2021_10/order.rb', line 203 def payment_terms @payment_terms end |
#phone ⇒ Object (readonly)
Returns the value of attribute phone.
202 203 204 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 202 def phone @phone end |
#presentment_currency ⇒ Object (readonly)
Returns the value of attribute presentment_currency.
204 205 206 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 204 def presentment_currency @presentment_currency end |
#processed_at ⇒ Object (readonly)
Returns the value of attribute processed_at.
206 207 208 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 206 def processed_at @processed_at end |
#processing_method ⇒ Object (readonly)
Returns the value of attribute processing_method.
208 209 210 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 208 def processing_method @processing_method end |
#referring_site ⇒ Object (readonly)
Returns the value of attribute referring_site.
210 211 212 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 210 def referring_site @referring_site end |
#refunds ⇒ Object (readonly)
Returns the value of attribute refunds.
212 213 214 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 212 def refunds @refunds end |
#shipping_address ⇒ Object (readonly)
Returns the value of attribute shipping_address.
214 215 216 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 214 def shipping_address @shipping_address end |
#shipping_lines ⇒ Object (readonly)
Returns the value of attribute shipping_lines.
216 217 218 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 216 def shipping_lines @shipping_lines end |
#source_identifier ⇒ Object (readonly)
Returns the value of attribute source_identifier.
218 219 220 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 218 def source_identifier @source_identifier end |
#source_name ⇒ Object (readonly)
Returns the value of attribute source_name.
220 221 222 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 220 def source_name @source_name end |
#source_url ⇒ Object (readonly)
Returns the value of attribute source_url.
222 223 224 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 222 def source_url @source_url end |
#subtotal_price ⇒ Object (readonly)
Returns the value of attribute subtotal_price.
224 225 226 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 224 def subtotal_price @subtotal_price end |
#subtotal_price_set ⇒ Object (readonly)
Returns the value of attribute subtotal_price_set.
226 227 228 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 226 def subtotal_price_set @subtotal_price_set end |
#tags ⇒ Object (readonly)
Returns the value of attribute tags.
228 229 230 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 228 def @tags end |
#tax_lines ⇒ Object (readonly)
Returns the value of attribute tax_lines.
230 231 232 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 230 def tax_lines @tax_lines end |
#taxes_included ⇒ Object (readonly)
Returns the value of attribute taxes_included.
232 233 234 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 232 def taxes_included @taxes_included end |
#test ⇒ Object (readonly)
Returns the value of attribute test.
234 235 236 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 234 def test @test end |
#token ⇒ Object (readonly)
Returns the value of attribute token.
236 237 238 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 236 def token @token end |
#total_discounts ⇒ Object (readonly)
Returns the value of attribute total_discounts.
238 239 240 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 238 def total_discounts @total_discounts end |
#total_discounts_set ⇒ Object (readonly)
Returns the value of attribute total_discounts_set.
240 241 242 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 240 def total_discounts_set @total_discounts_set end |
#total_line_items_price ⇒ Object (readonly)
Returns the value of attribute total_line_items_price.
242 243 244 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 242 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.
244 245 246 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 244 def total_line_items_price_set @total_line_items_price_set end |
#total_outstanding ⇒ Object (readonly)
Returns the value of attribute total_outstanding.
246 247 248 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 246 def total_outstanding @total_outstanding end |
#total_price ⇒ Object (readonly)
Returns the value of attribute total_price.
248 249 250 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 248 def total_price @total_price end |
#total_price_set ⇒ Object (readonly)
Returns the value of attribute total_price_set.
250 251 252 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 250 def total_price_set @total_price_set end |
#total_shipping_price_set ⇒ Object (readonly)
Returns the value of attribute total_shipping_price_set.
252 253 254 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 252 def total_shipping_price_set @total_shipping_price_set end |
#total_tax ⇒ Object (readonly)
Returns the value of attribute total_tax.
254 255 256 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 254 def total_tax @total_tax end |
#total_tax_set ⇒ Object (readonly)
Returns the value of attribute total_tax_set.
256 257 258 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 256 def total_tax_set @total_tax_set end |
#total_tip_received ⇒ Object (readonly)
Returns the value of attribute total_tip_received.
258 259 260 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 258 def total_tip_received @total_tip_received end |
#total_weight ⇒ Object (readonly)
Returns the value of attribute total_weight.
260 261 262 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 260 def total_weight @total_weight end |
#updated_at ⇒ Object (readonly)
Returns the value of attribute updated_at.
262 263 264 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 262 def updated_at @updated_at end |
#user_id ⇒ Object (readonly)
Returns the value of attribute user_id.
264 265 266 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 264 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, status: nil, financial_status: nil, fulfillment_status: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 326 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
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 366 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
293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 293 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
274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 274 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
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 402 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
429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 429 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
450 451 452 453 454 455 456 457 458 459 460 461 462 463 |
# File 'lib/shopify_api/rest/resources/2021_07/order.rb', line 450 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 |