Marketing API
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=[<PIXEL_ID>,<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

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, 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

Default
business
Business

Business that owns a catalog

da_display_settings
ProductCatalogImageSettings

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.

is_local_catalog
bool

is_local_catalog

name
string

The name of a catalog given by the creator

Default
product_count
int32

The total number of products in a catalog

vertical
enum

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

Edges

EdgeDescription
agencies
Edge<Business>

Agencies that have access to a catalog

assigned_users
Edge<AssignedUser>

Users assigned to this catalog

automotive_models
Edge<AutomotiveModel>

Automotive models that a catalog contains

categories
Edge<ProductCatalogCategory>

Categories within the catalog for a given categorization criteria

check_batch_request_status
Edge<CheckBatchRequestStatus>

Checks the status of a batch request

collaborative_ads_share_settings
Edge<CollaborativeAdsShareSettings>

All the collaborative ads share settings for a catalog segment

data_sources
Edge<ProductCatalogDataSource>

data_sources updating catalog including feeds, session containers etc

destinations
Edge<Destination>

Destinations that a catalog contains

diagnostics
Edge<ProductCatalogDiagnosticGroup>

diagnostics

event_stats
Edge<ProductEventStat>

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
Edge<ExternalEventSource>

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

flights
Edge<Flight>

Flights that a catalog contains

home_listings
Edge<HomeListing>

Home listings that a catalog contains

hotel_rooms_batch
Edge<ProductCatalogHotelRoomsBatch>

Batch operations with hotel rooms

hotels
Edge<Hotel>

Hotels that a catalog contains

pricing_variables_batch
Edge<ProductCatalogPricingVariablesBatch>

Batch operations with hotel room prices

product_groups
Edge<ProductGroup>

Product groups that a catalog contains

product_sets
Edge<ProductSet>

Product sets belonging to a catalog

product_sets_batch
Edge<ProductCatalogProductSetsBatch>

Batch operations with product sets

products
Edge<ProductItem>

Products that a catalog contains

vehicle_offers
Edge<VehicleOffer>

Vehicle offers that a catalog contains

vehicles
Edge<Vehicle>

Vehicles that a catalog contains

Error Codes

ErrorDescription
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed
190Invalid OAuth 2.0 Access Token
200Permissions error
2500Error parsing graph query

Creating

Examples

curl \
  -F 'name=Catalog' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/<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, AA_ANALYZE}>

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
415Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
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

web

android

ios

ipad

iphone

windows_phone

availability
enum {AVAILABLE, NOT_AVAILABLE, PENDING, UNKNOWN}

availability

body_style
enum {CONVERTIBLE, COUPE, CROSSOVER, ESTATE, GRANDTOURER, HATCHBACK, MINIBUS, MINIVAN, MPV, PICKUP, ROADSTER, SALOON, SEDAN, SMALL_CAR, SPORTSCAR, SUPERCAR, SUPERMINI, SUV, TRUCK, 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
10800Duplicate retailer_id when attempting to create a store collection
100Invalid parameter
200Permissions error
You can make a POST request to owned_product_catalogs edge from the following paths:
When posting to this edge, a ProductCatalog will be created.

Parameters

ParameterDescription
additional_vertical_option
enum {LOCAL_DA_CATALOG, LOCAL_PRODUCTS}

Additional catalog configurations that does not introduce either new verticals or subverticals

business_metadata
JSON object

business_metadata

page_id
numeric string

page_id

Required
external_business_id
string

external_business_id

catalog_segment_filter
A JSON-encoded rule

Provide filter for catalog to create a catalog segment.

da_display_settings
Object

Dynamic Ads display settings.

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
destination_catalog_settings
JSON object

Destination catalog settings.

generate_items_from_pages
boolean
Default value: false

flight_catalog_settings
JSON object

Flight catalog settings.

generate_items_from_events
boolean
Default value: false

name
UTF-8 encoded string

Name of the catalog.

Required
parent_catalog_id
numeric string or integer

Parent catalog ID.

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

Store catalog settings.

page_id
numeric string

page_id

Required
vertical
enum {adoptable_pets, commerce, destinations, flights, generic, home_listings, hotels, local_service_businesses, offer_items, offline_commerce, transactable_items, vehicles}
Default value: commerce

The catalog's industry or vertical, such as commerce.

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
190Invalid OAuth 2.0 Access Token
804Specified object already exists
102Session key invalid or no longer valid
200Permissions error
2310019The business of this catalog is not onboarded to Collaborative Ads

Updating

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

Parameters

ParameterDescription
additional_vertical_option
enum {LOCAL_DA_CATALOG, LOCAL_PRODUCTS}

Additional catalog configurations that does not introduce either new verticals or subverticals

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
URI

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
URI

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
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
numeric string

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 'batch=[{
  "method":"DELETE",
  "relative_url":"<PRODUCT_CATALOG_ID>"
}]' \
 -F 'access_token=<TOKEN>' \
  https://graph.facebook.com


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

curl -X DELETE \
  -F 'external_event_sources=[<APP_ID>,<PIXEL_ID>]' \
  -F 'access_token=<TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/<PRODUCT_CATALOG_ID>/external_event_sources


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

curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/<API_VERSION>/<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
3970You must be assigned as an admin of this product catalog before you can delete it.
801Invalid operation
100Invalid parameter
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