Query all fulfillments for an order

Requires read_assigned_fulfillment_orders access scope.
For more info , refer to:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/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 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
Response
For more information about status codes, see Http status code.
Response Headers
  • traceId
    traceId
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.
    Example: 1
  • fulfillment_quantity integer
    The quantity of products that are actually shipped.
    Example: 1
  • fulfillment_status string
    The fulfillment status. Valid values are:
    • unshipped: not shipped
    • partial: partially shipped
    • shipped: shipped
    Example: open
  • grams double
    Total product weight, unit: g.
    Example: 10.5
  • id string
    A system-generated unique identifier for this product snapshot.
    Example: 466157049
  • name string
    The title of the product variant.
    Example: Trade name
  • price string
    Item price.
    Example: 100.00
  • 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.
    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
  • 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
    Example: "picture"
  • 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.
    Example: "10.00"
  • 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.
    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.
    Example: "10.00"
  • 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.
    Example: "USD"
  • rate string
    The tax rate, for display only.
    Example: "1.00"
  • title string
    The tax description title, for display only.
    Example: " Product tax "
  • 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
    Example: "Draft"
  • total_discount string
    Total discounted price.
    Example: 0.00
  • 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.
    Example: "0.00"
  • 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.
    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.
    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.
    Example: "USD"
  • variant_id string
    Unique variant identifier (SKU).
    Maximum length：64
    Example: "183423409238904944"
  • variant_title string
    Product attribute value.
    Example: "Black / Bracelet / Bracelet""
  • vendor string
    Supplier.
  • version string
    Product version.
    Example: "1"
  • name string
    Package name.
    Example: "#21057116277667827637773776.1"
  • order_id string
    The unique identifier for the order.
    Maximum length: 26
    Example：21057401932826316666967110
    Example: "21057116277667827637773776"
  • shipment_status string
    Product delivery status. Valid values are:
    • out_for_delivery: out for delivery
    • delivered: delivered
    • faliure: delivery failed
    • picked_up: picked up
    Example: "success"
  • status string
    Shipping status of the order package. Valid values are:
    • success: shipment successful
    • cancelled: shipment has been canceled
    Example: "success"
  • tracking_company string
    Logistics service provider.
    Example: "Other"
  • tracking_number string
    The delivery tracking number provided by the logistics service provider.
    Example: "UG198768340YP"
  • tracking_numbers array
    List of logistics tracking numbers.
    DEPRECATED：This parameter is deprecated from API version v20250331.
    Example: ["UG198768340YP"]
  • tracking_url string
    The domain name of the logistics company.
    Example: "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
  • tracking_urls array
    Logistics tracking domain name list.
    DEPRECATED：This parameter is deprecated from API version v20250331.
    Example: [""https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345""]
  • updated_at string
    The date and time when the logistics information was updated. Format: ISO 8601.
    Example：2021-08-31T02:20:26+08:00
    Example: 2022-10-21T08:56:20-04:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— path required
— header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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'
Examples
Retrieve all fulfillment associated with the order
Response
{
  "fulfillments": [
    {
      "created_at": "2024-11-13T01:15:33-10:00",
      "id": "22067304893111950871417710",
      "line_items": [
        {
          "fulfillable_quantity": 0,
          "fulfillment_quantity": 2,
          "fulfillment_status": "fulfilled",
          "grams": 28350,
          "id": 7771,
          "name": "product-F",
          "price": "45.0",
          "price_set": {
            "presentment_money": {
              "amount": "45.0",
              "currency_code": "USD"
            },
            "shop_money": {
              "amount": "45.0",
              "currency_code": "USD"
            }
          },
          "product_id": "16066988061694010388760910",
          "properties": null,
          "quantity": 2,
          "requires_shipping": true,
          "sku": "Test20200925200300801002",
          "tax_lines": [
            {
              "name": null,
              "price": "0.0",
              "price_set": {
                "presentment_money": {
                  "amount": "0.0",
                  "currency_code": "USD"
                },
                "shop_money": {
                  "amount": "0.0",
                  "currency_code": "USD"
                }
              },
              "rate": null,
              "title": "VAT"
            },
            {
              "name": null,
              "price": "0.0",
              "price_set": {
                "presentment_money": {
                  "amount": "0.0",
                  "currency_code": "USD"
                },
                "shop_money": {
                  "amount": "0.0",
                  "currency_code": "USD"
                }
              },
              "rate": null,
              "title": "VAT"
            }
          ],
          "taxable": true,
          "title": "product-F",
          "total_discount": "0.0",
          "total_discount_set": {
            "presentment_money": {
              "amount": "0.0",
              "currency_code": "USD"
            },
            "shop_money": {
              "amount": "0.0",
              "currency_code": "USD"
            }
          },
          "variant_id": "18066988061699379097950910",
          "variant_title": null,
          "vendor": null,
          "version": "0"
        }
      ],
      "name": "#TU202132831.1",
      "order_id": "21067304892129812651387710",
      "shipment_status": null,
      "status": "success",
      "tracking_company": "",
      "tracking_number": "",
      "tracking_numbers": [],
      "tracking_url": "",
      "tracking_urls": [],
      "updated_at": "2024-11-19T04:05:05-10:00"
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.