Query fulfillment and delivery logistics events
GET https://{handle}.myshopline.com/admin/openapi/v20250601/fulfillments/:order_id/:fulfillment_id/events/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
.Path Parameters
- fulfillment_id string requiredInvoice idExample:
22060720884441337538627925
- order_id string requiredOrder idExample:
21056024607602932623437925
Query Parameters
- event_id stringEvent idExample:
4206234611998187371524
Request Headers
- Content-Type requiredThe value of this field is fixed to
application/json; charset=utf-8
- Authorization string requiredThe 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
- 200
- 401
- 429
For more information about status codes, see Http status code.
Response Headers
traceId
traceId
Response Body
fulfillment_eventsobject[]
Event listaddress stringAddressExample:126 York Street
city stringCityExample:Ottawa
country stringCountryExample:Canada
create_at stringCreate time ( format see ISO 8601 )Example:2021-08-16T08:27:57+00:00
estimated_delivery_at stringEstimated delivery time ( format see ISO 8601 )Example:2021-08-16T08:27:57+00:00
fulfillment_id stringfulfillment idExample:22060720884441337538627925
happened_at stringEvent duration ( format see ISO 8601 )Example:2021-08-16T08:27:57+00:00
id stringEvent idExample:4206234611998187371524
latitude stringLatitudeExample:23.32947
longitude stringLongitudeExample:113.301255
message stringNotesExample:nothing
order_id stringOrder idExample:21056024607602932623437925
province stringProvinceExample:Ontario
shop_id stringstore IDExample:1232244
status stringStatus ,Includes : label_printed、label_purchased、attempted_delivery、ready_for_pickup、picked_up、confirmed、in_transit、out_for_delivery、delivered、failureExample:label_printed
update_at stringUpdate time ( format see ISO 8601 )Example:2021-08-16T08:27:57+00:00
zip stringPostal codeExample:A1B 2C3
API Explorer
Debugger
Was this article helpful to you?
Error loading component.