Update tracking information

Requires write_assigned_fulfillment_orders access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/fulfillments/:order_id/: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 information for a specific fulfillment.
Path Parameters
  • fulfillment_id string required
    Fulfillment ID.
  • order_id string required
    Order ID.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • fulfillmentobject required
    Fulfillment information.
  • notify_customer boolean
    Indicates whether to notify the customer when creating or updating a fulfillment:
    • true: Notify the customer by email.
    • false: Do not notify the customer.
    Default value: false
  • tracking_infoobject
    Logistics tracking information.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
  • company string
    Logistics service provider.
  • number string required
    The tracking number provided by the logistics service provider.
    Example: string
  • url string
    The domain name of the logistics company.
  • tracking_info_listobject[]
    A list of logistics tracking information.The API performs an overwrite update. Any parameters not provided will be cleared.
    Maximum size: 10
  • tracking_company string
    Logistics service provider. Refer to Logistics company list for valid values.
  • tracking_number string required
    The tracking number provided by the logistics service provider.
    Example: string
  • tracking_url string
    The domain name of the logistics company.
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • fulfillmentobject
    Fulfillment details.
  • created_at string
    The date and time when the fulfillment was created. Format: ISO 8601.
    Example: 2022-10-21T08:56:20-04:00
  • id string
    Fulfillment ID.
  • line_itemsobject[]
    A list of products in the fulfillment.
  • fulfillable_quantity integer
    The remaining quantity of the product that can be shipped.
  • fulfillment_status string
    The fulfillment status. Valid values are:
    • unshipped: not shipped
    • partial: partially shipped
    • shipped: shipped
  • grams double
    The weight of the product in grams(g).
  • id string
    The ID of the line item snapshot table, generated by the system. Combined with the order ID, it uniquely identifies a line item.
  • name string
    SKU title, same as title.
  • price string
    The product price in store currency. The value is rounded to two decimal places.
  • price_setobject
    The product price, displayed in both the store currency and the buyer currency.
  • presentment_moneyobject
    The product price information presented to the buyer.
  • amount string
    The product price. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The discount amount information recorded by the merchant.
  • amount string
    The product price. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • product_id string
    The unique identifier for the product corresponding to the variant.
  • propertiesobject[]
    A list of product customization information.
  • additional string
    Additional custom fields for products. For example, if type is text, additional can include attributes such as font size, font style, and color.
  • name string
    Custom attribute name.
  • type string
    Custom information type. Valid values are:
    • text: text type
    • picture: picture type
    • link: hyperlink type
  • urls array
    URL list.
    If type is picture, thumbnails are retrieved via the urls values.
    If type is link, the hyperlink is the first URL in the urls values.
  • value string
    Custom attribute value.
  • quantity integer
    Quantity of items in the order.
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true：Shipping is required.
    • false：Shipping is not required.
  • sku string
    Product SKU serial number.
  • tax_linesobject[]
    A list of tax information.
  • name string
    Tax name.
  • price string
    Tax in store currency. The value is rounded to two decimal places.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The tax amount information presented to the buyer.
  • amount string
    The tax amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The tax amount information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • rate string
    The tax rate, for display only.
  • title string
    The title for the tax description, for display only.
  • taxable boolean
    Whether the product is subject to tax.
    • true: Tax is required.
    • false: No tax is required.
  • title string
    Product title.
  • total_discount string
    The total order discount, calculated as the sum of marketing discounts and custom discounts. The amount is rounded to two decimal places and displayed in the store currency.
  • total_discount_setobject
    The total order discount, calculated as the sum of marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.
  • presentment_moneyobject
    The discount amount information presented to the buyer.
  • amount string
    The discount amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The discount amount information recorded by the merchant.
  • amount string
    The discount amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • variant_id string
    The unique identifier for the variant.
  • variant_title string
    Product variant value. Multiple values are separated by /.
  • vendor string
    Supplier.
  • version string
    The version of the product.
  • name string
    Package code.
  • order_id string
    Order ID.
  • shipment_status string
    Fulfillment shipping status. Valid values are:
    • label_printed: Shipping labels have been printed.
    • label_purchased: Shipping labels have been purchased.
    • attempted_delivery: Indicates that the courier attempted to deliver the package but was unsuccessful.
    • ready_for_pickup: Waiting for the logistics company to pick up the package.
    • picked_up: Logistics company has picked up the package.
    • confirmed: The order has been confirmed by the logistics company.
    • in_transit: Package is in transit.
    • out_for_delivery: Package has arrived at the destination area and is being delivered.
    • delivered: Package has been delivered.
    • failure: For some reason, package delivery failed.
  • status string
    Fulfillment status. Valid values are:
    • success: shipment dispatched
    • cancelled: shipment has been canceled
  • tracking_company string
    Logistics company name.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
  • tracking_info_listobject[]
    A list of fulfillment information.
  • tracking_company string
    Logistics service provider.
  • tracking_number string
    The tracking number provided by the logistics service provider.
  • tracking_url string
    The domain name of the logistics company.
  • tracking_number string
    Third party tracking number.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
  • tracking_numbers array
    A list of tracking numbers provided by the logistics service provider.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
  • tracking_url string
    Logistics tracking URL.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
  • tracking_urls array
    A list of domain names of the logistics company.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
  • updated_at string
    The date and time when the fulfillment was updated. Format: ISO 8601.
    Example: 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
Update tracking information
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"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.