主导航

产品

检索并更新 Feed 中的产品。

概述

使用这些端点检索 Feed 的当前产品,或根据 id 匹配更新部分产品更改。

REST 接口

  • GET /product_feeds/{id}/products 返回指定 Feed 的产品。
  • PATCH /product_feeds/{id}/products 将产品更新至指定的 Feed。产品根据 id 进行匹配,未包含在请求中的产品保持不变。

GET /product_feeds/{id}/products

返回指定 Feed 的产品。

路径参数

字段类型必需描述
idstringFeed 的标识符。

请求

此端点不定义请求体。

响应

200 OK

字段类型必需描述
target_countrystring符合 ISO 3166 的两位国家/地区代码。
productsProduct[]指定 Feed 的产品数组。

404 Not Found

当找不到 Feed 时返回。

PATCH /product_feeds/{id}/products

将产品更新至指定的 Feed。产品根据 id 进行匹配。未包含在请求中的产品保持不变。

路径参数

字段类型必需描述
idstringFeed 的标识符。

请求

字段类型必需描述
target_countrystring符合 ISO 3166 的两位国家/地区代码。
productsProduct[]产品 Feed 的产品数组。

响应

200 OK

返回以下接受对象

字段类型必需描述
idstringFeed 的标识符。
acceptedboolean产品有效负载是否被接受。

400 Bad Request

当产品有效负载无效时返回。

404 Not Found

当找不到 Feed 时返回。

架构参考

Product

字段类型必需描述
idstring此产品的稳定全局标识符。
标题string产品标题。
description描述产品描述内容。
urlstring (uri)规范产品 URL。
mediaMedia[]产品级媒体资产。
variantsVariant[]与产品关联的变体。

Variant

字段类型必需描述
idstring此变体的稳定全局标识符。
标题string变体标题。
description描述变体描述内容。
urlstring (uri)变体 URL。
barcodesBarcode[]变体条形码值。
价格Price此变体的当前销售价格。
list_pricePrice应用折扣前的参考价格。
unit_priceUnitPrice单价元数据。
库存状况Availability变体的可用性状态。
分类Category[]与变体关联的类别。
conditionCondition适用的商品状况。
variant_optionsVariantOption[]变体的选项选择集,例如颜色或尺寸。
mediaMedia[]变体媒体资产。第一个条目被视为主要条目。
sellerSeller变体的卖家元数据。

描述

必须至少存在以下字段之一。

字段类型必需描述
plainstring纯文本描述。
htmlstringHTML 描述。
markdownstringMarkdown 描述。

Availability

字段类型必需描述
availableboolean指示变体当前是否可购买。
statusstring报告可用性时的履约状态,例如 in_stock(有货)、backorder(缺货待补)、preorder(预购)、out_of_stock(无货)或 discontinued(已停产)。

Price

字段类型必需描述
amount整数以 ISO 4217 小数单位表示的金额。
currencystring三字母 ISO 4217 货币标识符。

UnitPrice

字段类型必需描述
amount整数单价金额。
currencystring货币代码。
measureMeasure测量的数量。
referenceReferenceMeasure参考数量。

Measure

字段类型必需描述
valuenumber测量值。
unitstring测量单位。

ReferenceMeasure

字段类型必需描述
value整数参考值。
unitstring参考单位。

Barcode

字段类型必需描述
typestring条形码类型。
valuestring条形码值。

Media

字段类型必需描述
typestring媒体类型。
urlstring (uri)媒体 URL。
alt_textstring替代文本。
width整数媒体宽度。
height整数媒体高度。

VariantOption

字段类型必需描述
namestring选项名称,例如颜色或尺寸。
valuestring选定的选项值。

类别

字段类型必需描述
valuestring类别标签或层级路径。
taxonomystring用于类别值的分类系统,例如 google_product_categoryshopifymerchant

Seller

字段类型必需描述
namestring卖家名称。
linksLink[]卖家相关链接。
字段类型必需描述
typestring目标类型,例如 privacy_policy(隐私政策)、terms_of_service(服务条款)、refund_policy(退款政策)、shipping_policy(配送政策)或 faq(常见问题)。
标题string链接标题。
urlstring链接目标 URL。

Condition

Condition 是一个字符串数组,描述适用的商品状况,例如 new(全新)或 secondhand(二手)。可以适用多个值。

© . This website operates independently and is not affiliated with or endorsed by OpenAI, Inc. All brand names, logos, and trademarks are the property of their respective owners.