--- title: "Query fulfillment and delivery logistics events" doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/admin-rest-api/order/shipping-and-fulfillment/query-fulfillment-and-delivery-logistics-events' md: 'https://developer.shopline.com/docs/admin-rest-api/order/shipping-and-fulfillment/query-fulfillment-and-delivery-logistics-events.md' --- # Query fulfillment and delivery logistics events - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `read_assigned_fulfillment_orders` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http GET /fulfillments/:order_id/:fulfillment_id/events/search.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `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` . ## Required Permissions * `read_assigned_fulfillment_orders` ## Request ### Path Parameters * `fulfillment_id` string (required) Invoice id * `order_id` string (required) Order id ### Query Parameters * `event_id` string (optional) Event 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](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ## Response ### Status Codes * `200` For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en). * `401` * `429` ### 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 #### 200 * `fulfillment_events` array Event list * `country` string Country * `update_at` string Update time ( format see ISO 8601 ) * `latitude` string Latitude * `province` string Province * `zip` string Postal code * `city` string City * `address` string Address * `shop_id` string store ID * `status` string Status ,Includes : label_printed、label_purchased、attempted_delivery、ready_for_pickup、picked_up、confirmed、in_transit、out_for_delivery、delivered、failure * `order_id` string Order id * `message` string Notes * `id` string Event id * `fulfillment_id` string fulfillment id * `longitude` string Longitude * `create_at` string Create time ( format see ISO 8601 ) * `estimated_delivery_at` string Estimated delivery time ( format see ISO 8601 ) * `happened_at` string Event duration ( format see ISO 8601 ) #### 401 * `errors` string Error message. #### 429 * `errors` string Error message. ## OpenAPI Definition ```json { "externalDocs": { "description": "Permission point used by the interface is `read_assigned_fulfillment_orders` , For more information about the use of permission points, see", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=en", "errorTableDescription": "" }, "operationId": "d9d0Ohd7", "parameters": [ { "name": "fulfillment_id", "in": "path", "description": "Invoice id", "required": true, "style": "simple", "schema": { "name": "fulfillment_id", "description": "Invoice id", "type": "string", "example": "22060720884441337538627925" }, "example": "22060720884441337538627925" }, { "name": "order_id", "in": "path", "description": "Order id", "required": true, "style": "simple", "schema": { "name": "order_id", "description": "Order id", "type": "string", "example": "21056024607602932623437925" }, "example": "21056024607602932623437925" }, { "name": "event_id", "in": "query", "description": "Event id", "style": "form", "explode": true, "schema": { "name": "event_id", "description": "Event id", "type": "string", "example": "4206234611998187371524" }, "example": "4206234611998187371524" }, { "name": "Content-Type", "in": "header", "description": "The field must be set to the fixed value `application/json; charset=utf-8`.", "required": true, "style": "string", "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": " The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ", "required": true, "style": "string", "schema": { "name": "Authorization", "description": " The access token for the API. Please refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "responses": { "200": { "description": "For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en).", "headers": { "traceId": { "description": "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." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "fulfillment_events": { "name": "fulfillment_events", "description": "Event list", "type": "array", "items": { "name": "fulfillment_events", "description": "Event list", "type": "object", "properties": { "country": { "name": "country", "description": "Country", "type": "string", "example": "Canada" }, "update_at": { "name": "update_at", "description": "Update time ( format see ISO 8601 )", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "latitude": { "name": "latitude", "description": "Latitude", "type": "string", "example": "23.32947" }, "province": { "name": "province", "description": "Province", "type": "string", "example": "Ontario" }, "zip": { "name": "zip", "description": "Postal code", "type": "string", "example": "A1B 2C3" }, "city": { "name": "city", "description": "City", "type": "string", "example": "Ottawa" }, "address": { "name": "address", "description": "Address", "type": "string", "example": "126 York Street" }, "shop_id": { "name": "shop_id", "description": "store ID", "type": "string", "example": "1232244" }, "status": { "name": "status", "description": "Status ,Includes : label_printed、label_purchased、attempted_delivery、ready_for_pickup、picked_up、confirmed、in_transit、out_for_delivery、delivered、failure", "type": "string", "example": "label_printed" }, "order_id": { "name": "order_id", "description": "Order id", "type": "string", "example": "21056024607602932623437925" }, "message": { "name": "message", "description": "Notes", "type": "string", "example": "nothing" }, "id": { "name": "id", "description": "Event id", "type": "string", "example": "4206234611998187371524" }, "fulfillment_id": { "name": "fulfillment_id", "description": "fulfillment id", "type": "string", "example": "22060720884441337538627925" }, "longitude": { "name": "longitude", "description": "Longitude", "type": "string", "example": "113.301255" }, "create_at": { "name": "create_at", "description": "Create time ( format see ISO 8601 )", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "estimated_delivery_at": { "name": "estimated_delivery_at", "description": "Estimated delivery time ( format see ISO 8601 )", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "happened_at": { "name": "happened_at", "description": "Event duration ( format see ISO 8601 )", "type": "string", "example": "2021-08-16T08:27:57+00:00" } }, "example": { "country": "Canada", "happened_at": "2021-08-16T08:27:57+00:00", "shop_id": "1232244", "estimated_delivery_at": "2021-08-16T08:27:57+00:00", "latitude": "23.32947", "province": "Ontario", "longitude": "113.301255", "id": "4206234611998187371524", "fulfillment_id": "22060720884441337538627925", "update_at": "2021-08-16T08:27:57+00:00", "address": "126 York Street", "create_at": "2021-08-16T08:27:57+00:00", "message": "nothing", "city": "Ottawa", "status": "label_printed", "order_id": "21056024607602932623437925", "zip": "A1B 2C3" } }, "example": [ { "fulfillment_id": "22060720884441337538627925", "shop_id": "1232244", "latitude": "23.32947", "order_id": "21056024607602932623437925", "id": "4206234611998187371524", "message": "nothing", "update_at": "2021-08-16T08:27:57+00:00", "estimated_delivery_at": "2021-08-16T08:27:57+00:00", "country": "Canada", "province": "Ontario", "happened_at": "2021-08-16T08:27:57+00:00", "longitude": "113.301255", "status": "label_printed", "address": "126 York Street", "create_at": "2021-08-16T08:27:57+00:00", "zip": "A1B 2C3", "city": "Ottawa" } ] } }, "example": { "fulfillment_events": [ { "happened_at": "2021-08-16T08:27:57+00:00", "status": "label_printed", "shop_id": "1232244", "update_at": "2021-08-16T08:27:57+00:00", "id": "4206234611998187371524", "country": "Canada", "province": "Ontario", "order_id": "21056024607602932623437925", "estimated_delivery_at": "2021-08-16T08:27:57+00:00", "city": "Ottawa", "address": "126 York Street", "fulfillment_id": "22060720884441337538627925", "latitude": "23.32947", "create_at": "2021-08-16T08:27:57+00:00", "message": "nothing", "longitude": "113.301255", "zip": "A1B 2C3" } ] } } } } }, "401": { "headers": { "traceId": { "description": "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." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "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." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "get", "path": "/fulfillments/:order_id/:fulfillment_id/events/search.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`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` ." } } } ], "info": { "title": "Query fulfillment and delivery logistics events", "version": "v20270301" }, "authIndexes": [ "read_assigned_fulfillment_orders" ] } ```