Query all fulfillments for an order

Requires read_assigned_fulfillment_orders access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/orders/:order_id/fulfillments.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 .
Retrieve all fulfillments for a specific order.
Path Parameters
  • order_id string required
    The unique identifier for the order.
    Maximum length: 26
    Example: 21057401932826316666967110
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
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
  • fulfillmentsobject[]
    A list of fulfillments.
  • created_at string
    The date and time when the fulfillment was created. Format: ISO 8601.
    Example: 2021-08-31T02:20:26+08:00
    Example: 2022-10-21T08:56:20-04:00
  • id string
    The fulfillment ID.
    Example: 4005740193290131085320
  • line_itemsobject[]
    A list of product lines for the fulfillment.
  • fulfillable_quantity integer
    Remaining fulfillable quantity of products at the product line level.
  • fulfillment_quantity integer
    The quantity of products that are actually shipped.
  • fulfillment_status string
    The fulfillment status. Valid values are:
    • unshipped: not shipped
    • partial: partially shipped
    • shipped: shipped
  • grams double
    Total product weight, unit: g.
  • id string
    A system-generated unique identifier for this product snapshot.
  • name string
    The title of the product variant.
  • price string
    Item price.
  • price_setobject
    The product price, displayed in both the store's currency and the buyer's currency.
  • presentment_moneyobject
    The order price information presented to the buyer.
  • amount string
    Product amount. The value is rounded to two decimal places. For example, 88.98.
  • currency_code string
    Order currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
  • shop_moneyobject
    The order price information presented to the merchant.
  • amount string
    Product amount. The value is rounded to two decimal places. For example, 88.98.
    Example: 100.00
  • currency_code string
    Order currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: "USD"
  • product_id string
    The unique identifier for the product.
    Example: "343342675"
  • propertiesobject[]
    Additional information details.
  • additional string
    Additional information.
    Example: " add-on information "
  • name string
    Custom attribute name.
    Example: " picture "
  • type string
    Property type. Valid values are:
    • text：text type
    • picture：picture type
    • link：link type
  • urls array
    List of product domain names.
    Example: ["[\"https://www.myshopline.com\"]"]
  • value string
    Custom attribute values.
    Example: value
  • quantity integer
    The number of product SKUs.
    Example: 1
  • requires_shipping boolean
    Indicates whether this product needs to be physically shipped to the customer.
    • true: The product requires shipping.
    • false: The product does not require shipping.
    Example: true
  • sku string
    Product barcode.
    Example: "183423409238904944"
  • tax_linesobject[]
    A list of tax information.
  • name string
    Tax name.
    Example: " item tax "
  • price string
    The tax amount. The actual tax collected on the product is based on this field value.
    Example: "10.00"
  • price_setobject
    The tax amount，displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    The tax information presented to the buyer.
  • amount string
    The total amount of tax applied to the buyer's order. The value is rounded to two decimal places. For example, 88.98.
  • currency_code string
    Tax currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
  • shop_moneyobject
    The tax information presented to the merchant.
  • amount string
    The total amount of tax associated with this order for the merchant. The value is rounded to two decimal places. For example, 88.98.
  • currency_code string
    Tax currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
  • rate string
    The tax rate, for display only.
  • title string
    The tax description title, for display only.
  • taxable boolean
    Indicates whether the product is subject to tax.
    • true: Tax is required.
    • false: No tax is required.
    Example: true
  • title string
    The product title, used for display to the buyer.
    Maximum length: 255
  • total_discount string
    Total discounted price.
  • total_discount_setobject
    The total product discount, displayed in both the store's currency and the buyer's currency.
  • presentment_moneyobject
    The discounted price information presented to the buyer.
  • amount string
    Discount amount. The value is rounded to two decimal places. For example, 88.98.
  • currency_code string
    Discount amount currency. The value of this parameter is a three-letter currency code that follows theISO 4217 standard. For example, USD.
  • shop_moneyobject
    The discounted price information presented to the merchant.
  • amount string
    Discount amount. The value is rounded to two decimal places. For example, 88.98.
  • currency_code string
    Discount amount currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
  • variant_id string
    Unique variant identifier (SKU).
    Maximum length：64
  • variant_title string
    Product attribute value.
  • vendor string
    Supplier.
  • version string
    Product version.
  • name string
    Package name.
  • order_id string
    The unique identifier for the order.
    Maximum length: 26
    Example：21057401932826316666967110
  • shipment_status string
    Product delivery status. Valid values are:
    • out_for_delivery: out for delivery
    • delivered: delivered
    • faliure: delivery failed
    • picked_up: picked up
  • status string
    Shipping status of the order package. Valid values are:
    • success: shipment successful
    • 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[]
    If this parameter is specified, the individual parameters tracking_url, tracking_number, and tracking_company will be ignored.Maximum of 10 tracking infos allowed.
  • tracking_company string
    The logistics service provider.
  • tracking_number string
    The tracking number.
  • tracking_url string
    The URL for tracking the package.
  • 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
    List of logistics tracking numbers.
    DEPRECATED：This parameter is deprecated from API version v20250301.
  • 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
    Logistics tracking domain name list.
    DEPRECATED：This parameter is deprecated from API version v20250301.
  • updated_at string
    The date and time when the logistics information was updated. Format: ISO 8601.
    Example：2021-08-31T02:20:26+08:00
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/orders/order_id/fulfillments.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
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.