Get all fulfillment orders

Requires read_assigned_fulfillment_orders access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/fulfillment_orders/:order_id/fulfillment_orders.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 .
Get all fulfillment orders for a specified order.
Path Parameters
  • 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
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
  • fulfillment_ordersobject[]
    A list of fulfillment orders.
  • assigned_locationobject
    The location from which the fulfillment order is shipped.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
  • country string
    The country or region in the address.
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
  • location_id string
    Location ID.
  • name string
    Location name.
  • phone string
    The phone number of the contact.
  • province string
    The province in the address.
  • zip string
    The postal code information of the address.
  • assigned_location_id string
    Fulfillment order shipping location ID.
  • created_at string
    The date and time when the fulfillment order was created. Format: ISO 8601.
  • delivery_methodobject
    Shipping method details.
  • max_delivery_date_time string
    Latest shipping time. Format: ISO 8601.
    Example: 2021-08-31T02:20:26+08:00
  • method_type string
    Shipping method. Valid values are:
    • local: Local delivery
    • pick_up: Pick up at the store
    • shipping: Logistics and delivery
    • none: No shipping method
  • min_delivery_date_time string
    Earliest shipping time. Format: ISO 8601.
    Example: 2021-08-31T02:20:26+08:00
  • service_code string
    Shipping rate code of the carrier service.
  • shipping_rate_name string
    The name of the shipping rate. It has a corresponding value only when method_type is shipping or local.
  • shipping_strategy_name string
    The name of the shipping strategy. It has a corresponding value only when the method_type is shipping or local.
  • destinationobject
    The recipient's address details.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
  • company string
    The company name of the recipient.
  • country string
    The country or region in the address.
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
  • delivery_store_code string
    Store code for the in-store pickup method.
  • delivery_store_name string
    Store name for the in-store pickup method.
  • email string
    The email of the recipient.
  • first_name string
    The first name of the recipient.
  • last_name string
    The last name of the recipient.
  • name string
    The full name of the recipient.
  • phone string
    The phone number of the recipient.
  • province string
    The province in the address.
  • province_code string
    The code for the province or region in the address, automatically generated by the system.
  • zip string
    The postal code information of the address.
  • fulfillment_holdsobject[]
    Information about the paused fulfillment order.
  • reason string
    Hold reason.
  • reason_note string
    Note.
  • id string
    Fulfillment order ID.
  • line_itemsobject[]
    A list of order product snapshots.
  • country_code_of_origin string
    Country or region code indicating the place of origin or shipping origin. Format: ISO 3166-1.
  • fulfillable_quantity long
    The deliverable quantity of the item in the fulfillment order.
  • fulfillment_order_id string
    Fulfillment order ID.
  • harmonized_system_code string
    Harmonized system code, used to categorize a product in international trade.
  • id string
    Fulfillment order line item ID.
  • line_item_id string
    Line item ID.
  • quantity long
    The product quantity in the fulfillment order.
  • shop_id string
    Shop ID.
  • sku string
    The product SKU.
  • variant_id string
    A unique code assigned to a distinct product in inventory.
  • order_id string
    Order ID.
  • request_status string
    Fulfillment request status. Returned when the fulfillment location is a fulfillment app location. Valid values are:
    • unsubmitted: Request not initiated
    • submitted: Request submitted
    • accepted: Request accepted
    • rejected: Request rejected
    • cancellation_requested: Fulfillment cancellation requested
    • cancellation_accepted: Fulfillment cancellation approved
    • cancellation_rejected: Fulfillment cancellation rejected
  • shop_id string
    Shop ID.
  • status string
    Fulfillment order status. Valid values are:
    • open：Not yet shipped
    • in_progress：Shipping in progress
    • closed：Fulfillment completed
    • on_hold：Shipment paused
  • supported_actions array
    Supported operations for the fulfillment order. Valid values are:
    • create_fulfillment: Create a fulfillment
    • move: Change the fulfillment location
    • hold: Hold fulfillment
    • release_hold: Release fulfillment hold
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/fulfillment_orders/order_id/fulfillment_orders.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Get all fulfillment orders
Response
{
  "fulfillment_orders": {
    "assigned_location": {
      "address1": "Address1",
      "address2": "Address2",
      "city": "NewYork",
      "country": "USA",
      "country_code": "US",
      "location_id": "***********9467106",
      "name": "TW",
      "phone": "1391234",
      "province": "California",
      "zip": "***34"
    },
    "assigned_location_id": "***********9467106",
    "created_at": "2022-11-04T10:18:46+00:00",
    "delivery_method": {
      "max_delivery_date_time": "2022-11-04T10:18:46+00:00",
      "method_type": "local",
      "min_delivery_date_time": "2022-11-03T10:18:46+00:00",
      "service_code": "EXP001",
      "shipping_rate_name": "Standard",
      "shipping_strategy_name": "ABC"
    },
    "destination": {
      "address1": "Address1",
      "address2": "Address2",
      "city": "NewYork",
      "company": "ABC",
      "country": "USA",
      "country_code": "US",
      "delivery_store_code": "80101",
      "delivery_store_name": "ABC",
      "email": "bobtest@example.com",
      "first_name": "T",
      "last_name": "W",
      "name": "TW",
      "phone": "1391234",
      "province": "California",
      "province_code": "4200006",
      "standard_province_code": "NY",
      "zip": "10001"
    },
    "fulfillment_holds": {
      "reason": "ABC",
      "reason_note": "ABC"
    },
    "id": "*****************9823691",
    "line_item": {
      "country_code_of_origin": "US",
      "fulfillable_quantity": 1,
      "fulfillment_order_id": "*************9823691",
      "harmonized_system_code": "851712",
      "id": "*****************7612852",
      "line_item_id": "*****83451252",
      "quantity": 1,
      "shop_id": "*************37267234",
      "sku": "*644011",
      "variant_id": "****************7612852"
    },
    "order_id": "*****************2137691",
    "request_status": "accepted",
    "shop_id": "***************37267234",
    "status": "open",
    "supported_actions": "release_hold"
  }
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.