Graph API Version

    Product Group Products

    Reading

    You can't perform this operation on this endpoint.

    Creating

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

    Parameters

    ParameterDescription
    additional_image_urls
    list<URL>

    Additional product image URLs

    additional_variant_attributes
    JSON object {string : string}

    Additional attributes to distinguish the product in its variant group (ex: {"Scent" : "Fruity", "Style" : "Classic"})

    android_app_name
    string

    The name of the app (suitable for display)

    android_class
    string

    A fully-qualified Activity class name for intent generation

    android_package
    string

    A fully-qualified package name for intent generation

    android_url
    string

    A custom scheme for the Android app

    availability
    enum{in stock, out of stock, preorder, available for order, discontinued, pending, mark_as_sold}
    Default value: in stock

    Availability of the product item

    brand
    string

    Brand of the product item

    category
    string

    Category of the product item. This is a required field

    checkout_url
    URL

    URL to add product item to cart and directly to checkout

    color
    string

    Color of the product item

    commerce_tax_category
    enum{FB_ANIMAL, FB_ANIMAL_SUPP, FB_APRL, FB_APRL_ACCESSORIES, FB_APRL_ATHL_UNIF, FB_APRL_CASES, FB_APRL_CLOTHING, FB_APRL_COSTUME, FB_APRL_CSTM, FB_APRL_FORMAL, FB_APRL_HANDBAG, FB_APRL_JEWELRY, FB_APRL_SHOE, FB_APRL_SHOE_ACC, FB_APRL_SWIM, FB_APRL_SWIM_CHIL, FB_APRL_SWIM_CVR, FB_ARTS, FB_ARTS_HOBBY, FB_ARTS_PARTY, FB_ARTS_PARTY_GIFT_CARD, FB_ARTS_TICKET, FB_BABY, FB_BABY_BATH, FB_BABY_BLANKET, FB_BABY_DIAPER, FB_BABY_GIFT_SET, FB_BABY_HEALTH, FB_BABY_NURSING, FB_BABY_POTTY_TRN, FB_BABY_SAFE, FB_BABY_TOYS, FB_BABY_TRANSPORT, FB_BABY_TRANSPORT_ACC, FB_BAGS, FB_BAGS_BKPK, FB_BAGS_BOXES, FB_BAGS_BRFCS, FB_BAGS_CSMT_BAG, FB_BAGS_DFFL, FB_BAGS_DIPR, FB_BAGS_FNNY, FB_BAGS_GRMT, FB_BAGS_LUG_ACC, FB_BAGS_LUGG, FB_BAGS_MSGR, FB_BAGS_TOTE, FB_BAGS_TRN_CAS, FB_BLDG, FB_BLDG_ACC, FB_BLDG_CNSMB, FB_BLDG_FENCE, FB_BLDG_FUEL_TNK, FB_BLDG_HT_VNT, FB_BLDG_LOCK, FB_BLDG_MATRL, FB_BLDG_PLMB, FB_BLDG_PUMP, FB_BLDG_PWRS, FB_BLDG_S_ENG, FB_BLDG_STR_TANK, FB_BLDG_TL_ACC, FB_BLDG_TOOL, FB_BUSIND, FB_BUSIND_ADVERTISING, FB_BUSIND_AGRICULTURE, FB_BUSIND_AUTOMATION, FB_BUSIND_HEAVY_MACH, FB_BUSIND_LAB, FB_BUSIND_MEDICAL, FB_BUSIND_RETAIL, FB_BUSIND_SANITARY_CT, FB_BUSIND_SIGN, FB_BUSIND_STORAGE, FB_BUSIND_STORAGE_ACC, FB_BUSIND_WORK_GEAR, FB_CAMERA_ACC, FB_CAMERA_CAMERA, FB_CAMERA_OPTIC, FB_CAMERA_OPTICS, FB_CAMERA_PHOTO, FB_ELEC, FB_ELEC_ACC, FB_ELEC_ARCDADE, FB_ELEC_AUDIO, FB_ELEC_CIRCUIT, FB_ELEC_COMM, FB_ELEC_COMPUTER, FB_ELEC_GPS_ACC, FB_ELEC_GPS_NAV, FB_ELEC_GPS_TRK, FB_ELEC_MARINE, FB_ELEC_NETWORK, FB_ELEC_PART, FB_ELEC_PRINT, FB_ELEC_RADAR, FB_ELEC_SFTWR, FB_ELEC_SPEED_RDR, FB_ELEC_TELEVISION, FB_ELEC_TOLL, FB_ELEC_VID_GM_ACC, FB_ELEC_VID_GM_CNSL, FB_ELEC_VIDEO, FB_FOOD, FB_FURN, FB_FURN_BABY, FB_FURN_BENCH, FB_FURN_CART, FB_FURN_CHAIR, FB_FURN_CHAIR_ACC, FB_FURN_DIVIDE, FB_FURN_DIVIDE_ACC, FB_FURN_ENT_CTR, FB_FURN_FUTN, FB_FURN_FUTN_PAD, FB_FURN_OFFICE, FB_FURN_OFFICE_ACC, FB_FURN_OTTO, FB_FURN_OUTDOOR, FB_FURN_OUTDOOR_ACC, FB_FURN_SETS, FB_FURN_SHELVE_ACC, FB_FURN_SHLF, FB_FURN_SOFA, FB_FURN_SOFA_ACC, FB_FURN_STORAGE, FB_FURN_TABL, FB_FURN_TABL_ACC, FB_GENERIC_TAXABLE, FB_HLTH, FB_HLTH_HLTH, FB_HLTH_JWL_CR, FB_HLTH_LILP_BLM, FB_HLTH_LTN_SPF, FB_HLTH_PRSL_CR, FB_HLTH_SKN_CR, FB_HMGN, FB_HMGN_BATH, FB_HMGN_DCOR, FB_HMGN_EMGY, FB_HMGN_FPLC, FB_HMGN_FPLC_ACC, FB_HMGN_GS_SFT, FB_HMGN_HS_ACC, FB_HMGN_HS_APP, FB_HMGN_HS_SPL, FB_HMGN_KTCN, FB_HMGN_LAWN, FB_HMGN_LGHT, FB_HMGN_LINN, FB_HMGN_LT_ACC, FB_HMGN_OTDR, FB_HMGN_POOL, FB_HMGN_SCTY, FB_HMGN_SMK_ACC, FB_HMGN_UMBR, FB_HMGN_UMBR_ACC, FB_MDIA, FB_MDIA_BOOK, FB_MDIA_DVDS, FB_MDIA_MAG, FB_MDIA_MANL, FB_MDIA_MUSC, FB_MDIA_PRJ_PLN, FB_MDIA_SHT_MUS, FB_OFFC, FB_OFFC_BKAC, FB_OFFC_CRTS, FB_OFFC_DSKP, FB_OFFC_EQIP, FB_OFFC_FLNG, FB_OFFC_GNRL, FB_OFFC_INSTM, FB_OFFC_LP_DSK, FB_OFFC_MATS, FB_OFFC_NM_PLT, FB_OFFC_PPR_HNDL, FB_OFFC_PRSNT_SPL, FB_OFFC_SEALR, FB_OFFC_SHIP_SPL, FB_RLGN, FB_RLGN_CMNY, FB_RLGN_ITEM, FB_RLGN_WEDD, FB_SFTWR, FB_SFWR_CMPTR, FB_SFWR_DGTL_GD, FB_SFWR_GAME, FB_SHIPPING, FB_SPOR, FB_SPORT_ATHL, FB_SPORT_ATHL_CLTH, FB_SPORT_ATHL_SHOE, FB_SPORT_ATHL_SPRT, FB_SPORT_EXRCS, FB_SPORT_INDR_GM, FB_SPORT_OTDR_GM, FB_TOYS, FB_TOYS_EQIP, FB_TOYS_GAME, FB_TOYS_PZZL, FB_TOYS_TMRS, FB_TOYS_TOYS, FB_VEHI, FB_VEHI_PART}

    commerce_tax_category

    condition
    enum{new, refurbished, used, used_like_new, used_good, used_fair, cpo, open_box_new}
    Default value: new

    The condition of the product item

    currency
    ISO 4217 Currency Code

    Currency for the product item

    Required
    custom_data
    dictionary { string : <string> }

    TBD

    custom_label_0
    string

    An optional custom label to associate with the product item. Max size: 100

    custom_label_1
    string

    An optional custom label to associate with the product item. Max size: 100

    custom_label_2
    string

    An optional custom label to associate with the product item. Max size: 100

    custom_label_3
    string

    An optional custom label to associate with the product item. Max size: 100

    custom_label_4
    string

    An optional custom label to associate with the product item. Max size: 100

    custom_number_0
    int64

    custom_number_0

    custom_number_1
    int64

    custom_number_1

    custom_number_2
    int64

    custom_number_2

    custom_number_3
    int64

    custom_number_3

    custom_number_4
    int64

    custom_number_4

    description
    string

    Description of the product item. Max size: 5000

    Supports Emoji
    expiration_date
    string

    Item's expiration date (YYYY-MM-DD)

    fb_product_category
    string

    The facebook product category specified by the seller.

    gender
    enum{female, male, unisex}

    Gender the product item is targeted towards

    gtin
    string

    Global trade ID of the product item

    image_url
    URI

    URL of the product image

    Required
    inventory
    int64

    Inventory count for the product item

    ios_app_name
    string

    The name of the app (suitable for display)

    ios_app_store_id
    int64

    The app ID for the App Store

    ios_url
    string

    A custom scheme for the iOS app

    ipad_app_name
    string

    The name of the app (suitable for display)

    ipad_app_store_id
    int64

    The app ID for the App Store

    ipad_url
    string

    A custom scheme for the iPhone app

    iphone_app_name
    string

    The name of the app (suitable for display)

    iphone_app_store_id
    int64

    The app ID for the App Store

    iphone_url
    string

    A custom scheme for the iPhone app

    launch_date
    string

    launch_date

    manufacturer_part_number
    string

    Manufacturer's ID for the product item

    marked_for_product_launch
    enum{default, marked, not_marked}

    marked_for_product_launch

    material
    string

    Material of the product item
    Max size: 200

    mobile_link
    URI

    Link to a mobile-optimized external product page

    name
    string

    Name/title of the product item

    RequiredSupports Emoji
    ordering_index
    int64

    Index used for ordering items within a group

    pattern
    string

    Pattern of the product item

    price
    int64

    Price of the item with 2 digits added for cents (ex: use "100" for 1 or "599" for 5.99)

    Required
    product_type
    string

    Retailer defined category of the product item. Max size: 750

    quantity_to_sell_on_facebook
    int64

    quantity_to_sell_on_facebook

    retailer_id
    string

    A unique identifier for this item (which can be a variant for a product)

    Required
    return_policy_days
    int64

    Return Policy Days

    sale_price
    int64

    Sale price of the item with 2 digits added for cents (ex: use "100" for 1 or "599" for 5.99)

    sale_price_end_date
    datetime

    Date when the sale price ends

    sale_price_start_date
    datetime

    Date when the sale price starts

    short_description
    string

    A brief description of the product

    size
    string

    Size of the product item

    start_date
    string

    Date when the product started to exist

    url
    URI

    URL of the product item

    visibility
    enum{staging, published}
    Default value: published

    Visibility of the product item

    windows_phone_app_id
    string

    The app ID (a GUID) for app store

    windows_phone_app_name
    string

    The name of the app (suitable for display)

    windows_phone_url
    string

    A custom scheme for the Windows Phone app

    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
    368The action attempted has been deemed abusive or is otherwise disallowed
    10800Duplicate retailer_id when attempting to create a store collection

    Updating

    You can't perform this operation on this endpoint.

    Deleting

    You can't perform this operation on this endpoint.