Marketing API

Send Item Updates

To send item updates, use the /{catalog_id}/batch endpoint.

To create, update, or delete items in your catalog, make an HTTP POST call to:

https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch?requests=<REQUESTS>

Parameters

The parameter names for /{catalog_id}/batch and /{catalog_id}/items_batch may appear to be similar, but they are distinctly different.

Parameter Type Description

allow_upsert

boolean

When allow_upsert is false, update requests for items not existing in the catalog will not be completed. Otherwise, new items are created.

requests

object

A JSON object containing all requests.

requests.data

object

A JSON object containing fields and values for an item.

  • When the method is CREATE, this object must contain all the required fields.
  • When the method is UPDATE, it can contain any fields.

requests.method

string

CREATE, UPDATE, DELETE

requests.retailer_id

string

The advertiser-supplied id of an item; not the FBID.

The UPDATE method can also be used to create items if they don't already exist.

For more details, see the API reference.

Limitations

  • The requests param can contain up to 5,000 updates.
  • For each catalog, you can make up to 100 calls per hour. If that's not sufficient, please contact us.
  • The batch size limit is 5000.

Supported Fields

See the list of supported fields for the /{catalog_id}/batch endpoint.

You can use the applink field to specify deep link information; it works in a similar way to Deep Links. Provide your deep link information in the JSON format shown below.

"applink" : {"ios": [{"url":"example-ios://electronic","app_store_id":42,"app_name":"Electronic Example iOS"}],"iphone": [{"url":"example-iphone://electronic","app_store_id":43,"app_name":"Electronic Example iPhone"}],"ipad": [{"url":"example-ipad://electronic","app_store_id":44,"app_name":"Electronic Example iPad"}],"android": [{"url":"example-android://electronic","package":"com.electronic","class":"com.electronic.Example","app_name":"Electronic Example Android",}],"windows_phone": [{"url":"example-windows://electronic","app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0","app_name":"Electronic Example Windows"}]}

There's a minor difference in the field names compared to the ones in Deep Links as each app type is a separate node and is enclosed in their respective fields.

'data\[applink\]\[android\]' is an array with only one value specified under it. This is the same case for other app types.

We don't support iOS Universal Links.

Learn More