--- title: "Fulfillment order update" description: "fulfillment order update" doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/webhook/order/fulfillment-order-update' md: 'https://developer.shopline.com/docs/webhook/order/fulfillment-order-update.md' --- # Fulfillment order update fulfillment order update - **API Version:** v20270301 - **API Type:** Webhook - **API Protocol:** RESTful ## Request ### Request Headers * `X-Shopline-Topic` string (required) The unique identifier for the event. * `X-Shopline-Hmac-Sha256` string (required) The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data. * `X-Shopline-Shop-Domain` string (required) The store domain. * `X-Shopline-Shop-Id` string (required) The store ID. * `X-Shopline-Merchant-Id` string (required) The merchant ID. * `X-Shopline-API-Version` string (required) The API version. * `X-Shopline-Webhook-Id` string (required) The ID of this Webhook event. ### Request Body * `fulfillment_order` object Performance details * `assigned_location` object Location details assigned * `address1` string Address 1 * `address2` string Address 2 * `city` string City * `country` string Country * `country_code` string Country code * `location_id` string Address ID * `name` string Name * `phone` string Mobile phone * `province` string Province * `zip` string Postal code * `assigned_location_id` string Assigned location id * `delivery_method` object Shipping method information for the order * `max_delivery_date_time` string Late delivery * `method_type` string Delivery method : local、none、pick_up、retail、shipping * `min_delivery_date_time` string Ship time available * `service_code` string Shipping plan code of the carrier. * `shipping_rate_name` string Name of the shipping rate, which is available only when the shipping method is `SHIPPING` or `LOCAL_DELIVERY`. * `shipping_strategy_name` string The name of the shipping strategy. It has a corresponding value only when the shipping method is `SHIPPING` or `LOCAL_DELIVERY`. * `destination` object Consignee information * `address1` string Address 1 * `address2` string Address 2 * `city` string City * `company` string Company * `country` string Country * `country_code` string Country code * `delivery_store_code` string Local delivery store id, provided only for local delivery * `delivery_store_name` string Local delivery store name, provided only for local delivery * `email` string Mailbox * `first_name` string Name * `last_name` string Last name * `name` string Name * `phone` string Mobile phone * `province` string Province * `province_code` string State or provincial encoding , IOS 3166-2 encoding * `zip` string Postal code * `fulfillment_holds` array Pause information * `reason` string Pause cause * `reason_note` string Pause notes * `id` string Performance order id * `line_items` array Product line information * `country_code_of_origin` string Country code of origin/shipping place * `fulfillable_quantity` string Available in approximately Product quantities * `fulfillment_order_id` string Performance order id * `harmonized_system_code` string Customs Code * `id` string Performance order Product line id * `line_item_id` string Product row id * `quantity` long Order Product line Product quantity * `shop_id` string store ID * `variant_id` string Product sku * `merchant_requests` array Request shipping information list * `kind` string Request type : 1 fulfillment_request 2 cancellation_request * `message` string Notes for the shipping application * `request_options` object Request parameters * `notify_customer` boolean Notify customers whether or not * `send_at` string Request time * `order_id` string Order id * `request_status` string Performance order request status, including: accepted, cancellation_accepted, cancellation_rejected, cancellation_requested, closed, rejected, submitted, unsubmitted * `shop_id` string store ID * `status` string Map order status , including : open , in_progress , closed , cancelled , incomplete , on_hold , scheduled * `supported_actions` array Operation supported by the appointment order includes : create_fulfillment -- created delivery , move -- moved to a new location , hold -- suspended delivery , release_hold -- ( after pause ) started delivery ## Response ### Status Codes * `200` After receiving a webhook notification from SHOPLINE, you must respond with the following format: ``` HTTP/1.1 200 OK ``` For more information about how to subscribe to webhooks and webhook response rules, refer to [Webhook overview](https://developer.shopline.com/docs/apps/api-instructions-for-use/webhooks/overview.md). ### Response Body #### 200 _No response body_ ## OpenAPI Definition ```json { "description": "fulfillment order update", "externalDocs": { "description": "| Event Group | Event Identification |\n| :------: | :------: |\n|fulfillment_order |fulfillment_order/update |\n", "url": "", "errorTableDescription": "" }, "operationId": "Ivfn5GLz", "parameters": [ { "name": "X-Shopline-Topic", "in": "header", "description": "The unique identifier for the event.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Topic", "description": "The unique identifier for the event.", "type": "string", "example": "orders/edited" }, "example": "orders/edited" }, { "name": "X-Shopline-Hmac-Sha256", "in": "header", "description": "The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Hmac-Sha256", "description": "The signature of the request. Upon receiving the request, you must [verify the signature](https://developer.shopline.com/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-requests) to confirm the authenticity and integrity of the data.", "type": "string", "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=" }, "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=" }, { "name": "X-Shopline-Shop-Domain", "in": "header", "description": "The store domain.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Shop-Domain", "description": "The store domain.", "type": "string", "example": "example.myshopline.com" }, "example": "example.myshopline.com" }, { "name": "X-Shopline-Shop-Id", "in": "header", "description": "The store ID.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Shop-Id", "description": "The store ID.", "type": "string", "example": "1610418123456" }, "example": "1610418123456" }, { "name": "X-Shopline-Merchant-Id", "in": "header", "description": "The merchant ID.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Merchant-Id", "description": "The merchant ID.", "type": "string", "example": "2000001234" }, "example": "2000001234" }, { "name": "X-Shopline-API-Version", "in": "header", "description": "The API version.", "required": true, "style": "string", "schema": { "name": "X-Shopline-API-Version", "description": "The API version.", "type": "string", "example": "v20250601" }, "example": "v20250601" }, { "name": "X-Shopline-Webhook-Id", "in": "header", "description": "The ID of this Webhook event.", "required": true, "style": "string", "schema": { "name": "X-Shopline-Webhook-Id", "description": "The ID of this Webhook event.", "type": "string", "example": "b54557e48a5fbf7d70bcd043" }, "example": "b54557e48a5fbf7d70bcd043" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fulfillment_order": { "name": "fulfillment_order", "description": "Performance details", "type": "object", "properties": { "assigned_location": { "name": "assigned_location", "description": "Location details assigned", "type": "object", "properties": { "address1": { "name": "address1", "description": "Address 1", "type": "string", "example": "\"Chestnut Street 92\"" }, "address2": { "name": "address2", "description": "Address 2", "type": "string", "example": "\"Chestnut Street 92\"" }, "city": { "name": "city", "description": "City", "type": "string", "example": "\"Louisville\"" }, "country": { "name": "country", "description": "Country", "type": "string", "example": "\"United States\"" }, "country_code": { "name": "country_code", "description": "Country code", "type": "string", "example": "\"US\"" }, "location_id": { "name": "location_id", "description": "Address ID", "type": "string", "example": "\"5327026538935748524\"" }, "name": { "name": "name", "description": "Name", "type": "string", "example": "\"Apple API Shipwire\"" }, "phone": { "name": "phone", "description": "Mobile phone", "type": "string", "example": "\"+1(502)-459-3417\"" }, "province": { "name": "province", "description": "Province", "type": "string", "example": "\"Kentucky\"" }, "zip": { "name": "zip", "description": "Postal code", "type": "string", "example": "\"40202\"" } }, "example": { "address1": "\"Chestnut Street 92\"", "address2": "\"Chestnut Street 92\"", "city": "\"Louisville\"", "country": "\"United States\"", "country_code": "\"US\"", "location_id": "\"5327026538935748524\"", "name": "\"Apple API Shipwire\"", "phone": "\"+1(502)-459-3417\"", "province": "\"Kentucky\"", "zip": "\"40202\"" } }, "assigned_location_id": { "name": "assigned_location_id", "description": "Assigned location id", "type": "string", "example": "\"5327026538935748524\"" }, "delivery_method": { "name": "delivery_method", "description": "Shipping method information for the order", "type": "object", "properties": { "max_delivery_date_time": { "name": "max_delivery_date_time", "description": "Late delivery", "type": "string", "example": "\"2021-05-26T10:00:00-04:00\"" }, "method_type": { "name": "method_type", "description": "Delivery method : local、none、pick_up、retail、shipping", "type": "string", "example": "\"none\"" }, "min_delivery_date_time": { "name": "min_delivery_date_time", "description": "Ship time available", "type": "string", "example": "\"2021-05-26T10:00:00-04:00\"" }, "service_code": { "name": "service_code", "description": "Shipping plan code of the carrier.", "type": "string", "example": "" }, "shipping_rate_name": { "name": "shipping_rate_name", "description": "Name of the shipping rate, which is available only when the shipping method is `SHIPPING` or `LOCAL_DELIVERY`.", "type": "string", "example": "" }, "shipping_strategy_name": { "name": "shipping_strategy_name", "description": "The name of the shipping strategy. It has a corresponding value only when the shipping method is `SHIPPING` or `LOCAL_DELIVERY`.", "type": "string", "example": "" } }, "example": { "max_delivery_date_time": "\"2021-05-26T10:00:00-04:00\"", "method_type": "\"none\"", "min_delivery_date_time": "\"2021-05-26T10:00:00-04:00\"", "service_code": "", "shipping_rate_name": "", "shipping_strategy_name": "" } }, "destination": { "name": "destination", "description": "Consignee information", "type": "object", "properties": { "address1": { "name": "address1", "description": "Address 1", "type": "string", "example": "\"Chestnut Street 92\"" }, "address2": { "name": "address2", "description": "Address 2", "type": "string", "example": "\"Chestnut Street 92\"" }, "city": { "name": "city", "description": "City", "type": "string", "example": "\"Louisville\"" }, "company": { "name": "company", "description": "Company", "type": "string", "example": "\"Apple inc\"" }, "country": { "name": "country", "description": "Country", "type": "string", "example": "\"US\"" }, "country_code": { "name": "country_code", "description": "Country code", "type": "string", "example": "\"US\"" }, "delivery_store_code": { "name": "delivery_store_code", "description": "Local delivery store id, provided only for local delivery", "type": "string", "example": "\"A121\"" }, "delivery_store_name": { "name": "delivery_store_name", "description": "Local delivery store name, provided only for local delivery", "type": "string", "example": "\"Napo Shop\"" }, "email": { "name": "email", "description": "Mailbox", "type": "string", "example": "\"bob.norman@mail.example.com\"" }, "first_name": { "name": "first_name", "description": "Name", "type": "string", "example": "\"Bob\"" }, "last_name": { "name": "last_name", "description": "Last name", "type": "string", "example": "\"Norman\"" }, "name": { "name": "name", "description": "Name", "type": "string", "example": "\"Bob Norman\"" }, "phone": { "name": "phone", "description": "Mobile phone", "type": "string", "example": "\"+1(502)-459-3417\"" }, "province": { "name": "province", "description": "Province", "type": "string", "example": "\"Kentucky\"" }, "province_code": { "name": "province_code", "description": "State or provincial encoding , IOS 3166-2 encoding", "type": "string", "example": "\"KY\"" }, "zip": { "name": "zip", "description": "Postal code", "type": "string", "example": "\"40202\"" } }, "example": { "address1": "\"Chestnut Street 92\"", "address2": "\"Chestnut Street 92\"", "city": "\"Louisville\"", "company": "\"Apple inc\"", "country": "\"US\"", "country_code": "\"US\"", "delivery_store_code": "\"A121\"", "delivery_store_name": "\"Napo Shop\"", "email": "\"bob.norman@mail.example.com\"", "first_name": "\"Bob\"", "last_name": "\"Norman\"", "name": "\"Bob Norman\"", "phone": "\"+1(502)-459-3417\"", "province": "\"Kentucky\"", "province_code": "\"KY\"", "zip": "\"40202\"" } }, "fulfillment_holds": { "name": "fulfillment_holds", "description": "Pause information", "type": "array", "items": { "name": "fulfillment_holds", "description": "Pause information", "type": "object", "properties": { "reason": { "name": "reason", "description": "Pause cause", "type": "string", "example": "\"out of stock\"" }, "reason_note": { "name": "reason_note", "description": "Pause notes", "type": "string", "example": "\"customer require\"" } }, "example": { "reason": "\"out of stock\"", "reason_note": "\"customer require\"" } }, "example": [ "" ] }, "id": { "name": "id", "description": "Performance order id", "type": "string", "example": "\"4005740193290131085320\"" }, "line_items": { "name": "line_items", "description": "Product line information", "type": "array", "items": { "name": "line_items", "description": "Product line information", "type": "object", "properties": { "country_code_of_origin": { "name": "country_code_of_origin", "description": "Country code of origin/shipping place", "type": "string", "example": "\"US\"" }, "fulfillable_quantity": { "name": "fulfillable_quantity", "description": "Available in approximately Product quantities", "type": "string", "example": "1" }, "fulfillment_order_id": { "name": "fulfillment_order_id", "description": "Performance order id", "type": "string", "example": "\"4005740193290131085320\"" }, "harmonized_system_code": { "name": "harmonized_system_code", "description": "Customs Code", "type": "string", "example": "\"1231\"" }, "id": { "name": "id", "description": "Performance order Product line id", "type": "string", "example": "\"1039283\"" }, "line_item_id": { "name": "line_item_id", "description": "Product row id", "type": "string", "example": "\"518995019\"" }, "quantity": { "name": "quantity", "description": "Order Product line Product quantity", "type": "long", "example": 1 }, "shop_id": { "name": "shop_id", "description": "store ID", "type": "string", "example": "\"1644828244663\"" }, "variant_id": { "name": "variant_id", "description": "Product sku", "type": "string", "example": "\"18055128824718541486811487\"" } }, "example": { "country_code_of_origin": "\"US\"", "fulfillable_quantity": "1", "fulfillment_order_id": "\"4005740193290131085320\"", "harmonized_system_code": "\"1231\"", "id": "\"1039283\"", "line_item_id": "\"518995019\"", "quantity": 1, "shop_id": "\"1644828244663\"", "variant_id": "\"18055128824718541486811487\"" } }, "example": [ "" ] }, "merchant_requests": { "name": "merchant_requests", "description": "Request shipping information list", "type": "array", "items": { "name": "merchant_requests", "description": "Request shipping information list", "type": "object", "properties": { "kind": { "name": "kind", "description": "Request type : 1 fulfillment_request 2 cancellation_request", "type": "string", "example": "\"fulfillment_request\"" }, "message": { "name": "message", "description": "Notes for the shipping application", "type": "string", "example": "\"accept\"" }, "request_options": { "name": "request_options", "description": "Request parameters", "type": "object", "properties": { "notify_customer": { "name": "notify_customer", "description": "Notify customers whether or not", "type": "boolean", "example": false } }, "example": { "notify_customer": false } }, "send_at": { "name": "send_at", "description": "Request time", "type": "string", "example": "\"2021-05-26T10:00:00-04:00\"" } }, "example": { "kind": "\"fulfillment_request\"", "message": "\"accept\"", "request_options": { "notify_customer": false }, "send_at": "\"2021-05-26T10:00:00-04:00\"" } }, "example": [ "" ] }, "order_id": { "name": "order_id", "description": "Order id", "type": "string", "example": "\"21057401932826316666967110\"" }, "request_status": { "name": "request_status", "description": "Performance order request status, including: accepted, cancellation_accepted, cancellation_rejected, cancellation_requested, closed, rejected, submitted, unsubmitted", "type": "string", "example": "\"submitted\"" }, "shop_id": { "name": "shop_id", "description": "store ID", "type": "string", "example": "\"1644828244663\"" }, "status": { "name": "status", "description": "Map order status , including : open , in_progress , closed , cancelled , incomplete , on_hold , scheduled", "type": "string", "example": "\"open\"" }, "supported_actions": { "name": "supported_actions", "description": "Operation supported by the appointment order includes : create_fulfillment -- created delivery , move -- moved to a new location , hold -- suspended delivery , release_hold -- ( after pause ) started delivery", "type": "array", "items": { "name": "supported_actions", "description": "Operation supported by the appointment order includes : create_fulfillment -- created delivery , move -- moved to a new location , hold -- suspended delivery , release_hold -- ( after pause ) started delivery", "type": "string", "example": "\"release_hold\"" }, "example": [ "\"release_hold\"" ] } }, "example": { "assigned_location": { "address1": "\"Chestnut Street 92\"", "address2": "\"Chestnut Street 92\"", "city": "\"Louisville\"", "country": "\"United States\"", "country_code": "\"US\"", "location_id": "\"5327026538935748524\"", "name": "\"Apple API Shipwire\"", "phone": "\"+1(502)-459-3417\"", "province": "\"Kentucky\"", "zip": "\"40202\"" }, "assigned_location_id": "\"5327026538935748524\"", "delivery_method": { "max_delivery_date_time": "\"2021-05-26T10:00:00-04:00\"", "method_type": "\"none\"", "min_delivery_date_time": "\"2021-05-26T10:00:00-04:00\"", "service_code": "", "shipping_rate_name": "", "shipping_strategy_name": "" }, "destination": { "address1": "\"Chestnut Street 92\"", "address2": "\"Chestnut Street 92\"", "city": "\"Louisville\"", "company": "\"Apple inc\"", "country": "\"US\"", "country_code": "\"US\"", "delivery_store_code": "\"A121\"", "delivery_store_name": "\"Napo Shop\"", "email": "\"bob.norman@mail.example.com\"", "first_name": "\"Bob\"", "last_name": "\"Norman\"", "name": "\"Bob Norman\"", "phone": "\"+1(502)-459-3417\"", "province": "\"Kentucky\"", "province_code": "\"KY\"", "zip": "\"40202\"" }, "fulfillment_holds": [ "" ], "id": "\"4005740193290131085320\"", "line_items": [ "" ], "merchant_requests": [ "" ], "order_id": "\"21057401932826316666967110\"", "request_status": "\"submitted\"", "shop_id": "\"1644828244663\"", "status": "\"open\"", "supported_actions": [ "\"release_hold\"" ] } } }, "example": { "fulfillment_order": { "assigned_location": { "address1": "\"Chestnut Street 92\"", "address2": "\"Chestnut Street 92\"", "city": "\"Louisville\"", "country": "\"United States\"", "country_code": "\"US\"", "location_id": "\"5327026538935748524\"", "name": "\"Apple API Shipwire\"", "phone": "\"+1(502)-459-3417\"", "province": "\"Kentucky\"", "zip": "\"40202\"" }, "assigned_location_id": "\"5327026538935748524\"", "delivery_method": { "max_delivery_date_time": "\"2021-05-26T10:00:00-04:00\"", "method_type": "\"none\"", "min_delivery_date_time": "\"2021-05-26T10:00:00-04:00\"", "service_code": "", "shipping_rate_name": "", "shipping_strategy_name": "" }, "destination": { "address1": "\"Chestnut Street 92\"", "address2": "\"Chestnut Street 92\"", "city": "\"Louisville\"", "company": "\"Apple inc\"", "country": "\"US\"", "country_code": "\"US\"", "delivery_store_code": "\"A121\"", "delivery_store_name": "\"Napo Shop\"", "email": "\"bob.norman@mail.example.com\"", "first_name": "\"Bob\"", "last_name": "\"Norman\"", "name": "\"Bob Norman\"", "phone": "\"+1(502)-459-3417\"", "province": "\"Kentucky\"", "province_code": "\"KY\"", "zip": "\"40202\"" }, "fulfillment_holds": [ "" ], "id": "\"4005740193290131085320\"", "line_items": [ "" ], "merchant_requests": [ "" ], "order_id": "\"21057401932826316666967110\"", "request_status": "\"submitted\"", "shop_id": "\"1644828244663\"", "status": "\"open\"", "supported_actions": [ "\"release_hold\"" ] } } } } }, "required": true }, "responses": { "200": { "description": "After receiving a webhook notification from SHOPLINE, you must respond with the following format: \n\n``` HTTP/1.1 200 OK ```\n\nFor more information about how to subscribe to webhooks and webhook response rules, refer to [Webhook overview](https://developer.shopline.com/docs/apps/api-instructions-for-use/webhooks/overview.md)." } }, "info": { "title": "Fulfillment order update", "version": "v20270301" } } ```