Fulfillment order list query

Requires read_assigned_fulfillment_orders access scope.
For more info , refer to:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/fulfillment_orders/fulfillment_orders_search.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 .
Fulfillment order list query
Query Parameters
  • assignment_status string
    Request status
    Example: "unsubmitted"
  • limit integer
    The number of data to query, the default is 20, the maximum is 100
    Example: 10
  • location_ids string
    Location id list
    Example: "24826418,24826411"
  • page_info string
    The requirements after encryption include all query conditions parameters ( except for queryParamData ) , used for previous page and next page to directly access the field parse
    Example: "7AFD7393C6E7CF18672C038477E2EF6A463464BDBAF766DD8F8CB8E0085F82419A94B80084BCDA0B838B3F13C302A2C9044E"
  • since_id string
    The starting position of the order number ID of the data to be queried
    Example: "21056199447626881527947685"
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
  • link
    Contain the request parameters of the previous page and the next page
  • traceId
    traceId
Response Body
  • fulfillment_ordersobject[]
    Fulfillment orders
  • assigned_locationobject
    Location details assigned
  • address1 string
    Address 1
    Example: 126 York Street
  • address2 string
    Address 2
    Example: Unit 42
  • city string
    City
    Example: Ottawa
  • country string
    Country
    Example: Canada
  • country_code string
    Country code
    Example: CA
  • location_id string
    Location id
    Example: 5668167071852661850
  • name string
    Location name
    Example: Ottawa Store
  • phone string
    Telephone number
    Example: 18883290139
  • province string
    Province
    Example: Ontario
  • zip string
    Postal code
    Example: A1B 2C3
  • assigned_location_id string
    Assigned location id
    Example: 5668167071852661850
  • delivery_method string
    Logistics methods including : shipping、pickup、local_delivery、none
    Example: none
  • destinationobject
    Consignee address
  • address1 string
    Address 1
    Example: Chestnut Street 12
  • address2 string
    Address 2
    Example: Chestnut Street 13
  • city string
    City
    Example: Louisville
  • company string
    Company
    Example: LLL
  • country string
    Country
    Example: Canada
  • country_code string
    Country Code
    Example: CA
  • delivery_store_code string
    Local delivery store id, provided only for local delivery
    Example: A121
  • delivery_store_name string
    Local delivery store name, provided only for local delivery
    Example: Napo Shop
  • email string
    Mailbox
    Example: sswe.t@mail.example.com
  • first_name string
    firstName
    Example: Jack
  • id string
    Unique encoding
    Example: 1046000771
  • last_name string
    lastName
  • name string
    Customer name
    Example: Jack Wang
  • phone string
    Telephone number
    Example: 18883290137
  • province string
    Province
    Example: Kentucky
  • province_code string
    State or provincial encoding , IOS 3166-2 encoding
    Example: KY
  • display_status string
    In the store pickup scenarios , if it is not in the store pickup , or in the store pickup-the state of not picking up is return no
    Example: Picked up
  • fulfill_at string
    Shipping time ( format see IOS8601 )
    Example: 2023-04-12T22:59:52+08:00
  • fulfill_by string
    Late delivery time ( format see IOS8601 )
    Example: 2023-04-12T22:59:52+08:00
  • fulfillment_holdsobject[]
    Pause information
  • reason string
    Pause cause
    Example: something wrong
  • reason_note string
    Pause notes
    Example: something wrong
  • id string
    Fulfillment order id
    Example: 4005740193290131085320
  • line_itemsobject[]
    Fulfillment order product listing
  • country_code_of_origin string
    Country code of origin/shipping point
    Example: US
  • fulfillable_quantity long
    Available in approximately Product quantities
    Example: 1
  • fulfillment_order_id string
    Fulfillment order id
    Example: 4005740193290131085320
  • harmonized_system_code string
    Customs code
    Example: 121
  • id string
    Fulfillment order Product table id
    Example: 400574123
  • line_item_id string
    Product id
    Example: 40057889
  • quantity long
    Product number
    Example: 1
  • shop_id string
    store ID
    Example: 541380002
  • variant_id string
    Product SKU number
    Example: 156223761
  • merchant_requestsobject[]
    Request a specific list of information at the time of delivery
  • created_at string
    Time to happen ( format see IOS8601 )
    Example: 2023-04-12T22:59:52+08:00
  • kind string
    Third party request status including : submit : fulfillment_request , cancellation_requested , cancellation_reques
    Example: submit
  • message string
    Notes
    Example: none
  • notify_customer boolean
    Whether to inform customer when shipping
    Example: true
  • order_id string
    Order id
    Example: 21057116277667827637773776
  • request_status string
    Request status, including: unsubmitted, submitted, rejected, closed, cancellation_requested, cancellation_rejected, cancellation_accepted, accepted
    Example: unsubmitted
  • shop_id string
    store ID
    Example: 541380002
  • status string
    Fulfillment order status , including : open , in_progress , cmos ed , cancelled , incomplete , on_hold , scheduled
    Example: open
  • supported_actions array
    Action supported by the fulfillment order list
    Example: "create_fulfillment"
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— header required
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/fulfillment_orders/fulfillment_orders_search.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.

Error loading component.

Error loading component.