Graph API Version

Commerce Promotion Detail

Reading

Details about a promotion.

New Page Experience

This endpoint is supported for New Page Experience.

Example

Graph API Explorer
GET v24.0/...?fields={fieldname_of_type_CommercePromotionDetail} 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_CommercePromotionDetail}',
    '{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_CommercePromotionDetail}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_CommercePromotionDetail}",
    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_CommercePromotionDetail}"
                                      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
applied_after_tax
bool

Indicates if the offer was applied after calculating tax on the products.

applied_amount
CommerceCurrencyAmount

The applied amount of the offer.

campaign_name
string

The title of the offer.

coupon_code
string

The coupon code that was used to apply an offer to the order.

promotion_id
string

Meta's ID for the offer.

retailer_id
string

The retailer's ID for the offer.

sponsor
string

The sponsor of the offer.

target_granularity
string

The target granularity of the promotion. item_level refers to applied discounts where the discount value is applied to each unit of the relevant line item. order_level and checkout_level refer to applied discounts where the discount value is applied once for the line item, and is applied across all units for that line item.

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.