Get details about a refund on a Commerce Order
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
}];refunds edge from the following paths: | Parameter | Description |
|---|---|
adjustment_amountJSON object | adjustment_amount |
deductionsarray<JSON object> | Amount to be deducted off of the refund. Commonly used for return label fee for order returns. |
idempotency_keystring | Idempotency key for the request Required |
itemsarray<JSON object> | For partial refund, specify the item level breakdown. Not required for full refund. |
reason_codeenum {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_textstring | Reason for the refund. This message is presented to the customer. |
return_idnumeric string | The Return Request you are refunding (optional) |
shippingJSON object | Amount to be refunded for shipping. |
success: bool, external_tax_refund: Struct {used: bool, skip_reason: Struct {error_code: int32, error_message: string, | Error | Description |
|---|---|
| 100 | Invalid parameter |