Graph API Version

Commerce Order Item Tax Details

Reading

Additional information about the tax associated with an item in an order

New Page Experience

This endpoint is supported for New Page Experience.

Example

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

This represents the original tax collected on items that are fulfilled. This number will be updated based on shipments fulfilled. For Example: If an order contains 10 of an item and the estimated tax is $2.50 when the first shipment is made containing 1 item, then capture_tax would be $0.25. Then merchant cancels five items and ships four items then capture_tax would be $1.21 (previous 1 item 0.25+0.24*4 items). capture_tax varies based on fulfillments, and price can be different based on fulfillment location. The capture_tax amount may differ from the estimated_tax amount.

estimated_tax
CommerceCurrencyAmount

Total estimated tax for this item (all quantity), calculated during order creation by Facebook. This estimated tax never changes after order creation. This amount is estimated because actual tax calculation is done when order is fulfilled. See captured_tax.

remitted_estimated_tax
CommerceCurrencyAmount

Total estimated tax for the item to be withheld by Facebook.

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.