需要 read_assigned_fulfillment_orders 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20260301/fulfillment_orders/:order_id/fulfillment_orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
指定订单 ID,获取该订单下的所有履约单。
路径参数
  • order_id string required
    订单号。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
更多状态码信息,参考 HTTP 状态码

响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
  • fulfillment_ordersobject[]
    履约单列表。
  • assigned_locationobject
    履约单发货地点信息。
  • address1 string
    地址的第一行。通常是街道地址或邮政信箱编号等信息。
  • address2 string
    地址的第二行。通常是公寓、套房或单元等信息。
  • city string
    地址中的城市。
  • country string
    地址中的国家或区域。
  • country_code string
    地址中国家或地区的二位国家码,遵循 ISO 3166-1 国际标准。
  • location_id string
    地点 ID。
  • name string
    地点名称。
  • phone string
    联系人手机号码。
  • province string
    地址中的省份。
  • zip string
    地址的邮编信息。
  • assigned_location_id string
    履约单发货地点 ID。
  • created_at string
    履约单创建时间。格式:ISO 8601
  • delivery_methodobject
    配送方式信息。
  • max_delivery_date_time string
    最晚发货时间,格式:ISO 8601
    例子: 2021-08-31T02:20:26+08:00
  • method_type string
    配送方式:
    • local:本地配送
    • pick_up:到店取货
    • shipping:物流运输
    • none:无配送方式
  • min_delivery_date_time string
    最早发货时间,格式:ISO 8601
    例子: 2021-08-31T02:20:26+08:00
  • service_code string
    承运商运费方案编号。
  • shipping_rate_name string
    运费方案名称,当method_typeshippinglocal,才有运费方案名称。
  • shipping_strategy_name string
    运输策略名称,当 method_typeshippinglocal,才有对应的值。
  • destinationobject
    收件人信息。
  • address1 string
    地址的第一行。通常是街道地址或邮政信箱编号等信息。
  • address2 string
    地址的第二行。通常是公寓、套房或单元等信息。
  • city string
    地址中的城市。
  • company string
    收件人所在的公司名称。
  • country string
    地址中的国家或区域。
  • country_code string
    地址中国家或地区的二位国家码,遵循 ISO 3166-1 国际标准。
  • delivery_store_code string
    便利店取货方式的门店编码。
  • delivery_store_name string
    便利店取货方式的门店名称。
  • email string
    收件人的邮箱。
  • first_name string
    收件人的名。
  • last_name string
    收件人的姓。
  • name string
    收件人的全名。
  • phone string
    收件人手机号码。
  • province string
    收件人省份。
  • province_code string
    地址中省份或区域的编码,该编码为系统自动生成。
  • zip string
    收件人的邮编。
  • fulfillment_holdsobject[]
    履约单暂停发货信息。
  • reason string
    暂停原因。
  • reason_note string
    备注。
  • id string
    履约单 ID。
  • line_itemsobject[]
    订单商品快照信息列表。
  • country_code_of_origin string
    原产地或发货地的国家或地区代码,用于识别市场所在的国家或地区。遵循 ISO 3166-1 国际标准。
  • fulfillable_quantity long
    履约单该商品可发货数量。
  • fulfillment_order_id string
    履约单 ID。
  • harmonized_system_code string
    海关编码,用于在国际贸易中对产品进行分类。
  • id string
    履约单商品行 ID。
  • line_item_id string
    商品行 ID。
  • quantity long
    履约单中该商品的数量。
  • shop_id string
    店铺 ID。
  • sku string
    商家为款式自定义的标识。
  • variant_id string
    商品款式的唯一标识 ID。
  • order_id string
    订单号。
  • request_status string
    履约请求状态。当履约发货地点为履约应用地点时,会存在该状态:
    • unsubmitted:未发起请求
    • submitted:已发起请求
    • accepted:接受请求
    • rejected:拒绝请求
    • cancellation_requested:请求取消发货
    • cancellation_accepted:接受请求取消发货
    • cancellation_rejected:拒绝请求取消发货
  • shop_id string
    店铺 ID。
  • status string
    履约单状态:
    • open:未发货
    • in_progress:发货中
    • closed:已完成发货
    • on_hold:暂停发货
  • supported_actions array
    履约单支持的操作:
    • create_fulfillment:创建发货
    • move:切换发货地点
    • hold:暂停发货
    • release_hold:取消暂停发货
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

path required
header required

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/fulfillment_orders/order_id/fulfillment_orders.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
获取订单下的所有履约单
Response
{
"fulfillment_orders": {
"assigned_location": {
"address1": "Address1",
"address2": "Address2",
"city": "NewYork",
"country": "USA",
"country_code": "US",
"location_id": "***********9467106",
"name": "TW",
"phone": "1391234",
"province": "California",
"zip": "***34"
},
"assigned_location_id": "***********9467106",
"created_at": "2022-11-04T10:18:46+00:00",
"delivery_method": {
"max_delivery_date_time": "2022-11-04T10:18:46+00:00",
"method_type": "local",
"min_delivery_date_time": "2022-11-03T10:18:46+00:00",
"service_code": "EXP001",
"shipping_rate_name": "Standard",
"shipping_strategy_name": "ABC"
},
"destination": {
"address1": "Address1",
"address2": "Address2",
"city": "NewYork",
"company": "ABC",
"country": "USA",
"country_code": "US",
"delivery_store_code": "80101",
"delivery_store_name": "ABC",
"email": "bobtest@example.com",
"first_name": "T",
"last_name": "W",
"name": "TW",
"phone": "1391234",
"province": "California",
"province_code": "4200006",
"standard_province_code": "NY",
"zip": "10001"
},
"fulfillment_holds": {
"reason": "ABC",
"reason_note": "ABC"
},
"id": "*****************9823691",
"line_item": {
"country_code_of_origin": "US",
"fulfillable_quantity": 1,
"fulfillment_order_id": "*************9823691",
"harmonized_system_code": "851712",
"id": "*****************7612852",
"line_item_id": "*****83451252",
"quantity": 1,
"shop_id": "*************37267234",
"sku": "*644011",
"variant_id": "****************7612852"
},
"order_id": "*****************2137691",
"request_status": "accepted",
"shop_id": "***************37267234",
"status": "open",
"supported_actions": "release_hold"
}
}
这篇文章对你有帮助吗?