Graph API Version

Product Catalog

Represents a catalog for your business you can use to deliver ads with dynamic ads.

Example — View all product catalogs associated to your business

curl -G \
  -d "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/owned_product_catalogs"

You can associate pixels and apps with a product catalog and then display products in ads based on signals from pixels or apps.

Example — Make an HTTP POST

curl 
  -F 'external_event_sources[0]=<PIXEL_ID>' 
  -F 'external_event_sources[1]=<APP_ID>'  
  -F 'access_token=<ACCESS_TOKEN>'
  https://graph.facebook.com/<VERSION>/<PRODUCT_CATALOG_ID>/external_event_sources

Permissions

You need the appropriate Marketing API Access Level and must accept the Terms of Service by creating your first catalog through Business Manager.

Reading

Product catalogs contain a list of items like products, hotels or flights, and the information needed to display them in dynamic ads

Starting September 14, 2021, the following fields will throw an error for version 12.0+ calls made by apps that lack the endpoint's required permissions. This change will apply to all versions on December 13, 2021.

  • commerce_merchant_settings

Parameters

ParameterDescription
segment_use_cases
array<enum {AFFILIATE_SELLER_STOREFRONT, AFFILIATE_TAGGED_ONLY_DEPRECATED, COLLAB_ADS, COLLAB_ADS_FOR_MARKETPLACE_PARTNER, COLLAB_ADS_SEGMENT_WITHOUT_SEGMENT_SYNCING, CREATORS_AS_SELLERS, DIGITAL_CIRCULARS, FB_LIVE_SHOPPING, IG_SHOPPING, IG_SHOPPING_SUGGESTED_PRODUCTS, MARKETPLACE_SHOPS, TEST}>

segment_use_cases

Fields

FieldDescription
id
numeric string

ID of a catalog

business

Business that owns a catalog

commerce_merchant_settings

Merchant settings for the items sold in a catalog

da_display_settings

Image display settings such as background cropping and padding of items in the catalog for different Dynamic Ad formats

default_image_url
string

The URL for the default image, which is used for products without images, or when the product image is temporarily unavailable. If a product image matches the default image, this should be treated as if the image was not loaded

fallback_image_url
list<string>

The URL for the fallback image. This is used as the image for auto-generated dynamic items

feed_count
int32

The total number of feeds used by a catalog

is_catalog_segment
bool

Verify that you will create ads based on a catalog or catalog segment before you try to create Dynamic Ads. Call this field and determine value otherwise you may get and error when you try to create Dynamic Ads from catalog segments.

name
string

The name of a catalog given by the creator

product_count
int32

The total number of products in a catalog

store_catalog_settings

Catalog settings for a store catalog that promotes physical in-store items

vertical
enum

The type of catalog (for example: hotels, commerce, etc)

Edges

EdgeDescription

Agencies that have access to a catalog

Checks the status of batch upload request for container effects

Users assigned to this catalog

Auto Markets that a catalog contains

Automotive models that a catalog contains

Categories within the catalog for a given categorization criteria

Checks the status of a batch request

All the collaborative ads share settings for a catalog segment

diagnostics

Aggregated statistics on the matched and unmatchd events received from the pixels and apps associated to the catalog, broken down by DA event, source and device_type

External event sources (including pixels) for catalog events like ViewContent

Home listings that a catalog contains

Media titles that a catalog contains

Product groups that a catalog contains

Product sets belonging to a catalog

Products that a catalog contains

Vehicle offers that a catalog contains

Vehicles that a catalog contains

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
368The action attempted has been deemed abusive or is otherwise disallowed

Creating

Examples

use FacebookAds\Object\ProductCatalog;
use FacebookAds\Object\Fields\ProductCatalogFields;

$product_catalog = new ProductCatalog(null, <BUSINESS_ID>);

$product_catalog->setData(array(
  ProductCatalogFields::NAME => "Catalog",
));

$product_catalog->create();
from facebookads.adobjects.productcatalog import ProductCatalog

product_catalog = ProductCatalog(parent_id=<BUSINESS_ID>)

product_catalog[ProductCatalog.Field.name] = 'Catalog'

product_catalog.remote_create()
ProductCatalog catalog = new Business(<BUSINESS_ID>, context).createProductCatalog()
  .setName("Catalog")
  .execute();
String catalog_id = catalog.getId();
curl \
  -F 'name=Catalog' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<BUSINESS_ID>/product_catalogs

You can make a POST request to assigned_users edge from the following paths:
When posting to this edge, a ProductCatalog will be created.

Parameters

ParameterDescription
tasks
array<enum {MANAGE, ADVERTISE, MANAGE_AR}>

Catalog permission tasks to assign this user

Required
user
UID

Business user id or system user id

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
You can make a POST request to vehicles edge from the following paths:
When posting to this edge, a ProductCatalog will be created.

Parameters

ParameterDescription
address
JSON object

address

Required
city
string
Default value: ""

city

city_id
string

city_id

country
string
Default value: ""

country

latitude
float

latitude

longitude
float

longitude

neighborhoods
array<string>

neighborhoods

postal_code
string
Default value: ""

postal_code

region
string
Default value: ""

region

street_address
string
Default value: ""

street_address

applinks
Object

applinks

android

ios

ipad

iphone

windows_phone

availability
enum {AVAILABLE, NOT_AVAILABLE, PENDING}

availability

body_style
enum {CONVERTIBLE, COUPE, CROSSOVER, HATCHBACK, MINIVAN, SMALL_CAR, TRUCK, SUV, SEDAN, VAN, WAGON, OTHER, NONE}

body_style

Required
condition
enum {EXCELLENT, VERY_GOOD, GOOD, FAIR, POOR, OTHER, NONE}

condition

currency
ISO 4217 Currency Code

currency

Required
date_first_on_lot
string

date_first_on_lot

dealer_id
string

dealer_id

dealer_name
string

dealer_name

dealer_phone
string

dealer_phone

description
string

description

Required
drivetrain
enum {TWO_WD, FOUR_WD, AWD, FWD, RWD, OTHER, NONE}

drivetrain

exterior_color
string

exterior_color

Required
fb_page_id
string

fb_page_id

fuel_type
enum {DIESEL, ELECTRIC, GASOLINE, FLEX, HYBRID, OTHER, PETROL, PLUGIN_HYBRID, NONE}

fuel_type

images
list<Object>

images

Required
image_url
URL

Required
tags
list<string>

interior_color
string

interior_color

make
string

make

Required
mileage
JSON object

mileage

Required
unit
enum {KILOMETERS, MILES}
Default value: "MILES"

unit

value
int64
Default value: 0

value

model
string

model

Required
price
int64

price

Required
state_of_vehicle
enum {NEW, USED, CPO}

state_of_vehicle

Required
title
string

title

Required
transmission
enum {AUTOMATIC, MANUAL, OTHER, NONE}

transmission

trim
string

trim

url
URI

url

Required
vehicle_id
string

vehicle_id

Required
vehicle_type
enum {BOAT, CAR_TRUCK, COMMERCIAL, MOTORCYCLE, OTHER, POWERSPORT, RV_CAMPER, TRAILER}

vehicle_type

vin
string

vin

Required
year
int64

year

Required

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

ErrorDescription
100Invalid parameter
You can make a POST request to items_batch edge from the following paths:
When posting to this edge, a ProductCatalog will be created.

Parameters

ParameterDescription
allow_upsert
boolean
Default value: true

Parameters specifying whether non existing items that are being updated should be inserted or should throw the error

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}
Default value: "EMPTY"

The sub vertical type of items in the request

item_type
string

The type of items in the request

Required
requests
JSON object

Array of JSON objects containing batch requests. Each batch request consists of method and data fields

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
handles: List [
string
],
validation_status: List [
Struct {
errors: List [
Struct {
message: string,
}
],
retailer_id: string,
warnings: List [
Struct {
message: string,
}
],
}
],
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
80009There have been too many calls to this Catalog account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.

Updating

You can update a ProductCatalog by making a POST request to /{whats_app_business_account_id}/product_catalogs.

Parameters

ParameterDescription
catalog_id
Product Catalog ID

The ID of the product catalog to link

Required

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter
You can update a ProductCatalog by making a POST request to /{product_catalog_id}.

Parameters

ParameterDescription
da_display_settings
Object

The display settings object when used will determine which image transformations (like cropping or padding) will be applied for the item in the specified dynamic ad format.

carousel_ad
Object

Required
transformation_type
enum{background_cropping_and_padding, background_padding, none}

Required
single_ad
Object

Required
transformation_type
enum{background_cropping_and_padding, background_padding, none}

Required
default_image_url
URL

The URL for the default image, which is used for products without images or for the cases when the product image is temproarily unavailable. If a product image matches the default image, this should be treated as if the image was not loaded.

destination_catalog_settings
JSON object

Catalog setting for destination catalogs.

generate_items_from_pages
boolean
Default value: false

fallback_image_url
URL

The URL for the fallback image. This is used as the image for the auto-generated dynamic items.

flight_catalog_settings
JSON object

Catalog setting for flight catalogs.

generate_items_from_events
boolean
Default value: false

name
UTF-8 encoded string

Name of the Product Catalog

partner_integration
JSON object

Partner integration settings

external_access_token
string

External access token

external_merchant_id
string

External merchant identifier

store_catalog_settings
JSON object

Catalog settings for store catalogs; the page with the location structure for all the stores within this settings will be used to validate the store number for feed uploading

page_id
page ID

page_id

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter

Deleting

Examples

You can delete a product catalog with the following API. You cannot remove a product catalog from a Business Manager, or transfer a catalog from one Business Manager to another.

curl -X DELETE \
-F 'access_token=<ACCESS_TOKEN>' \
"https://graph.facebook.com/<API_VERSION>/<PRODUCT_CATALOG_ID>"


To do this in a batch call, specify the parameter in the query string for the URL:

curl \
  -F 'access_token=<ACCESS_TOKEN>' \
  -F 'batch=[{"method":"DELETE", relative_url":"840962462523962/external_event_sources?  external_event_sources=["21344423883497713536356"]' \
  'https://graph.facebook.com'


To remove the association between the catalog and a pixel or app, make an HTTP DELETE:

use FacebookAds\Object\ProductCatalog;

$product_catalog = new ProductCatalog(<PRODUCT_CATALOG_ID>);
$product_catalog->deleteExternalEventSources(array(), array(
  <PIXEL_ID>,
  <APP_ID>,
));
from facebookads.adobjects.productcatalog import ProductCatalog

product_catalog = ProductCatalog(<PRODUCT_CATALOG_ID>)
product_catalog.remove_external_event_sources([
    <PIXEL_ID>,
    <APP_ID>,
])
curl -X DELETE \
  -d '0=<PIXEL_ID>' \
  -d '1=<APP_ID>' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<PRODUCT_CATALOG_ID>/external_event_sources


To see all pixel and apps associated with a product catalog, make an HTTP GET:

use FacebookAds\Object\ProductCatalog;

$product_catalog = new ProductCatalog(<PRODUCT_CATALOG_ID>);
$sources = $product_catalog->getExternalEventSources();
from facebookads.adobjects.productcatalog import ProductCatalog

product_catalog = ProductCatalog(<PRODUCT_CATALOG_ID>)
product_catalog.get_external_event_sources()
APINodeList<ExternalEventSource> externalEventSources = new ProductCatalog(<PRODUCT_CATALOG_ID>, context).getExternalEventSources()
  .execute();
curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<PRODUCT_CATALOG_ID>/external_event_sources

You can delete a ProductCatalog by making a DELETE request to /{product_catalog_id}.

Parameters

ParameterDescription
allow_delete_catalog_with_live_product_set
boolean
Default value: false

If the catalog has live product sets, the deletion will be blocked by default. Set this parameter to true to enforce the deletion even if it has live product sets

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
801Invalid operation
100Invalid parameter
3970You must be assigned as an admin of this product catalog before you can delete it.
You can dissociate a ProductCatalog from a ProductCatalog by making a DELETE request to /{product_catalog_id}/assigned_users.

Parameters

ParameterDescription
user
UID

Business user id or system user id

Required

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
You can dissociate a ProductCatalog from a WhatsAppBusinessAccount by making a DELETE request to /{whats_app_business_account_id}/product_catalogs.

Parameters

ParameterDescription
catalog_id
Product Catalog ID

The ID of the product catalog to unlink

Required

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter