Graph API Version

Business Owned Product Catalogs

Reading

Product catalogs owned by this business.

Example

Graph API Explorer
GET /v21.0/{business-id}/owned_product_catalogs 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(
    '/{business-id}/owned_product_catalogs',
    '{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(
    "/{business-id}/owned_product_catalogs",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-id}/owned_product_catalogs",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{business-id}/owned_product_catalogs"
                                      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

This endpoint doesn't have any parameters.

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of ProductCatalog nodes.

paging

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

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
190Invalid OAuth 2.0 Access Token
368The action attempted has been deemed abusive or is otherwise disallowed
104Incorrect signature

Creating

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

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, jobs, 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
200Permissions error
2310068Cannot create a catalog segment from a non CPAS compliant parent catalog
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.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.