Marketplace 合作伙伴商品 API

成为 Marketplace 合作伙伴后,您的交易帖可在特定国家/地区的 Facebook Marketplace 上展示。

要在 Facebook Marketplace 上传、更新或删除商品,您需要使用图谱 API 接口。

HTTP

POST /v20.0/{product-catalog-id}/items_batch HTTP/1.1

如果您希望了解如何使用图谱 API,请阅读我们的图谱 API 使用指南

对此连线发起 POST 请求时,系统会创建一个商品

参数

参数说明

item_type

设置为 PRODUCT_ITEM

requests

一个商品数组中每个商品的方法和字段。

request 参数用于定义请求的方法和数据。

字段说明

method

您希望对指定商品执行的操作。选项包括:
CREATE
UPDATE
DELETE

data

要创建、更新或删除的商品的信息。

requests 参数示例

[
    {
        "method": "CREATE",
        "data": {
            "id": "UniqueProductID",
            "title": "Title",
            "description": "This is the description",
            "price": "100 USD",
            "image_link": "https:\/\/www.facebook.com",
            "brand": "Monster",
            "availability": "in stock",
            "condition": "new",
            "link": "https:\/\/www.facebook.com",
            "return_details": {"return_days": "30", "return_type": "SELLER_PAID_RETURN"},
            "partner_product_checkout_uri": "https:\/\/www.facebook.com",
            "partner_product_location": "San Fransisco, CA",
            "partner_product_expiration_time": "1923181264",
            "partner_delivery_method": ["shipping"],
            "partner_shipping_type": "fixed",
            "partner_shipping_cost": "14.95",
            "partner_shipping_speed": "3:5",
            "partner_attribute_data": {"color": "blue"},
            "partner_seller_id": "MySellerId1",
            "partner_item_country": "US"
        }
    },
    .... {next product}
]
   

API 流量限制

为防止节流,请遵循以下建议:

  • 每分钟不超过 30 次调用。任何超出此上限的情况都会引起节流。
  • 在一次 API 调用中批量处理商品,最多可包含 300 件商品。

商品字段

参数类型必要/非必要说明

id

字符串(字符数上限:100)

必要

商品的唯一内容编号。使用商品的 SKU(如果可能)。每个内容编号只能在目录中出现一次。如果同一个编号对应多个实例,则系统将忽略所有实例。

如果商品在多个国家/地区有售,则必须在所有目录中重复使用相同的编号。务必要将价格更新为相应国家/地区的货币(参见价格字段)。

title

字符串(字符数上限:200)

必要

显示在 Marketplace 交易帖中的商品的标题。

此文本会显示在 Marketplace 上。不要在其中包含 HTML 标签。

description

字符串(字符数上限:9999)

必要

商品描述。虽然此字段的字符数上限为 9999,但在 Facebook Marketplace 交易帖将仅显示前 256 个字符。

此文本会显示在 Marketplace 上。不要在其中包含 HTML 标签。

示例:舒适的宝蓝色有机棉质女士 T 恤。盖袖和宽松版型,绝对是炎炎夏日的不二之选。

condition

枚举 {new, refurbished, used, used_like_new, used_good, used_fair, cpo, open_box_new}

必要

商品状况。

partner_listing_type

枚举 {fixed_price, auction, vehicle, rental, real_estate}

非必要

这一参数决定了交易帖类型。若未选择,则默认为“fixed_price”。

如果设为“auction”、“vehicle”、“rental”或“real_estate”,将在 Marketplace 上为买家提供指定的合作伙伴交易贴类型体验。

partner_product_condition

枚举 {acceptable, brand_new, certified_pre_owned, certified_refurbished, damaged, digital_good, excellent_refurbished, for_parts_or_not_working, good, good_refurbished, graded, like_new, new, new_other, new_other_see_details, new_with_box, new_with_defects, new_with_tags, open_box, others, pre_owned, remanufactured, retread, seller_refurbished, ungraded, used, very_good, very_good_refurbished, new_open_box, open_box_used, new_factory_sealed, unknown}

非必要

商品状况。此字段是非必要字段,会覆盖 condition 字段的值。如果需要更具体的商品状况,请使用此字段。

brand

字符串

必要

商品品牌。如果不存在品牌,设置为“N/A”。

price

字符串(字符数上限:9999)

必要

价格的格式为数字,然后紧跟着一个空格,随后是 3 个字母组成的 ISO 4217 货币代码。例如 10.99 EUR

如果交易帖类型为“auction”,这便是商品的竞价。价格的格式为数字,然后紧跟着一个空格,随后是 3 个字母组成的 ISO 4217 货币代码。

availability

枚举 {in stock, out of stock}

必要

商品库存状态。

link

字符串

必要

商品详情页面的移动网址网页链接。

partner_product_checkout_uri

字符串

非必要

当用户轻触交易帖上的“购买”时将跳转到的结账网址链接。
我们会将 click_id 附加到此参数中。如果未提供该字段,则默认使用“link”字段中的网址。

partner_product_html_desc_uri

字符串

非必要

指向包含商品完整描述的网站的网址链接。如果商品描述超出了“description”文本字段的容量限制,则使用此链接。Marketplace 将选择性地提供指向完整描述的链接。

image_link

字符串

必要

商品主图的网址。图片必须采用 JPEG 或 PNG 的格式,且像素至少为 500 x 500,最大不得超过 8 MB。请查看商品图片规范

partner_seller_id

字符串(字符数上限:100)

必要

卖家的唯一标识符,需要与卖家信息中的 partner_seller_id 匹配。

示例:“partner_seller_id”: “great_seller_inc”

partner_item_country

枚举 {AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GR, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK}

必要

这是商品在售国家/地区(如适用,还包括可配送国家/地区)。目录国家/地区需与 partner_item_country 保持一致。

对于支持跨境配送的商品,需在每个支持配送且合作伙伴有配送计划的国家/地区目录中创建一个商品。

fb_product_category

字符串

非必要

商品的 Facebook 商品类别。此清单中最具体的 Facebook 商品类别:电子表格 (.csv)纯文本 (.txt)

status

枚举 {active, archived}

非必要

商品的当前状态。

sale_price

字符串

非必要

价格的格式为数字,然后紧跟着一个空格,随后是 3 个字母组成的 ISO 4217 货币代码。例如 10.99 EUR。此字段的格式与 price 字段相同。与 price 字段一起使用可显示折扣。

sale_price_effective_date

字符串

非必要

促销开始和结束的日期和时间,用斜线分隔。以 YYYY-MM-DD 的格式输入开始和结束日期。在每个日期后面添加“T”,然后注明时间。以 24 小时制的格式(0:00 到 23:59)提供时间。

示例:2014-11-01T12:00-0300/2014-12-01T00:00-0300。

additional_image_link

字符串(字符数上限:2000)

非必要

商品额外图片(最多 20 个)的网址,网址间以逗号 (,)、分号 (;)、空格 ( ) 或竖线 (|) 分隔。请遵守与 image_link 相同的图片规范。

return_details

可为空的 JSON 对象(即 map){ “return_days”: 30, “return_type”: enum }

枚举:FINAL_SALE NO_RETURNS_WITH_EXCEPTION NO_RETURNS SELLER_PAID_RETURN BUYER_PAID_RETURN

如果不支持退货,
则“return_details”应设置为 null

非必要

return_days 表示买家需要在多少天内发起商品退货。
对于 NO_RETURNS 和 FINAL_SALE 类型,return_days 应设置为 -1

return_type 表示商品支持的退货类型。可用选项包括:FINAL_SALE、NO_RETURNS_WITH_EXCEPTION、NO_RETURNS、SELLER_PAID_RETURN 和 BUYER_PAID_RETURN

如果该字段留空,则不会显示退货详情。

partner_attribute_data

可为空的 JSON 对象 { “color”: “blue” }

可用键:aspect_ratio、band_material、bike_type、brand、break_type、cable_length、capacity、case_size、certification、character、circulated_uncirculated、closure、color、compatible_bike_type、compatible_brand、compatible_model、compatible_operating_system、compatible_product、connectivity、credit_included、denomination、department、display_technology、dress_length、exterior_color、exterior_material、fabric_type、features、film_format、fit、focal_length、focus_type、form_factor、format、frame_color、game_name、game、gauge、golf_club_type、handedness、inseam、internet_connectivity、item_height、item_length、item_weight、item_width、items_included、main_stone、manufacturer_part_number、manufacturer、material、maximum_aperture、maximum_magnification、maximum_resolution、memory_cards_supported、metal_purity、metal、model、mount、mpn、network、number_of_items、occasion、outer_shell_material、package_quantity、part_type、pattern、performance_activity、platform、processor、publication_name、quantity、rack_type、rim_diameter、rim_width、ring_size、screen_size、section_width、series、set_includes、set、size_type、size、skirt_length、sleeve_length、sport_activity、sport、storage_capacity、style、type、unit_quantity、unit_type、upper_material、us_shoe_size、vintage、voltage、volume、waist_size、wheel_diameter、year

非必要

将显示在商品详细信息部分的属性键值列表,其中值的格式为字符串。

适用于房屋租赁/房地产的键:property_types(必要)、sale_type、bed_bath、area_size、pet_friendly、ac_type、heating_type、laundry_type、parking_type、parkingSpace、furnishing_type、garden_type、tenure_type、listed_by、property_tax_and_condo_fee、construction_status、lease_duration、energy_rating_eu、co2_emission_rating

适用于汽车的键:vehicle_type、year、make、model、number_of_owners、trim、body_style、exterior_color、interior_color、transmission、fuel_type、mileage、money_still_owed、motorcycle_type、engine_size

partner_product_creation_time

UTC 时间的 UNIX 时间戳(以秒为单位,number 类型)

非必要

商品创建或更新时的 UNIX 时间戳。

示例:“partner_product_creation_time”: 1713917255

partner_product_location

字符串

非必要

以字符串形式显示的商品位置。示例:“Paris, France”。对具体或宽泛的范围没有限制。

partner_product_expiration_time

UTC 时间的 UNIX 时间戳,以秒为单位(数字)

非必要

交易帖将从 Marketplace 移除的时间,必须是未来的时间。

partner_delivery_method

字符串枚举数组 {shipping, in_person}

非必要

此字段表示商品如何配送给买家。如果商品既可以邮寄,也可以由买家自提,则应同时包括这两种方式。
示例:[“shipping”,”in_person”]

默认:[“shipping”]

partner_item_latitude

浮点数

非必要

商品的纬度。如果配送方式包括“in_person”,则为必要。

partner_item_longitude

浮点数

非必要

商品的经度。如果配送方式包括“in_person”,则为必要。

partner_shipping_type

枚举 {free, fixed, dynamic}

非必要

商品的运费策略。如果商品包邮,则使用“free”。如果运费不因地区而异(即固定价格),则使用“fixed”,并在 partner_shipping_cost 中设置费用。如果运费根据买家位置、款式选择等因素而变化,请选择“dynamic”。如果选择“dynamic”,我们将不会显示运费,而是提示买家在结账时查看具体运费。

默认:“dynamic”

partner_shipping_cost

浮点数

非必要

如果 partner_shipping_type 的值为“fixed”,则为必要。
示例:“14.95”

partner_shipping_speed

字符串
“MIN_DELIVERY_SPEED_IN_DAYS:MAX_DELIVERY_SPEED_IN_DAYS”

非必要

邮寄商品的最短和最长预计工作日。
示例:“3:5”

partner_auction_bid_close_time

UTC 时间的 UNIX 时间戳,以秒为单位(数字)

非必要

如果 partner_listing_type 设为“auction”,则为必要。这是商品竞价结束的时间。示例:“partner_auction_bid_close_time”: 1713917255

partner_auction_bid_count

数字

非必要

仅当 partner_listing_type 设为“auction”时适用。此为商品当前的竞价数量。

additional_fields

可为空的 JSON 对象

自由格式(无固定枚举/键)

{ “revised_title”: “Premium Blue T-Shirt” }

非必要

自由格式的 Json 字段,供合作伙伴发送任何其他字段。

检查上传状态

在提交创建、更新或删除请求后,系统将返回一个句柄。然后,您可以通过另一个请求检查提交的结果。

完成后,data 下的 status 将设置为“finished”,并显示错误和警告。

HTTP

GET /v20.0/{product-catalog-id}/check_batch_request_status?handle={your handle}

示例返回

{
  "data": [
    {
      "handle": "Acy3FUJwzE10XnWrYr4ttrjOAfs-h6BUg-Wtg6sWGeV7qZZaErX15XPfqT_KWeyC6T4-nTbng9r1BJuScb6hgO1B",
      "status": "finished",
      "errors_total_count": 0,
      "errors": [
      ],
      "warnings": [
        {
          "line": 1,
          "id": "YourItemID",
          "message": "These attributes are invalid and need to be updated in the feed file: The product_tags information under  is invalid. Review for more details"
        }
      ],
      "ids_of_invalid_requests": [
      ]
    }
  ],
  "__www_request_id__": "Az3ghYsDh-101IH2t6DXKuP"
}
    

查看和管理商品

电商管理工具中查看或管理已上传的商品。商品出现的任何问题都会显示在电商管理工具中,并可通过该工具进行解决。