Graph API Version

Commerce Order Refund

Reading

Get details about a refund on a Commerce Order

New Page Experience

This endpoint is supported for New Page Experience.

Example

Graph API Explorer
GET v24.0/...?fields={fieldname_of_type_CommerceOrderRefund} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '...?fields={fieldname_of_type_CommerceOrderRefund}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "...?fields={fieldname_of_type_CommerceOrderRefund}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_CommerceOrderRefund}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"...?fields={fieldname_of_type_CommerceOrderRefund}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

Refund ID

refund_amount
CommerceOrderRefundAmount

Total refunded amount for this refund request (includes tax)

refund_reason
CommerceOrderRefundReason

Reason for refund

Edges

EdgeDescription
Edge<CommerceOrderRefundItem>

Items included in the refund

Creating

You can make a POST request to refunds edge from the following paths:
When posting to this edge, a CommerceOrderRefund will be created.

Parameters

ParameterDescription
adjustment_amount
JSON object

adjustment_amount

currency
string

currency

Required
amount
string

amount

Required
deductions
array<JSON object>

Amount to be deducted off of the refund. Commonly used for return label fee for order returns.

deduction_type
enum {RETURN_SHIPPING, RESTOCKING_FEE, TOTAL_DEDUCTIONS_AMOUNT}

deduction_type

Required
deduction_amount
JSON object

deduction_amount

Required
currency
string

currency

Required
amount
string

amount

Required
idempotency_key
string

Idempotency key for the request

Required
items
array<JSON object>

For partial refund, specify the item level breakdown. Not required for full refund.

retailer_id
string

retailer_id

tax_refund
JSON object

tax_refund

currency
string

currency

Required
amount
string

amount

Required
item_refund_amount
JSON object

item_refund_amount

currency
string

currency

Required
amount
string

amount

Required
item_refund_quantity
int64

item_refund_quantity

item_id
string

item_id

reason_code
enum {BUYERS_REMORSE, DAMAGED_GOODS, FACEBOOK_INITIATED, NOT_AS_DESCRIBED, QUALITY_ISSUE, REFUND_COMPROMISED, REFUND_SFI_FAKE, REFUND_SFI_REAL, REFUND_REASON_OTHER, REFUND_FOR_RETURN, WRONG_ITEM}

Reason for the refund.

Required
reason_text
string

Reason for the refund. This message is presented to the customer.

return_id
numeric string

The Return Request you are refunding (optional)

shipping
JSON object

Amount to be refunded for shipping.

shipping_refund
JSON object

shipping_refund

Required
currency
string

currency

Required
amount
string

amount

Required
tax_refund
JSON object

tax_refund

currency
string

currency

Required
amount
string

amount

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
external_tax_refund: Struct {
used: bool,
skip_reason: Struct {
error_code: int32,
error_message: string,
},
},
}

Error Codes

ErrorDescription
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.