管理api
构建应用程序
快速启动
指南
教程
建立渠道
快速启动
指南
教程
建筑店面
管理货币
指南
合作伙伴信息
成为合作伙伴
开始
POS解决方案
ERP解决方案
PIM解决方案
OMS的解决方案
营销解决方案
运输解决方案
支付解决方案

过滤

要将集合过滤为特定的一组项,可以将过滤器添加到请求中作为URL查询参数。

退货最多为250件。查看更多产品需要创建一个脚本,该脚本可以遍历后续的每个页面。

下面是V3 API中最常见的过滤器选项:

操作符 表达式 例子
= /相等 属性=值 / v3 /目录/产品?价格= 10/ v3 /目录/产品?name =我的产品
大于或等于(对于数字或日期) 属性:min =价值 / v3 /目录/产品?价格:min = 10
小于或等于(对于数字或日期) 属性:max =价值 / v3 /目录/产品?价格:max = 10
大于(对于数字或日期) 属性:大=价值 / v3 /目录/产品?价格:大= 10
少于(数字或日期) 属性:少=价值 / v3 /目录/产品?价格:少= 10
类似SQL的操作符(用于字符串) 属性:像=模式 / v3 /目录/类别?名字:喜欢=衬衫
操作符中的SQL(用于数组) 属性:= csv,值的列表 / v3 /目录/产品?类别:= 123456
SQL NOT IN operator (for array) 属性:not_in = csv、值列表 / v3 /目录/产品?类别:not_in = 123456

可用的过滤器因端点而异。有关支持的筛选器的最新信息,请参阅得到每个端点的方法文档。

包括

某些端点支持包括用于在主资源中包含子资源和特定属性的查询参数伟德棋牌大全得到父对象的响应。例如,您可以在产品响应中包含产品的变体和图像:

/ v3 /目录/产品?包括=variants,images

可获得包括查询参数因端点而异。有关最新的过滤器信息,请参阅得到每个端点的方法文档。

端点支持包括下面列出。(最后更新于2020年9月28日)

API 端点 端点URL
店面车 得到一个购物车 /车
店面签出 得到一个付款 /次/ {checkoutId}
服务器到服务器上 得到一个购物车 /车/ {cartId}
客户V3 得到所有客户 /客户
获取所有客户地址 /客户/地址
价格列表 获取所有的价格表记录 /价格表/ {price_list_id} /记录
通过货币代码获得价格记录 /价格表/ {price_list_id} /记录/ {variant_id} / {currency_code}
产品 把所有的产品 /目录/产品
得到一个产品 /目录/产品/ {product_id}
店面 被重定向 /店面/重定向

包含和排除字段

许多BigCommerce的REST API端点都支持这两种功能include_fieldsexclude_fields查询参数。

  • include_fields查询参数将在响应中只返回指定的字段。
  • exclude_fields查询参数将从响应中省略指定的字段。

您可以请求对象上可用的任何字段。从请求中排除不必要的字段(特别是像description这样的大字段)可以加快API请求的响应时间。

以下示例显示了单个请求中包含的产品名称和价格:

https://api.bigcommerce.com/stores/ {{store_hash}} / v3 /目录/产品? include_fields =名称、价格

回应:

{“数据”:({“id”:77,“名称”:“红印花围巾”,“价格”:12}]}

可获得include_fieldsexclude_fields查询参数因端点而异。有关最新的过滤器信息,请参阅得到每个端点的方法文档。

端点支持include_fieldsexclude_fields下面列出。(最后更新于2020年9月28日)

API 端点 端点URL
品牌 得到所有品牌 /目录/品牌
得到一个品牌 /目录/品牌/ {brand_id}
获得所有品牌Metafields /目录/品牌/ {brand_id} / metafields
获得一个品牌元域 /目录/品牌/ {brand_id} / metafields / {metafield_id}
类别 得到所有类别 /目录/类别
得到一个类别 /目录/类别/ {category_id添加}
获取所有类别元字段 /目录/类别/ {category_id添加}/ metafields
获得一个类别元场 /目录/类别/ {category_id添加}/ metafields / {metafield_id}
产品 把所有的产品 /目录/产品
得到一个产品 /目录/产品/ {product_id}
获取所有批量定价规则 / / {product_id} / bulk-pricing-rules /产品目录
制定批量定价规则 /目录/产品/ {product_id} / bulk-pricing-rules / {bulk_pricing_rule_id}
获得复杂的规则 /目录/产品/ {product_id} /复杂的规则
得到一个复杂的规则 /目录/产品/ {product_id} /复杂的规则/ {complex_rule_id}
得到自定义字段 /目录/产品/ {product_id} /定制字段
获取自定义字段 /目录/产品/ {product_id} /定制字段/ {custom_field_id}
获取所有产品图像 / / {product_id} /图片/产品目录
获得产品形象 /目录/产品/ {product_id} /图片/ {image_id}
获取所有产品元字段 / / {product_id} / metafields /产品目录
得到一个乘积元场 /目录/产品/ {product_id} / metafields / {metafield_id}
获取所有产品修改器 /目录/产品/ {product_id} /修饰符
得到一个修饰符 /目录/产品/ {product_id} /修饰符/ {modifier_id}
获取所有修改器值 /目录/产品/ {product_id} /修饰符/ {modifier_id} /值
获取一个修改器值 /目录/产品/ {product_id} /修饰符/ {modifier_id} /价值/ {value_id}
获取所有产品选项 /目录/产品/ {product_id} /选项
获得产品选择 /目录/产品/ {product_id} /选项/ {option_id}
获取所有产品选项值 /目录/产品/ {product_id} /选项/ {option_id} /值
获取产品选项值 /目录/产品/ {product_id} /选项/ {option_id} /价值/ {value_id}
得到产品评论 /目录/产品/ {product_id} /评论
获得产品评论 /目录/产品/ {product_id} /评论/ {review_id}
获取所有产品变体 /目录/产品/ {product_id} /变体
买一个产品变体 /目录/产品/ {product_id} /变量/ {variant_id}
获取所有产品变体元字段 /目录/产品/ {product_id} / / {variant_id} / metafields变体
获取一个产品变体元场 /目录/产品/ / {variant_id} / {product_id} /变异metafields / {metafield_id}
获取所有产品视频 /目录/产品/ {product_id} /视频
获取产品视频 /目录/产品/ {product_id} /视频/ {id}
变体 得到所有变体 /目录/变异

分页和限制

页面是通过api返回的页面数。

限制是每个页面返回的结果数。

页面= 2限制= 10将返回结果的第2页,每页有10个项目。