Class: FacebookCommerce::CancellationRefundApi

Inherits:

Api

• Object
• Api
• FacebookCommerce::CancellationRefundApi

Defined in:

lib/facebook_commerce.rb

Instance Attribute Summary

Attributes inherited from Api

#access_token, #cms_id, #logger

Instance Method Summary

• #cancel_order(order_id) ⇒ Hash

  Cancellation response, eg.

• #refund_order(order_id, reason_code, items = nil) ⇒ Hash

  Refund response, eg.

Methods inherited from Api

#initialize

Constructor Details

This class inherits a constructor from FacebookCommerce::Api

Instance Method Details

#cancel_order(order_id) ⇒ Hash

Returns Cancellation response, eg. { success: true}.

Parameters:

• order_id (String) —

  Facebook order ID

Returns:

• (Hash) —

  Cancellation response, eg. { success: true}

# File 'lib/facebook_commerce.rb', line 161

def cancel_order(order_id)
  data = { idempotency_key: SecureRandom.uuid }
  post("#{order_id}/cancellations", data)
end

#refund_order(order_id, reason_code, items = nil) ⇒ Hash

Returns Refund response, eg. { success: true}.

Parameters:

• order_id (String) —

  Facebook order ID

• reason_code (String) —

  Reason code for the refund, eg. ‘REFUND_REASON_OTHER’

• items (Array<Hash>) (defaults to: nil) —

  Item hashes (retailer_id|product_id, quantity), required if partial refund

Returns:

• (Hash) —

  Refund response, eg. { success: true}

# File 'lib/facebook_commerce.rb', line 170

def refund_order(order_id, reason_code, items = nil)
  data = { reason_code: reason_code, idempotency_key: SecureRandom.uuid }
  post("#{order_id}/refunds", data)
end