需要 write_assigned_fulfillment_orders 权限点。
更多权限点使用信息,请参考:
POST https://{handle}.myshopline.com/admin/openapi/v20260301/fulfillments/:order_id/:fulfillment_id/update_tracking.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
更新指定发货单的追踪信息。
路径参数
  • order_id string required
    订单号。
  • fulfillment_id string required
    发货单 ID。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
  • fulfillmentobject required
    发货单信息。
  • notify_customer boolean
    创建或更新发货单物流追踪信息后是否通过邮件通知消费者:
    • true: 通知消费者
    • false: 不通知消费者
    默认值:false
  • tracking_infoobject
    物流追踪信息。
    废弃: 该字段自 API 版本 v20250601 起已废弃。参考 tracking_info_list 字段查看相关信息。
  • company string
    物流公司名称。
  • number string required
    物流单号。
    例子: string
  • url string
    物流公司的域名。
  • tracking_info_listobject[]
    物流追踪信息列表。此接口执行覆盖更新,未提供字段将被清空。
    最大个数限制:10
  • tracking_company string
    物流公司名称,枚举值参考 物流公司名单
  • tracking_number string required
    物流单号。
    例子: string
  • tracking_url string
    物流公司的域名。
状态码
更多状态码信息,参考 HTTP 状态码

响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
  • fulfillmentobject
    发货单信息。
  • created_at string
    发货单创建时间。格式:ISO 8601
    例子: 2022-10-21T08:56:20-04:00
  • id string
    发货单 ID。
  • line_itemsobject[]
    发货单的商品列表。
  • fulfillable_quantity integer
    商品剩余可发货数量。
  • fulfillment_status string
    发货状态。有效枚举值包含:
    • unshipped:未发货
    • partial:部分发货
    • shipped:已发货
  • grams double
    重量,单位:g。
  • id string
    商品行快照表的 ID,系统生成,与订单 ID 唯一确认一个商品行。
  • name string
    SKU 标题,该字段值和 title 一致。
  • price string
    商品售价,以店铺币种展示。数值保留到小数点后两位。
  • price_setobject
    商品售价,分别以店铺币种金额和买家币种金额展示。
  • presentment_moneyobject
    展示给买家的商品售价信息。
  • amount string
    商品售价,数值保留到小数点后两位。
  • currency_code string
    三位币种码,遵循 ISO 4217 国际标准。
    例子: USD
  • shop_moneyobject
    商家侧记录的商品售价信息。
  • amount string
    商品售价,数值保留到小数点后两位。
  • currency_code string
    三位币种码,遵循 ISO 4217 国际标准。
    例子: USD
  • product_id string
    款式对应商品的唯一标识 ID。
  • propertiesobject[]
    商品定制信息列表。
  • additional string
    定制商品附加字段,比如当 type文字additional 可以附加文字的字号、字体、颜色等。
  • name string
    自定义属性名称。
  • type string
    定制信息类型。有效枚举值包含:
    • text:字符类型
    • picture:图片类型
    • link:链接类型
  • urls array
    URL 列表。如果 typepicture,可通过 urls 获取缩略图,如果 typelink,那么超链接为 urls 的第一个。
  • value string
    自定义属性值。
  • quantity integer
    订单中的商品数量。
  • requires_shipping boolean
    商品是否需要发货。
    • true:需要发货
    • false:不需要发货
  • sku string
    商品 SKU 序列号。
  • tax_linesobject[]
    税费明细列表。
  • name string
    税费名称。
  • price string
    税费,以店铺币种展示。数值保留到小数点后两位。
  • price_setobject
    税费,分别以买家币种和店铺币种展示。
  • presentment_moneyobject
    展示给买家的税费信息。
  • amount string
    税费,数值保留到小数点后两位。
  • currency_code string
    三位币种码,遵循 ISO 4217 国际标准。
    例子: USD
  • shop_moneyobject
    商家侧记录的税费信息。
  • amount string
    税费,数值保留到小数点后两位。
  • currency_code string
    三位币种码,遵循 ISO 4217 国际标准。
    例子: USD
  • rate string
    税率,该信息只做展示作用。
  • title string
    税费说明标题。该信息只做展示作用。
  • taxable boolean
    该商品是否需要收税。
    • true:需要收税
    • false:不需要收税
  • title string
    商品标题。
  • total_discount string
    订单折扣总和,为营销折扣 + 自定义折扣,数值保留到小数点后两位,以店铺币种金额展示。
  • total_discount_setobject
    订单折扣总和,为营销折扣 + 自定义折扣,分别以店铺币种金额和买家币种金额展示。
  • presentment_moneyobject
    展示给买家的折扣信息。
  • amount string
    折扣金额,数值保留到小数点后两位。
  • currency_code string
    三位币种码,遵循 ISO 4217 标准。
    例子: USD
  • shop_moneyobject
    商家侧记录的折扣信息。
  • amount string
    折扣金额,数值保留到小数点后两位。
  • currency_code string
    三位币种码,遵循 ISO 4217 标准。
    例子: USD
  • variant_id string
    款式的唯一标识 ID。
  • variant_title string
    商品款式值,多个以 / 分割。
  • vendor string
    供应商。
  • version string
    商品版本。
  • name string
    包裹编码。
  • order_id string
    订单号。
  • shipment_status string
    发货单物流追踪状态。有效枚举值包含:
    • label_printed:物流标签已打印
    • label_purchased:物流标签已购买
    • attempted_delivery:尝试派送,表示快递员尝试派送包裹但未成功
    • ready_for_pickup:等待物流公司取件
    • picked_up:物流公司已取件
    • confirmed:订单已确认
    • in_transit:包裹正在运输途中
    • out_for_delivery:包裹已到达目的地区域,正在派送
    • delivered:包裹已送达
    • failure:由于某些原因,包裹配送失败
  • status string
    发货单状态。有效枚举值包含:
    • success:已发货
    • cancelled:已取消
  • tracking_company string
    物流公司名称。
    废弃: 该字段自 API 版本 v20250601 起已废弃。参考 tracking_info_list 字段查看相关信息。
  • tracking_info_listobject[]
    物流追踪信息列表。
  • tracking_company string
    物流服务商。
  • tracking_number string
    物流单号。
  • tracking_url string
    物流公司的域名。
  • tracking_number string
    第三方物流单号。
    废弃: 该字段自 API 版本 v20250601 起已废弃。参考 tracking_info_list 字段查看相关信息。
  • tracking_numbers array
    物流单号列表。
    废弃: 该字段自 API 版本 v20250601 起已废弃。参考 tracking_info_list 字段查看相关信息。
  • tracking_url string
    物流追踪URL。
    废弃: 该字段自 API 版本 v20250601 起已废弃。参考 tracking_info_list 字段查看相关信息。
  • tracking_urls array
    物流公司域名列表。
    废弃: 该字段自 API 版本 v20250601 起已废弃。参考 tracking_info_list 字段查看相关信息。
  • updated_at string
    发货单更新时间。格式:ISO 8601
    例子: 2022-10-21T08:56:20-04:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

path required
path required
header required

Body

required
{
  "fulfillment": {
    "notify_customer": null,
    "tracking_info": {
      "company": null,
      "number": "string",
      "url": null
    },
    "tracking_info_list": [
      {
        "tracking_company": null,
        "tracking_number": "string",
        "tracking_url": null
      }
    ]
  }
}

Language

curl --request POST \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/fulfillments/order_id/fulfillment_id/update_tracking.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
更新发货单物流追踪信息
Request
{
"fulfillment": {
"notify_customer": true,
"tracking_info_list": {
"tracking_company": "my-company",
"tracking_number": "UG15439033",
"tracking_url": "http://www.my-url.com"
}
}
}
Response
{
"fulfillment": {
"created_at": "2024-08-31T02:20:26+08:00",
"id": "****************364930293",
"line_items": [
{
"fulfillable_quantity": 3,
"fulfillment_status": "fulfilled",
"grams": 45,
"id": "*************49351",
"name": "ABC",
"price": "3.00",
"price_set": {
"presentment_money": {
"amount": "3.00",
"currency_code": "USD"
},
"shop_money": {
"amount": "3.00",
"currency_code": "USD"
}
},
"product_id": "*****************332553651",
"properties": {
"additional": "black",
"name": "Attribute name",
"type": "picture",
"urls": [
"https://www.test.com"
],
"value": "attribute value"
},
"quantity": 3,
"requires_shipping": true,
"sku": "*****************835053185",
"taxLines": [
{
"name": "tax description",
"price": "1.00",
"price_set": {
"presentment_money": {
"amount": "1.00",
"currency_code": "USD"
},
"shop_money": {
"amount": "1.00",
"currency_code": "USD"
}
},
"rate": "1.00",
"title": "ABC"
}
],
"taxable": true,
"title": "product title",
"total_discount": "10.00",
"total_discount_set": {
"presentment_money": {
"amount": "3.00",
"currency_code": "USD"
},
"shop_money": {
"amount": "3.00",
"currency_code": "USD"
}
},
"variant_id": "*****************269573651",
"variant_title": "red",
"vendor": "vendor name",
"version": "0"
}
],
"name": "ABC",
"order_id": "*****************684070293",
"shipment_status": "picked_up",
"status": "success",
"tracking_company": "test",
"tracking_info_list": [
{
"tracking_company": "ABC",
"tracking_number": "****************28407811",
"tracking_url": "www.example.com"
}
],
"tracking_number": "SF1111111",
"tracking_numbers": [
"SF1111111"
],
"tracking_url": "www.example.com",
"tracking_urls": [
"www.example.com"
],
"updated_at": "2024-08-31T02:20:26+08:00"
}
}
这篇文章对你有帮助吗?