Graph API Version

Product Feed

You must meet the following requirements to use Product Feed.

Your business must be listed in Business Manager
You must be an employee of your business, or be an employee of an Agency which is assigned to this business

Reading

A feed is a set of items uploaded or fetched from a source at once. You can have a single feed to represent all of the items in your catalog, or you can have multiple feeds with each feed representing a single country or single division's products

Feed Format

The Product Feed consists of a series of items in either a Tab Separated file or XML. In XML, these should exist as an array of <item>'s. In a tab separated file, the header column is required.

Parameters

This endpoint doesn't have any parameters.

Fields

Field	Description
`id` numeric string	ID number of the feed Default
`country` string	An ISO 3166-1 Alpha 2 country code
`created_time` datetime	The creation time of the feed
`default_currency` string	Your default currency for items in a feed. If no currency is specified for items in the feed file, this value will be used
`deletion_enabled` bool	This allows items to be deleted if a feed is updated and the items are not included in the new feed file
`delimiter` enum {AUTODETECT, BAR, COMMA, TAB, TILDE, SEMICOLON}	The delimiter used in feed file
`encoding` enum	The character encoding used by the provided feed
`file_name` string	The file name of a feed. This will be overridden by `name` if `name` is present Default
`ingestion_source_type` enum {primary_feed, supplementary_feed}	Indicates the type of feed. `PRIMARY_FEED`: Use this to add and remove products from the data feed. This is the most common use-case. Note: `PRIMARY_FEED` is the default value. `SUPPLEMENTARY_FEED`: Use this to overwrite data in existing primary feeds. When using this field, the `primary_feeds` field must also be provided. Learn more about supplementary feeds.
`item_sub_type` enum	The sub type of items to be uploaded by this feed
`latest_upload` ProductFeedUpload	The latest upload session of a feed
`migrated_from_feed_id` numeric string	The previous product feed id where the catalog items migrated from
`name` string	The name of a feed Default
`override_type` enum	If it is a secondary feed, this is the type of the override (country or language)
`primary_feeds` list<string>	Used in conjunction with `ingestion_source_type=supplementary_feed`. List of primary feed IDs to which the supplementary feed should be linked. Must provide at least 1 linked primary feed. See how to create supplementary feeds.
`product_count` int32	The total products in a product feed
`quoted_fields_mode` enum {AUTODETECT, ON, OFF}	This allows tabs and new lines within fields
`schedule` ProductFeedSchedule	The configuration for fetching the full feed in a recurrent manner. The uploads as a result of this schedule would replace the entire feed. Items missing in consequent upload feed file would be deleted
`update_schedule` ProductFeedSchedule	The configuration for fetching updates to a feed in a recurrent manner. The uploads as a result of this schedule would only update the items in the feed or create new ones with the information in the file. No items would be deleted. This is useful for sending `price` and `availability` updates for selected items in the feed

Edges

Edge	Description
`automotive_models` Edge<AutomotiveModel>	Automotive models in a feed
`destinations` Edge<Destination>	Destinations in a feed
`flights` Edge<Flight>	Flights in a feed
`home_listings` Edge<HomeListing>	Home listings in a feed
`hotels` Edge<Hotel>	Hotels in a feed
`media_titles` Edge<MediaTitle>	Media titles in a feed
`products` Edge<ProductItem>	Products in a feed
`rules` Edge<ProductFeedRule>	rules
`uploads` Edge<ProductFeedUpload>	Concrete upload attempts
`vehicle_offers` Edge<VehicleOffer>	Vehicle offers in a feed
`vehicles` Edge<Vehicle>	Vehicles in a feed

Error Codes

Error	Description
100	Invalid parameter
368	The action attempted has been deemed abusive or is otherwise disallowed
190	Invalid OAuth 2.0 Access Token

Creating

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

/{product_catalog_id}/product_feeds

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

Example

Graph API Explorer

POST /v21.0/{product-catalog-id}/product_feeds HTTP/1.1
Host: graph.facebook.com

name=Test+Feed&schedule=%7B%22interval%22%3A%22DAILY%22%2C%22url%22%3A%22http%3A%2F%2Fwww.example.com%2Fsample_feed.tsv%22%2C%22hour%22%3A%2222%22%7D

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/{product-catalog-id}/product_feeds',
    array (
      'name' => 'Test Feed',
      'schedule' => '{"interval":"DAILY","url":"http://www.example.com/sample_feed.tsv","hour":"22"}',
    ),
    '{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}/product_feeds",
    "POST",
    {
        "name": "Test Feed",
        "schedule": "{\"interval\":\"DAILY\",\"url\":\"http:\/\/www.example.com\/sample_feed.tsv\",\"hour\":\"22\"}"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Bundle params = new Bundle();
params.putString("name", "Test Feed");
params.putString("schedule", "{\"interval\":\"DAILY\",\"url\":\"http://www.example.com/sample_feed.tsv\",\"hour\":\"22\"}");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{product-catalog-id}/product_feeds",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

NSDictionary *params = @{
  @"name": @"Test Feed",
  @"schedule": @"{\"interval\":\"DAILY\",\"url\":\"http://www.example.com/sample_feed.tsv\",\"hour\":\"22\"}",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{product-catalog-id}/product_feeds"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

curl -X POST \
  -F 'name="Test Feed"' \
  -F 'schedule={
       "interval": "DAILY",
       "url": "http://www.example.com/sample_feed.tsv",
       "hour": "22"
     }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/{product-catalog-id}/product_feeds

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

Parameter	Description
`country` ISO 3166 Alpha Country Code	Default value: `US` Two letter country code where the products can be sold
`default_currency` ISO 4217 Currency Code	Default value: `USD` The default currency used by provided feed if the currency is not specified in the feed file
`deletion_enabled` boolean	Default value: `true` Default value: `false` (to be changed to `true` .from API v2.5) When `true`, this will remove products from a catalog that are no longer present in a feed. When `false`, uploading a product feed is additive and products will remain in the catalog even if they are removed from a feed. Once enabled, we do not allow this field to be disabled.
`delimiter` enum {AUTODETECT, BAR, COMMA, TAB, TILDE, SEMICOLON}	Default value: `AUTODETECT` Product feed delimiter
`encoding` enum {AUTODETECT, LATIN1, UTF8, UTF16LE, UTF16BE, UTF32LE, UTF32BE}	Default value: `AUTODETECT` The character encoding used by provided feed
`feed_type` enum {AUTOMOTIVE_MODEL, COLLECTION, DESTINATION, FLIGHT, HOME_LISTING, HOTEL, HOTEL_ROOM, LOCAL_INVENTORY, MEDIA_TITLE, OFFER, PRODUCTS, TRANSACTABLE_ITEMS, VEHICLE_OFFER, VEHICLES}	Type of the feed. Decides type of catalog item this feed will create
`file_name` UTF-8 encoded string	The name of the product feed. .tsv, .xml or compressed files (zip, gzip and bz2) are supported
`ingestion_source_type` enum {PRIMARY_FEED, SUPPLEMENTARY_FEED}	ingestion_source_type to decide type of feed i.e. primary or supplementary
`item_sub_type` enum {APPLIANCES, BABY_FEEDING, BABY_TRANSPORT, BEAUTY, BEDDING, CAMERAS, CELL_PHONES_AND_SMART_WATCHES, CLEANING_SUPPLIES, CLOTHING, CLOTHING_ACCESSORIES, COMPUTERS_AND_TABLETS, DIAPERING_AND_POTTY_TRAINING, ELECTRONICS_ACCESSORIES, FURNITURE, HEALTH, HOME_GOODS, JEWELRY, NURSERY, PRINTERS_AND_SCANNERS, PROJECTORS, SHOES_AND_FOOTWEAR, SOFTWARE, TOYS, TVS_AND_MONITORS, VIDEO_GAME_CONSOLES_AND_VIDEO_GAMES, WATCHES}	The sub type of items to be uploaded by this feed
`migrated_from_feed_id` numeric string	Used to split an original feed into multiple new feeds, `migrated_from_feed_id` denotes the original feed's ID. Setting this field ensures that items from an original field can be migrated to a new one, without the need of deletion. This field is generally used when splitting a large feed into multiple smaller feeds. Example: You have a large feed called Feed A and want to split it. You create a new feed called Feed B and specify Feed A's ID under `migrated_from_feed_id`. You upload Feed B's catalog information, including the products you want to add to Feed B. The items from feed A have been moved to feed B. Going forward, you do not need to specify those items in Feed A and they can be removed from feed A.
`name` UTF-8 encoded string	User specified name for the feed
`override_type` enum {LANGUAGE, COUNTRY, VERSION, CATALOG_SEGMENT_CUSTOMIZE_DEFAULT, LANGUAGE_AND_COUNTRY, BATCH_API_LANGUAGE_OR_COUNTRY, SMART_PIXEL_LANGUAGE_OR_COUNTRY, LOCAL}	If this is a secondary feed, this specifies the override type of the feed
`override_value` string	Override value of the feed dependent on the override type (country or language).
`primary_feed_ids` list<numeric string>	primary_feed_ids to which a supplementary feed should be linked
`quoted_fields_mode` enum{autodetect, on, off}	Default value: `autodetect` Whether or not there will be quotes around each field, only for TSV feeds. If this field is provided, we use it instead of the parameter quoted_fields
`rules` list<JSON-encoded string>	A list of rules applied to feed uploads
`schedule` JSON-encoded string	A JSON-encoded string representing a recurrent schedule for fetching the feed. Default timezone is America/Los_Angeles. Learn more about feed schedules
`selected_override_fields` array<string>	Selected Override Fields of the feed, written as a list of fields which should be processed from the feed file. From whiltelisted_properties
`update_schedule` JSON-encoded string	The configuration for fetching updates to a feed in a recurrent manner. The uploads would only update the items in the feed or create new ones. No items would be deleted. This is useful for sending `price` and `availability` updates for selected items in the feed. Learn more about fields in a feed schedule

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

}

Error Codes

Error	Description
100	Invalid parameter
200	Permissions error

Updating

You can't perform this operation on this endpoint.

Deleting

Deleting a product feed effectively disables all ads using products that come from this feed.

You can create a new feed with the same product IDs to re-enable those ads.

Examples

curl -X DELETE \
-d "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<API_VERSION>/<PRODUCT_FEED_ID>

You can delete a ProductFeed by making a DELETE request to /{product_feed_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {

success: bool,

}

Error Codes

Error	Description
100	Invalid parameter
3964	You must be assigned as an admin of this product feed before you can delete it.