Graph API Version

Product Catalog Categories

Reading

Categories and associated assets within given product catalog.

Example

Graph API Explorer
GET /v4.0/{product-catalog-id}/categories 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(
    '/{product-catalog-id}/categories',
    '{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(
    "/{product-catalog-id}/categories",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{product-catalog-id}/categories",
    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:@"/{product-catalog-id}/categories"
                                      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

ParameterDescription
categorization_criteria
enum {BRAND, CATEGORY, PRODUCT_TYPE}

Product property used to define categories

Required
filter
A JSON-encoded rule

SELF_EXPLANATORY

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of ProductCatalogCategory nodes.

paging

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

Validation Rules

ErrorDescription
100Invalid parameter

Creating

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

Parameters

ParameterDescription
data
list<JSON object>

Array of category specifications

Required
categorization_criteria
enum {BRAND, CATEGORY, PRODUCT_TYPE}

Required
criteria_value
string

Required
name
UTF-8 string

Supports Emoji
description
UTF-8 string

Supports Emoji
destination_uri
URL

image_url
URL

tokens
JSON object {string : string}

Return Type

Struct {
updated: integer,
skipped: integer,
total: integer,
details: Map {
string: List [
Map {
string: string
}
]
},
}

Validation Rules

ErrorDescription
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.