履约单列表查询
GET https://{handle}.myshopline.com/admin/openapi/v20261201/fulfillment_orders/fulfillment_orders_search.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。搜索履约单列表
查询参数
- assignment_status string请求状态例子:
"unsubmitted" - limit integer查询的数据数量,默认20,最大100条例子:
10 - location_ids string地点id列表例子:
"24826418,24826411" - page_info string分页查询的唯一标识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/fulfillment_orders/fulfillment_orders_search.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。例子:"7AFD7393C6E7CF18672C038477E2EF6A463464BDBAF766DD8F8CB8E0085F82419A94B80084BCDA0B838B3F13C302A2C9044E" - since_id string要查询的数据的订单号id的起始位置例子:
"21056199447626881527947685"
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
link
提供分页数据的 URL 链接。你可以获取该字段值中的page_info信息用于下一次分页请求中。当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制。traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
fulfillment_ordersobject[]
数据列表merchant_requestsobject[]
请求发货时的具体信息列表notify_customer boolean发货时是否通知客户例子:truecreated_at string发生时间,(格式见IOS8601)例子:2023-04-12T22:59:52+08:00kind string第三方请求状态,包括: submit:fulfillment_request,cancellation_requested,cancellation_reques例子:submitmessage string备注例子:noneassigned_location_id string被分配的地点id例子:5668167071852661850shop_id string店铺id例子:541380002fulfill_at string可发货时间(格式 见IOS8601)例子:2023-04-12T22:59:52+08:00line_itemsobject[]
履约商品列表fulfillable_quantity long可履约商品数量例子:1harmonized_system_code string海关编码例子:121country_code_of_origin string原产地/发货地的国家代码例子:USline_item_id string商品行id例子:40057889id string履约单商品表id例子:400574123quantity long商品行对应商品数量例子:1variant_id string商品sku序列号例子:156223761fulfillment_order_id string履约单id例子:4005740193290131085320shop_id string店铺id例子:541380002request_status string请求状态,包括:unsubmitted,submitted,rejected,closed,cancellation_requested,cancellation_rejected,cancellation_accepted,accepted例子:unsubmittedorder_id string订单id例子:21057116277667827637773776supported_actions array履约单支 持的操作例子:["\"create_fulfillment\""]destinationobject
收货人地址delivery_store_name string本地配送门店名称,仅本地配送时提供例子:Napo Shopprovince_code string州或是省编码,IOS 3166-2编码例子:KYcompany string公司例子:LLLaddress1 string地址1例子:Chestnut Street 12phone string电话号码例子:18883290137last_name stringlastNamecity string城市例子:Louisvilleaddress2 string地址2例子:Chestnut Street 13country_code string国家或地区编码例子:CAprovince string州省名称例子:Kentuckyemail string邮箱例子:sswe.t@mail.example.comfirst_name stringfirstName例子:Jackcountry string国家或地区名称例子:Canadaname string顾客姓名例子:Jack Wangdelivery_store_code string本地配送门店id,仅本地配送时提供例子:A121id string唯一编码例子:1046000771display_status string到店取货场景下才赋值。 如果不是到店取货,或者是到店取货-未取货状态都返回null例子:Picked upid string履约单id例子:4005740193290131085320status string履约单状态,包括:open,in_progress,closed,cancelled,incomplete,on_hold,scheduled例子:openassigned_locationobject
被分配到的地点详情name string地点名称例子:Ottawa Storeaddress2 string地址2例子:Unit 42location_id string地点id例子:5668167071852661850province string省份例子:Ontariocity string城市例子:Ottawacountry_code string国家或是地区编码例子:CAcountry string国家或是地区名称例子:Canadaphone string电话号码例子:18883290139zip string邮编例子:A1B 2C3address1 string地址1例子:126 York Streetdelivery_method string物流方式,包括:shipping、pickup、local_delivery、none例子:nonefulfillment_holdsobject[]
暂停信息reason_note string暂停备注例子:something wrongreason string暂停原因例子:something wrongfulfill_by string最晚发货时间(格式见IOS8601)例子:2023-04-12T22:59:52+08:00
API Explorer
调试台
这篇文章对你有帮助吗?