Update tracking number

Requires write_orders access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/orders/:order_id/fulfillments/:fulfillment_id/update_tracking.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

Update tracking number

Path Parameters

fulfillment_id string required
[]
Package ID
order_id string required
[]
Order number

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

fulfillmentobject required
[]
Package information
tracking_infoobject
[]
Logistics information
company string
[]
For logistics companies, see the document for enumeration: https://shopline.yuque.com/docs/share/cfb1e1ca-aede-43e9-b1e6-59ab47fd7d0f?# "Logistics company name enumeration information"
[]
Example: "4PX"
number string
[]
Tracking number
[]
Example: "1123212"
url string
[]
Logistics tracking URL
[]
Example: "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

fulfillmentobject
[]
Package information
created_at string
[]
Creation date
[]
Example: fulfillment
id string
[]
Package ID
[]
Example: "4005740193290131085320"
line_itemsobject[]
[]
Item group
fulfillable_quantity integer
[]
Available quantity
[]
Example: 1
grams double
[]
Weight
[]
Example: 10.5
id string
[]
Product ID
[]
Example: "466157049"
name string
[]
Product name
[]
Example: Trade name
price string
[]
Price
[]
Example: "100.00"
price_setobject
[]
Multi-currency prices
presentment_moneyobject
[]
Settlement currency
amount string
[]
Amount
[]
Example: "100.00"
currency_code string
[]
Currency
[]
Example: "USD"
shop_moneyobject
[]
Store currency
amount string
[]
Amount
[]
Example: "100.00"
currency_code string
[]
Currency
[]
Example: "USD"
product_id string
[]
Product ID
[]
Example: "343342675"
quantity integer
[]
Product quantity shipped
[]
Example: 1
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product code
[]
Example: "183423409238904944"
tax_linesobject[]
[]
Tax
price string
[]
Amount
[]
Example: "10.00"
price_setobject
[]
Multi-currency amount
presentment_moneyobject
[]
Settlement currency
amount string
[]
Amount
[]
Example: "10.00"
currency_code string
[]
Currency
[]
Example: "USD"
shop_moneyobject
[]
Store currency
amount string
[]
Amount
[]
Example: "10.00"
currency_code string
[]
Currency
[]
Example: "USD"
rate string
[]
Tax rate
[]
Example: "1.00"
title string
[]
Tax name
[]
Example: " Product tax "
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: "Draft"
total_discount string
[]
Discount amount
[]
Example: "0.00"
total_discount_setobject
[]
Multi-currency discount
presentment_moneyobject
[]
Settlement currency
amount string
[]
Amount
[]
Example: "0.00"
currency_code string
[]
Currency
[]
Example: "USD"
shop_moneyobject
[]
Store currency
amount string
[]
Amount
[]
Example: "0.00"
currency_code string
[]
Currency
[]
Example: "USD"
variant_id string
[]
Product variant ID
[]
Example: "183423409238904944"
variant_title string
[]
Product variant name
[]
Example: "Black / Bracelet / Bracelet""
version string
[]
Product version
[]
Example: "1"
name string
[]
Package
[]
Example: "#21057116277667827637773776.1"
order_id string
[]
Order number
[]
Example: "21057116277667827637773776"
shipment_status string
[]
Package tracking
[]
Example: "delivered"
status string
[]
Logistics delivery status, success-shipped; cancelled-cancelled;
[]
Example: "success-shipped"
tracking_company string
[]
Logistics company name
[]
Example: "Other"
tracking_number string
[]
Tracking number
[]
Example: "UG198768340YP"
tracking_numbers array
[]
Tracking number array
[]
Example: ["UG198768340YP"]
tracking_url string
[]
Logistics tracking URL
[]
Example: "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
tracking_urls array
[]
Logistics tracking URL group
[]
Example: [""https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345""]
updated_at string
[]
Update time
[]
Example: 2022-10-21T08:56:20-04:00

API Explorer

Debugger

Base URL

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

ParamOptions

fulfillment_id — path required

order_id — path required

Authorization — header required

Body

Body required

{
  "fulfillment": {
    "tracking_info": {
      "company": "\"4PX\"",
      "number": "\"1123212\"",
      "url": "\"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345\""
    }
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders/order_id/fulfillments/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'

Was this article helpful to you?

SHOPLINE

Legal