Graph API Version

Business Owned Product Catalogs

Reading

Product catalogs owned by this business.

Example

Graph API Explorer
GET /v7.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();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* 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.

Validation Rules

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

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
commerce_merchant_settings
Object

Commerce merchant settings for catalog.

braintree_auth_code
string

braintree_merchant_id
string

checkout_message
string
Default value:

currency
string

disable_checkout_urls
boolean
Default value: false

display_name
string
Default value:

has_discount_code
boolean
Default value: false

logo_uri
URL
Default value:

merchant_alert_email
string

merchant_status
enum {ENABLED, EXTERNALLY_DISABLED}

override_existing_merchant_settings
boolean

payment_provider_details
JSON-encoded string

privacy_url_by_locale
dictionary { locale string : <URL> }

public_key
string

supported_card_types
list<enum {VISA, MASTERCARD, AMERICANEXPRESS, DISCOVER}>

terms_url_by_locale
dictionary { locale string : <URL> }

contact_email
string

Required
merchant_page
numeric string or integer

Required
payment_provider
enum {CONTACT_MERCHANT, OFFSITE_LINK}

Required
terms
string

Required
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
onsite_commerce_merchant
Object

Onsite commerce merchant.

merchant_page_id
numeric string or integer

merchant_business_info
JSON object

merchant_fulfillment
JSON object

marketplace_approval_requested
boolean

merchant_status
enum {ENABLED, EXTERNALLY_DISABLED}

override_existing_merchant_settings
boolean

sandboxed
boolean

store_catalog_settings
JSON object

Store catalog settings.

page_id
page ID

page_id

Required
vertical
enum {bookable, commerce, destinations, flights, home_listings, hotels, jobs, local_service_businesses, offer_items, offline_commerce, ticketed_experiences, 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,
onsite_commerce_merchant: Struct {
id: numeric string,
},
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.