Graph API Version

Product Catalog Pricing Variables Batch

Batch upload pricing variables for items in a catalog. Used with Dynamic Ads for Travel, see Dynamic Ads for Travel, Catalog Setup. To get status of batch process:

curl -G \
-d "handle=<HANDLE>" \
-d "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<API_VERSION>/<PRODUCT_CATALOG_ID>/pricing_variables_batch

If you want to update a specific pricing variable, please make sure you provide a complete set of information in <Result>.
If you want to delete a specific pricing variable, specify the combination without providing any price-related info such as <Baserate>, <Tax>, <OtherFees>.

To delete one of the pricing variables for hotel_1, with check in 2016-05-01 for 1 night:

In pricings_data_xml.xml, provide:

<?xml version="1.0" encoding="UTF-8"?>
<Transaction>
  <Result>
    <Property>hotel_1</Property>
    <Checkin>2016-05-01</Checkin>
    <Nights>1</Nights>
  </Result>
</Transaction>

then make a HTTP POST to pricing_variables_batch:

curl \
-X POST \
-F "standard=google" \
-F file=@pricings_data_xml.xml \
-F "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<API_VERSION>/<PRODUCT_CATALOG_ID>/pricing_variables_batch

Reading

pricing_variables_batch

Example

Update one of the pricing variables for hotel_1 with check in 2016-05-01 for 3 nights and delete one of the pricing variables forhotel_2 with check in 2016-05-05 for 1 night:

In pricings_data_xml.xml, provide:

<?xml version="1.0" encoding="UTF-8"?>
<Transaction>
  <Result>
    <Property>hotel_1</Property>
    <Checkin>2016-05-01</Checkin>
    <Nights>3</Nights>
    <RoomBundle>
      <RoomID>single</RoomID>
      <Baserate currency="USD">189</Baserate>
      <Tax currency="USD">18.64</Tax>
      <OtherFees currency="USD">10.00</OtherFees>
    </RoomBundle>
  </Result>
  <Result>
    <Property>hotel_2</Property>
    <Checkin>2016-05-05</Checkin>
    <Nights>1</Nights>
  </Result>  
</Transaction>

then make a HTTP POST to pricing_variables_batch:

curl \
-X POST \
-F "standard=google" \
-F file=@pricings_data_xml.xml \
-F "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<API_VERSION>/<PRODUCT_CATALOG_ID>/pricing_variables_batch

Example

Graph API Explorer

GET /v21.0/{product-catalog-id}/pricing_variables_batch 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(
    '/{product-catalog-id}/pricing_variables_batch',
    '{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(
    "/{product-catalog-id}/pricing_variables_batch",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{product-catalog-id}/pricing_variables_batch",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{product-catalog-id}/pricing_variables_batch"
                                      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

Parameter Description

Parameter	Description
`handle` string	A unique handle of a batch request. Required

handle

string

A unique handle of a batch request.

Required

Fields

Reading from this edge will return a JSON formatted result:

{
    "data": [],
    "paging": {}
}

`data`

A list of ProductCatalogPricingVariablesBatch nodes.

`paging`

For more details about pagination, see the Graph API guide.

Error Codes

Error	Description
100	Invalid parameter

Creating

You can make a POST request to pricing_variables_batch edge from the following paths:

/{product_catalog_id}/pricing_variables_batch

When posting to this edge, a ProductCatalogPricingVariablesBatch will be created.

Parameters

Parameter	Description
`file` file	Content of the file to be uploaded
`password` string	If used url then the password for the file
`standard` enum{google}	Uploaded file export standard Required
`update_only` boolean	Default value: `false` If true, rows missing in the file will not be deleted from Facebook database (only new and updated rows are applied)
`url` URL	The url of the file to be downloaded by our system
`username` string	If used url then the username for the file

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

handles: List [

string

}

Error Codes

Error	Description
200	Permissions error

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.