履约单列表查询

需要 read_assigned_fulfillment_orders 权限点。

更多权限点使用信息,请参考:

[]

访问权限

GET https://{handle}.myshopline.com/admin/openapi/v20250601/fulfillment_orders/fulfillment_orders_search.json

[]

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

[]

搜索履约单列表

查询参数

assignment_status string
[]
请求状态
[]
Example: "unsubmitted"
limit integer
[]
查询的数据数量，默认20，最大100条
[]
Example: 10
location_ids string
[]
地点id列表
[]
Example: "24826418,24826411"
page_info string
[]
加密后的请求参数，包括所有的查询条件参数(除去queryParamData),用于上一页、下一页，直接取该字段解析访问
[]
Example: "7AFD7393C6E7CF18672C038477E2EF6A463464BDBAF766DD8F8CB8E0085F82419A94B80084BCDA0B838B3F13C302A2C9044E"
since_id string
[]
要查询的数据的订单号id的起始位置
[]
Example: "21056199447626881527947685"

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

link
[]
包含上一页、下一页的请求参数
traceId
[]
traceId

响应体

fulfillment_ordersobject[]
[]
数据列表
assigned_locationobject
[]
被分配到的地点详情
address1 string
[]
地址1
[]
Example: 126 York Street
address2 string
[]
地址2
[]
Example: Unit 42
city string
[]
城市
[]
Example: Ottawa
country string
[]
国家或是地区名称
[]
Example: Canada
country_code string
[]
国家或是地区编码
[]
Example: CA
location_id string
[]
地点id
[]
Example: 5668167071852661850
name string
[]
地点名称
[]
Example: Ottawa Store
phone string
[]
电话号码
[]
Example: 18883290139
province string
[]
省份
[]
Example: Ontario
zip string
[]
邮编
[]
Example: A1B 2C3
assigned_location_id string
[]
被分配的地点id
[]
Example: 5668167071852661850
delivery_method string
[]
物流方式，包括：shipping、pickup、local_delivery、none
[]
Example: none
destinationobject
[]
收货人地址
address1 string
[]
地址1
[]
Example: Chestnut Street 12
address2 string
[]
地址2
[]
Example: Chestnut Street 13
city string
[]
城市
[]
Example: Louisville
company string
[]
公司
[]
Example: LLL
country string
[]
国家或地区名称
[]
Example: Canada
country_code string
[]
国家或地区编码
[]
Example: CA
delivery_store_code string
[]
本地配送门店id，仅本地配送时提供
[]
Example: A121
delivery_store_name string
[]
本地配送门店名称，仅本地配送时提供
[]
Example: Napo Shop
email string
[]
邮箱
[]
Example: sswe.t@mail.example.com
first_name string
[]
firstName
[]
Example: Jack
id string
[]
唯一编码
[]
Example: 1046000771
last_name string
[]
lastName
name string
[]
顾客姓名
[]
Example: Jack Wang
phone string
[]
电话号码
[]
Example: 18883290137
province string
[]
州省名称
[]
Example: Kentucky
province_code string
[]
州或是省编码，IOS 3166-2编码
[]
Example: KY
display_status string
[]
到店取货场景下才赋值。如果不是到店取货，或者是到店取货-未取货状态都返回null
[]
Example: Picked up
fulfill_at string
[]
可发货时间（格式见IOS8601）
[]
Example: 2023-04-12T22:59:52+08:00
fulfill_by string
[]
最晚发货时间（格式见IOS8601）
[]
Example: 2023-04-12T22:59:52+08:00
fulfillment_holdsobject[]
[]
暂停信息
reason string
[]
暂停原因
[]
Example: something wrong
reason_note string
[]
暂停备注
[]
Example: something wrong
id string
[]
履约单id
[]
Example: 4005740193290131085320
line_itemsobject[]
[]
履约商品列表
country_code_of_origin string
[]
原产地/发货地的国家代码
[]
Example: US
fulfillable_quantity long
[]
可履约商品数量
[]
Example: 1
fulfillment_order_id string
[]
履约单id
[]
Example: 4005740193290131085320
harmonized_system_code string
[]
海关编码
[]
Example: 121
id string
[]
履约单商品表id
[]
Example: 400574123
line_item_id string
[]
商品行id
[]
Example: 40057889
quantity long
[]
商品行对应商品数量
[]
Example: 1
shop_id string
[]
店铺id
[]
Example: 541380002
variant_id string
[]
商品sku序列号
[]
Example: 156223761
merchant_requestsobject[]
[]
请求发货时的具体信息列表
created_at string
[]
发生时间，（格式见IOS8601）
[]
Example: 2023-04-12T22:59:52+08:00
kind string
[]
第三方请求状态,包括： submit：fulfillment_request，cancellation_requested，cancellation_reques
[]
Example: submit
message string
[]
备注
[]
Example: none
notify_customer boolean
[]
发货时是否通知客户
[]
Example: true
order_id string
[]
订单id
[]
Example: 21057116277667827637773776
request_status string
[]
请求状态，包括：unsubmitted，submitted，rejected，closed，cancellation_requested，cancellation_rejected，cancellation_accepted，accepted
[]
Example: unsubmitted
shop_id string
[]
店铺id
[]
Example: 541380002
status string
[]
履约单状态，包括：open，in_progress，closed，cancelled，incomplete，on_hold，scheduled
[]
Example: open
supported_actions array
[]
履约单支持的操作
[]
Example: "create_fulfillment"

API Explorer

调试台

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

assignment_status — query

limit — query

location_ids — query

page_info — query

since_id — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/fulfillment_orders/fulfillment_orders_search.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议