Fulfillment order list query

Requires read_assigned_fulfillment_orders access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20261201/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 .

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 unique identifier for pagination queries, used to locate a specific page.

This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.

For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/fulfillment_orders/fulfillment_orders_search.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 . For more information on how to use pagination, refer to Paging Mechanism.

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 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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

link

The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.

This parameter is returned when the requested page has a previous or next page.

For more information on how to use pagination, refer to Paging Mechanism.
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[]

Fulfillment orders
destinationobject

Consignee address
province_code string

State or provincial encoding , IOS 3166-2 encoding
Example: KY
email string

Mailbox
Example: sswe.t@mail.example.com
first_name string

firstName
Example: Jack
city string

City
Example: Louisville
address1 string

Address 1
Example: Chestnut Street 12
phone string

Telephone number
Example: 18883290137
province string

Province
Example: Kentucky
address2 string

Address 2
Example: Chestnut Street 13
name string

Customer name
Example: Jack Wang
id string

Unique encoding
Example: 1046000771
delivery_store_name string

Local delivery store name, provided only for local delivery
Example: Napo Shop
company string

Company
Example: LLL
country string

Country
Example: Canada
last_name string

lastName
country_code string

Country Code
Example: CA
delivery_store_code string

Local delivery store id, provided only for local delivery
Example: A121
merchant_requestsobject[]

Request a specific list of information at the time of delivery
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
created_at string

Time to happen ( format see IOS8601 )
Example: 2023-04-12T22:59:52+08:00
line_itemsobject[]

Fulfillment order product listing
shop_id string

store ID
Example: 541380002
fulfillable_quantity long

Available in approximately Product quantities
Example: 1
quantity long

Product number
Example: 1
country_code_of_origin string

Country code of origin/shipping point
Example: US
fulfillment_order_id string

Fulfillment order id
Example: 4005740193290131085320
variant_id string

Product SKU number
Example: 156223761
line_item_id string

Product id
Example: 40057889
id string

Fulfillment order Product table id
Example: 400574123
harmonized_system_code string

Customs code
Example: 121
assigned_locationobject

Location details assigned
province string

Province
Example: Ontario
address1 string

Address 1
Example: 126 York Street
city string

City
Example: Ottawa
location_id string

Location id
Example: 5668167071852661850
phone string

Telephone number
Example: 18883290139
country string

Country
Example: Canada
zip string

Postal code
Example: A1B 2C3
address2 string

Address 2
Example: Unit 42
name string

Location name
Example: Ottawa Store
country_code string

Country code
Example: CA
request_status string

Request status, including: unsubmitted, submitted, rejected, closed, cancellation_requested, cancellation_rejected, cancellation_accepted, accepted
Example: unsubmitted
id string

Fulfillment order id
Example: 4005740193290131085320
fulfill_by string

Late delivery time ( format see IOS8601 )
Example: 2023-04-12T22:59:52+08:00
supported_actions array

Action supported by the fulfillment order list
Example: ["\"create_fulfillment\""]
shop_id string

store ID
Example: 541380002
delivery_method string

Logistics methods including : shipping、pickup、local_delivery、none
Example: none
status string

Fulfillment order status , including : open , in_progress , cmos ed , cancelled , incomplete , on_hold , scheduled
Example: open
assigned_location_id string

Assigned location id
Example: 5668167071852661850
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
order_id string

Order id
Example: 21057116277667827637773776
fulfillment_holdsobject[]

Pause information
reason string

Pause cause
Example: something wrong
reason_note string

Pause notes
Example: something wrong
fulfill_at string

Shipping time ( format see IOS8601 )
Example: 2023-04-12T22:59:52+08:00

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

Authorization — header required

assignment_status — query

limit — query

location_ids — query

page_info — query

since_id — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/fulfillment_orders/fulfillment_orders_search.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal