product.item

This object type represents a product item.

Markup
 <head prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# product: http://ogp.me/ns/product#">
  <meta property="fb:app_id"                content="302184056577324" /> 
  <meta property="og:type"                  content="product.item" /> 
  <meta property="og:url"                   content="Put your own URL to the object here" /> 
  <meta property="og:title"                 content="Sample Item" /> 
  <meta property="og:image"                 content="https://fbstatic-a.akamaihd.net/images/devsite/attachment_blank.png" /> 
  <meta property="product:retailer_item_id" content="Sample Retailer Product Item ID" /> 
  <meta property="product:price:amount"     content="Sample Price: " /> 
  <meta property="product:price:currency"   content="Sample Price: " /> 
  <meta property="product:availability"     content="Sample Availability" /> 
  <meta property="product:condition"        content="Sample Condition" />
Create
/* make the API call */
FB.api(
    "/me/objects/product.item",
    "POST",
    {
        "object": "{\"fb:app_id\":\"302184056577324\",\"og:type\":\"product.item\",\"og:url\":\"Put your own URL to the object here\",\"og:title\":\"Sample Item\",\"og:image\":\"https:\\\/\\\/fbstatic-a.akamaihd.net\\\/images\\\/devsite\\\/attachment_blank.png\",\"product:retailer_item_id\":\"Sample Retailer Product Item ID\",\"product:price:amount\":\"Sample Price: \",\"product:price:currency\":\"Sample Price: \",\"product:availability\":\"Sample Availability\",\"product:condition\":\"Sample Condition\"}"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
NSDictionary *params = @{
  @"object": @"{\"fb:app_id\":\"302184056577324\",\"og:type\":\"product.item\",\"og:url\":\"Put your own URL to the object here\",\"og:title\":\"Sample Item\",\"og:image\":\"https:\/\/fbstatic-a.akamaihd.net\/images\/devsite\/attachment_blank.png\",\"product:retailer_item_id\":\"Sample Retailer Product Item ID\",\"product:price:amount\":\"Sample Price: \",\"product:price:currency\":\"Sample Price: \",\"product:availability\":\"Sample Availability\",\"product:condition\":\"Sample Condition\"}",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/me/objects/product.item"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
Bundle params = new Bundle();
params.putString("object", "{\"fb:app_id\":\"302184056577324\",\"og:type\":\"product.item\",\"og:url\":\"Put your own URL to the object here\",\"og:title\":\"Sample Item\",\"og:image\":\"https:\/\/fbstatic-a.akamaihd.net\/images\/devsite\/attachment_blank.png\",\"product:retailer_item_id\":\"Sample Retailer Product Item ID\",\"product:price:amount\":\"Sample Price: \",\"product:price:currency\":\"Sample Price: \",\"product:availability\":\"Sample Availability\",\"product:condition\":\"Sample Condition\"}");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/me/objects/product.item",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/me/objects/product.item',
    array (
      'object' => '{"fb:app_id":"302184056577324","og:type":"product.item","og:url":"Put your own URL to the object here","og:title":"Sample Item","og:image":"https:\\/\\/fbstatic-a.akamaihd.net\\/images\\/devsite\\/attachment_blank.png","product:retailer_item_id":"Sample Retailer Product Item ID","product:price:amount":"Sample Price: ","product:price:currency":"Sample Price: ","product:availability":"Sample Availability","product:condition":"Sample Condition"}',
    ),
    '{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 */
POST /v2.12/me/objects/product.item HTTP/1.1
Host: graph.facebook.com

object=%7B%22fb%3Aapp_id%22%3A%22302184056577324%22%2C%22og%3Atype%22%3A%22product.item%22%2C%22og%3Aurl%22%3A%22Put+your+own+URL+to+the+object+here%22%2C%22og%3Atitle%22%3A%22Sample+Item%22%2C%22og%3Aimage%22%3A%22https%3A%5C%2F%5C%2Ffbstatic-a.akamaihd.net%5C%2Fimages%5C%2Fdevsite%5C%2Fattachment_blank.png%22%2C%22product%3Aretailer_item_id%22%3A%22Sample+Retailer+Product+Item+ID%22%2C%22product%3Aprice%3Aamount%22%3A%22Sample+Price%3A+%22%2C%22product%3Aprice%3Acurrency%22%3A%22Sample+Price%3A+%22%2C%22product%3Aavailability%22%3A%22Sample+Availability%22%2C%22product%3Acondition%22%3A%22Sample+Condition%22%7D
curl -X POST \
     -d "object=%7B%22fb%3Aapp_id%22%3A%22302184056577324%22%2C%22og%3Atype%22%3A%22product.item%22%2C%22og%3Aurl%22%3A%22Put+your+own+URL+to+the+object+here%22%2C%22og%3Atitle%22%3A%22Sample+Item%22%2C%22og%3Aimage%22%3A%22https%3A%5C%2F%5C%2Ffbstatic-a.akamaihd.net%5C%2Fimages%5C%2Fdevsite%5C%2Fattachment_blank.png%22%2C%22product%3Aretailer_item_id%22%3A%22Sample+Retailer+Product+Item+ID%22%2C%22product%3Aprice%3Aamount%22%3A%22Sample+Price%3A+%22%2C%22product%3Aprice%3Acurrency%22%3A%22Sample+Price%3A+%22%2C%22product%3Aavailability%22%3A%22Sample+Availability%22%2C%22product%3Acondition%22%3A%22Sample+Condition%22%7D" \
        https://graph.facebook.com/v2.12/me/objects/product.item
Read
/* make the API call */
FB.api(
    "/me/objects/product.item",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/me/objects/product.item"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/me/objects/product.item",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/me/objects/product.item',
    '{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 */
GET /v2.12/me/objects/product.item HTTP/1.1
Host: graph.facebook.com
curl https://graph.facebook.com/v2.12/me/objects/product.item
Update
/* make the API call */
FB.api(
    "/id_from_create_call",
    "POST",
    {
        "object": "{\"fb:app_id\":\"302184056577324\",\"og:type\":\"product.item\",\"og:url\":\"Put your own URL to the object here\",\"og:title\":\"Sample Item\",\"og:image\":\"https:\\\/\\\/fbstatic-a.akamaihd.net\\\/images\\\/devsite\\\/attachment_blank.png\",\"product:retailer_item_id\":\"Sample Retailer Product Item ID\",\"product:price:amount\":\"Sample Price: \",\"product:price:currency\":\"Sample Price: \",\"product:availability\":\"Sample Availability\",\"product:condition\":\"Sample Condition\"}"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
NSDictionary *params = @{
  @"object": @"{\"fb:app_id\":\"302184056577324\",\"og:type\":\"product.item\",\"og:url\":\"Put your own URL to the object here\",\"og:title\":\"Sample Item\",\"og:image\":\"https:\/\/fbstatic-a.akamaihd.net\/images\/devsite\/attachment_blank.png\",\"product:retailer_item_id\":\"Sample Retailer Product Item ID\",\"product:price:amount\":\"Sample Price: \",\"product:price:currency\":\"Sample Price: \",\"product:availability\":\"Sample Availability\",\"product:condition\":\"Sample Condition\"}",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/id_from_create_call"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
Bundle params = new Bundle();
params.putString("object", "{\"fb:app_id\":\"302184056577324\",\"og:type\":\"product.item\",\"og:url\":\"Put your own URL to the object here\",\"og:title\":\"Sample Item\",\"og:image\":\"https:\/\/fbstatic-a.akamaihd.net\/images\/devsite\/attachment_blank.png\",\"product:retailer_item_id\":\"Sample Retailer Product Item ID\",\"product:price:amount\":\"Sample Price: \",\"product:price:currency\":\"Sample Price: \",\"product:availability\":\"Sample Availability\",\"product:condition\":\"Sample Condition\"}");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/id_from_create_call",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/id_from_create_call',
    array (
      'object' => '{"fb:app_id":"302184056577324","og:type":"product.item","og:url":"Put your own URL to the object here","og:title":"Sample Item","og:image":"https:\\/\\/fbstatic-a.akamaihd.net\\/images\\/devsite\\/attachment_blank.png","product:retailer_item_id":"Sample Retailer Product Item ID","product:price:amount":"Sample Price: ","product:price:currency":"Sample Price: ","product:availability":"Sample Availability","product:condition":"Sample Condition"}',
    ),
    '{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 */
POST /v2.12/id_from_create_call HTTP/1.1
Host: graph.facebook.com

object=%7B%22fb%3Aapp_id%22%3A%22302184056577324%22%2C%22og%3Atype%22%3A%22product.item%22%2C%22og%3Aurl%22%3A%22Put+your+own+URL+to+the+object+here%22%2C%22og%3Atitle%22%3A%22Sample+Item%22%2C%22og%3Aimage%22%3A%22https%3A%5C%2F%5C%2Ffbstatic-a.akamaihd.net%5C%2Fimages%5C%2Fdevsite%5C%2Fattachment_blank.png%22%2C%22product%3Aretailer_item_id%22%3A%22Sample+Retailer+Product+Item+ID%22%2C%22product%3Aprice%3Aamount%22%3A%22Sample+Price%3A+%22%2C%22product%3Aprice%3Acurrency%22%3A%22Sample+Price%3A+%22%2C%22product%3Aavailability%22%3A%22Sample+Availability%22%2C%22product%3Acondition%22%3A%22Sample+Condition%22%7D
curl -X POST \
     -d "object=%7B%22fb%3Aapp_id%22%3A%22302184056577324%22%2C%22og%3Atype%22%3A%22product.item%22%2C%22og%3Aurl%22%3A%22Put+your+own+URL+to+the+object+here%22%2C%22og%3Atitle%22%3A%22Sample+Item%22%2C%22og%3Aimage%22%3A%22https%3A%5C%2F%5C%2Ffbstatic-a.akamaihd.net%5C%2Fimages%5C%2Fdevsite%5C%2Fattachment_blank.png%22%2C%22product%3Aretailer_item_id%22%3A%22Sample+Retailer+Product+Item+ID%22%2C%22product%3Aprice%3Aamount%22%3A%22Sample+Price%3A+%22%2C%22product%3Aprice%3Acurrency%22%3A%22Sample+Price%3A+%22%2C%22product%3Aavailability%22%3A%22Sample+Availability%22%2C%22product%3Acondition%22%3A%22Sample+Condition%22%7D" \
        https://graph.facebook.com/v2.12/id_from_create_call
Delete
/* make the API call */
FB.api(
    "/id_from_create_call",
    "DELETE",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/id_from_create_call"
                                      parameters:params
                                      HTTPMethod:@"DELETE"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/id_from_create_call",
    null,
    HttpMethod.DELETE,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->delete(
    '/id_from_create_call',
    array (),
    '{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 */
DELETE /v2.12/id_from_create_call HTTP/1.1
Host: graph.facebook.com
curl -X DELETE \
        https://graph.facebook.com/v2.12/id_from_create_call
Properties
NameTypeDescription
FIELDS
product:age_groupEnumThe target age group of the item, one of 'kids' or 'adult'
product:availabilityEnumClassThe availability of the item, one of 'preorder', 'in stock', 'available for order', or 'out of stock'
product:brandStringThe brand of the product or its original manufacturer
product:categoryStringA category for the item
product:colorStringThe color of the item
product:conditionEnumClassThe condition of the item, one of 'new', 'refurbished', or 'used'
product:expiration_timeDateTimeThe time when the item will expire
product:group_refReferenceA reference to the product group object for this item
product:gtinProductIDA Global Trade Item Number, which encompasses UPC, EAN, JAN, and ISBN
product:materialStringThe material used to make the item
product:mfr_part_noStringA manufacturer's part number for the item
product:patternStringThe pattern used on the item
product:priceArray<Currency>The price of the item
product:price:amountFloatThe value of the price of the item
product:price:currencyStringThe currency of the price of the item
product:retailer_categoryStringThe retailer's category for the item
product:retailer_group_idStringThe retailer product group ID for this item
product:retailer_item_idStringThe retailer's ID for the item
product:sale_priceCurrencyThe sale price of the item
product:sale_price:amountFloatThe value of the sale price of the item
product:sale_price:currencyStringThe currency of the sale price of the item
product:sale_price_datesDateTimeRangeThe date range for which the sale price is valid
product:sale_price_dates:startDateTimeThe ending date and time of the sale
product:sale_price_dates:endDateTimeThe starting date and time of the sale
product:shipping_costArray<Currency>The shipping cost of the item
product:shipping_cost:amountFloatThe value of the shipping cost of the item
product:shipping_cost:currencyStringThe currency of the shipping cost of the item
product:shipping_weightQuantityThe weight of the item
product:shipping_weight:valueFloatThe value of the shipping weight of the item
product:shipping_weight:unitsEnumThe units of the shipping weight of the item
product:sizeStringThe size of the item (such as 'S', 'M', 'L')
product:target_genderEnumThe target gender of the item, one of 'female', 'male', or 'unisex'
INHERITED FIELDS
al:androidArray<Struct>
al:android:urlAppsite
al:android:packageAndroidPath
al:android:app_nameString
al:android:classString
al:iosArray<IosApplink>
al:ios:urlAppsite
al:ios:app_store_idInteger
al:ios:app_nameString
al:ipadArray<IosApplink>
al:ipad:urlAppsite
al:ipad:app_store_idInteger
al:ipad:app_nameString
al:iphoneArray<IosApplink>
al:iphone:urlAppsite
al:iphone:app_store_idInteger
al:iphone:app_nameString
al:webStruct
al:web:urlURL
al:web:should_fallbackBoolean
al:windowsArray<Struct>
al:windows:urlAppsite
al:windows:package_family_nameString
al:windows:app_idGuid
al:windows:app_nameString
al:windows_phoneArray<Struct>
al:windows_phone:urlAppsite
al:windows_phone:app_idGuid
al:windows_phone:app_nameString
al:windows_universalArray<Struct>
al:windows_universal:urlAppsite
al:windows_universal:package_family_nameString
al:windows_universal:app_idGuid
al:windows_universal:app_nameString
fb:adminsArray<Facebook ID>An array of the Facebook IDs of the app's administrators
fb:app_idFacebook IDA Facebook app ID
fb:pagesArray<Facebook ID>
fb:profile_idProfileThe Facebook ID of a user that can be followed
ia:markup_urlURL
ia:markup_url_devURL
ia:rules_urlURL
ia:rules_url_devURL
og:audioArray<Audio>
og:audio:urlStringThe URL of an audio resource associated with the object
og:audio:secure_urlURLAn alternate URL to use if an audio resource requires HTTPS
og:audio:typeStringThe MIME type of an audio resource associated with the object
og:descriptionStringA short description of the object
og:determinerEnumThe word that appears before the object's title in a sentence. This is an list of words from 'a', 'an', 'the', ' "" ', or 'auto'. If 'auto' is chosen, the consumer of the object will chose between 'a' or 'an'. The default is the blank, "".
og:imageArray<Image>
og:image:urlURLThe URL of an image resource associated with the object
og:image:secure_urlURLAn alternate URL to use if an image resource requires HTTPS
og:image:typeStringThe MIME type of an image resource
og:image:widthIntegerThe width of an image resource in pixels
og:image:heightIntegerThe height of an image resource in pixels
og:image:altString
og:image:user_generatedBoolean
og:localeLocaleNot supported
og:locale:localeEnum
og:locale:alternateArray<Enum>Not supported
og:restrictionsRestrictions
og:restrictions:countryStruct
og:restrictions:country:allowedArray<Country>A whitelist country restriction for the object using a two-letter country code, such as 'US' (may not be used with og:restrictions:country:disallowed)
og:restrictions:country:disallowedArray<Country>A blacklist country restriction for the object using a two-letter country code, such as 'US' (may not be used with og:restrictions:country:allowed)
og:restrictions:ageAgeAn age restriction for the object, such as '13+', '18+'
og:restrictions:contentArray<Content>A content restriction for the object, such as 'alcohol' (the only currently supported value)
og:rich_attachmentBoolean
og:see_alsoArray<URL>An array of URLs of related resources
og:site_nameStringNot supported
og:titleStringThe title of the object as it should appear in the graph
og:ttlInteger
og:typeStringThe type of the object, such as 'article'
og:updated_timeDateTimeThe time when the object was last updated
og:urlURLThe canonical URL of the object, used as its ID in the graph
og:videoArray<Video>
og:video:urlURLThe URL of a video resource associated with the object
og:video:secure_urlURLAn alternate URL to use if a video resource requires HTTPS
og:video:typeStringThe MIME type of a video resource associated with the object
og:video:widthIntegerThe width of a video resource associated with the object in pixels
og:video:heightIntegerThe height of a video resource associated with the object in pixels