Method: ShopifyAPI::Order#cancel

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,
lib/shopify_api/rest/resources/2025_07/order.rb

#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