查询销售渠道的商品
GET https://{handle}.myshopline.com/admin/openapi/v20260301/product_listings.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。根据条件返回销售渠道中的商品
查询参数
- page_info string分页查询的唯一标识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/product_listings.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。例子:eyJzaW5jZUlkIjoiMTYwNTc0NzY4NjQyMTI3MzUxNTQxNjAyODIiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjV9 - product_ids string根据传入的商品ID列表筛选,最多1000个,多个用逗号分隔例子:
16057039432335097907370282 - updated_at_min string按在特定日期和时间之后最后更新的产品列表进行筛选例子:
2022-12-06T15:13:50+08:00 - collection_id string使用分类ID筛选例子:
12250433045062532239420282 - handle string全局唯一的商品handle例子:
product-handle - limit string查询数量限制,默认50,不能超过1000例子:
50
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
link
提供分页数据的 URL 链接。你可以获取该字段值中的page_info信息用于下一次分页请求中。当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制。traceId
请求的全 局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
product_listingsobject[]
商品列表body_html string商品描述例子:This is a descriptioncreated_at string商品创建时间例子:2022-12-06T15:13:50+08:00handle string全局唯一的商品handle例子:product-handleimagesobject[]
商品主图列表alt string图片ALT例子:This is a image altsrc string图片地址例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngoptionsobject[]
选项列表,最多5个id string选项ID例子:16157850264851626133440282name string选项名称例子:Colorproduct_id string商品ID例子:16057039432335097907370282values array选项值列表例子:["[\"Red\", \"Green\", \"White”]"]values_images map选项值图例子:{"Red":"https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"}product_id string商品ID例子:16057039432335097907370282published_at string发布到在线商店的时间例子:2022-12-06T15:13:50+08:00published_scope string设置发布范围,值为「web」时表示在线商店例子:webspu stringSPU码例子:S00000001status string商品状态:active - 上架,draft - 下架,archived - 归档例子:activesubtitle string商品摘要例子:This is a subtitletags string商品标签例子:tag1,tag2template_path string模板路径例子:templates/products/detail.jsontitle string商品标题例子:This is a titleupdated_at string商品更新时间例子:2022-12-06T15:13:50+08:00variantsobject[]
规格列表,最多500个barcode string条形码例子:B00000001compare_at_price string原价例子:100id string款式ID例子:18057039432358082693350282imageobject
款式图alt string图片alt例子:This is a image altsrc string图片地址例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pnginventory_item_id string库存对象ID例子:5703943240925324252inventory_policy string是否允许超卖,continue:允许,deny:不允许例子:denyinventory_quantity integer所有地点的库存汇总值例子:100inventory_tracker boolean是否追踪库存,true:追踪,false:不追踪例子:trueoption1 string该款式对应的第一个选项的值例子:Redoption2 string该款式对应的第二个选项的值例子:Loption3 string该款式对应的第三个选项的值option4 string该款式对应的第四个选项的值option5 string该款式对应的第五个选项的值price string售价例子:90product_id string商品ID例子:16057039432335097907370282required_shipping boolean是否需要发货例子:truesku stringSKU码例子:T00000001taxable boolean是否需要收税例子:truetitle string款式标题例子:Red/Lweight string重量例子:0.5weight_unit string重量单位, g:克,kg:千克,lb:磅,oz:盎司例子:gvendor string商品厂商例子:Shopline
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?