Method: FacebookCommerce::ReturnApi#create_return

Defined in:
lib/facebook_commerce.rb

#create_return(order_id, items, return_status, return_message, merchant_return_id) ⇒ Hash

Return response, eg. { id: ‘1234567890’ }

Parameters:

  • order_id (String) —

    Facebook order ID

  • items (Array<Hash>) —

    Array of item hashes (item_id|retailer_id, quantity, reason)

  • return_status (String) —

    Reason code for the return, eg. ‘REQUESTED’, ‘APPROVED’, ‘DISAPPROVED’, ‘REFUNDED’, ‘MERCHANT_MARKED_COMPLETED’

Returns:

  • (Hash) —

    Return response, eg. { id: ‘1234567890’ }



182
183
184
185
186
187
188
189
190
 
# File 'lib/facebook_commerce.rb', line 182

def create_return(order_id, items, return_status, return_message, merchant_return_id)
  data = {
    items: CGI.escape(JSON.generate items),
    return_status: return_status,
    return_message: return_message,
    merchant_return_id: merchant_return_id
  }
  post("#{order_id}/returns", data)
end