---
title: "履约提交请求"
description: "履约提交请求"
doc_type: openapi
doc_category: openapi
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/zh-hans-cn/docs/webhook/order/submit-request-for-fulfillment'
  md: 'https://developer.shopline.com/zh-hans-cn/docs/webhook/order/submit-request-for-fulfillment.md'
---
# 履约提交请求

履约提交请求

- **API Version:** v20270301
- **API Type:** Webhook
- **API Protocol:** RESTful

## Request

### Request Headers

* `X-Shopline-Topic`

  string (required)

  事件的唯一标识。

* `X-Shopline-Hmac-Sha256`

  string (required)

  该请求的签名。收到请求后，你需要对该签名进行 [验签](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-请求操作步骤) 以验证数据的真实性和完整性。

* `X-Shopline-Shop-Domain`

  string (required)

  店铺的域名。

* `X-Shopline-Shop-Id`

  string (required)

  店铺 ID。

* `X-Shopline-Merchant-Id`

  string (required)

  商家 ID。

* `X-Shopline-API-Version`

  string (required)

  API 版本号。

* `X-Shopline-Webhook-Id`

  string (required)

  该 Webhook 事件的 ID。

### Request Body

* `fulfillment_order_merchant_request`

  object

  履约请求参数

  * `message`

    string

    备注

  * `notify_customer`

    boolean

    是否通知客户

* `original_fulfillment_order`

  object

  原履约单信息

  * `id`

    string

    标识id

  * `requestStatus`

    string

    请求状态

  * `status`

    string

    履约状态

* `submitted_fulfillment_order`

  object

  履约单信息

  * `id`

    string

    标识id

  * `request_status`

    string

    请求状态

  * `status`

    string

    履约状态

## Response

### Status Codes

* `200`

  收到 SHOPLINE 发送的 Webhook 通知后，你需要按照如下 SHOPLINE 要求的格式进行响应。
  
  ``` HTTP/1.1 200 OK ``` 
  
  关于如何订阅 Webhooks 及更多 Webhook 响应规则说明，请参考 [Webhook 概述](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/webhooks/overview.md)。

### Response Body

#### 200

_No response body_

## OpenAPI Definition

```json
{
  "description": "履约提交请求",
  "externalDocs": {
    "description": "| 事件分组 | 事件标识 |\n| :------: | :------: |\n|fulfillment_order        |fulfillment_order/submitted        |\n",
    "url": "",
    "errorTableDescription": ""
  },
  "operationId": "mec0nQg6",
  "parameters": [
    {
      "name": "X-Shopline-Topic",
      "in": "header",
      "description": "事件的唯一标识。",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Topic",
        "description": "事件的唯一标识。",
        "type": "string",
        "example": "orders/edited"
      },
      "example": "orders/edited"
    },
    {
      "name": "X-Shopline-Hmac-Sha256",
      "in": "header",
      "description": "该请求的签名。收到请求后，你需要对该签名进行 [验签](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-请求操作步骤) 以验证数据的真实性和完整性。",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Hmac-Sha256",
        "description": "该请求的签名。收到请求后，你需要对该签名进行 [验签](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/generate-and-verify-signatures.md#post-请求操作步骤) 以验证数据的真实性和完整性。",
        "type": "string",
        "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM="
      },
      "example": "XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM="
    },
    {
      "name": "X-Shopline-Shop-Domain",
      "in": "header",
      "description": "店铺的域名。",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Shop-Domain",
        "description": "店铺的域名。",
        "type": "string",
        "example": "example.myshopline.com"
      },
      "example": "example.myshopline.com"
    },
    {
      "name": "X-Shopline-Shop-Id",
      "in": "header",
      "description": "店铺 ID。",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Shop-Id",
        "description": "店铺 ID。",
        "type": "string",
        "example": "1610418123456"
      },
      "example": "1610418123456"
    },
    {
      "name": "X-Shopline-Merchant-Id",
      "in": "header",
      "description": "商家 ID。",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Merchant-Id",
        "description": "商家 ID。",
        "type": "string",
        "example": "2000001234"
      },
      "example": "2000001234"
    },
    {
      "name": "X-Shopline-API-Version",
      "in": "header",
      "description": "API 版本号。",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-API-Version",
        "description": "API 版本号。",
        "type": "string",
        "example": "v20250601"
      },
      "example": "v20250601"
    },
    {
      "name": "X-Shopline-Webhook-Id",
      "in": "header",
      "description": "该 Webhook 事件的 ID。",
      "required": true,
      "style": "string",
      "schema": {
        "name": "X-Shopline-Webhook-Id",
        "description": "该 Webhook 事件的 ID。",
        "type": "string",
        "example": "b54557e48a5fbf7d70bcd043"
      },
      "example": "b54557e48a5fbf7d70bcd043"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "fulfillment_order_merchant_request": {
              "name": "fulfillment_order_merchant_request",
              "description": "履约请求参数",
              "type": "object",
              "properties": {
                "message": {
                  "name": "message",
                  "description": "备注",
                  "type": "string",
                  "example": "\"Fragile\""
                },
                "notify_customer": {
                  "name": "notify_customer",
                  "description": "是否通知客户",
                  "type": "boolean",
                  "example": true
                }
              },
              "example": {
                "message": "\"Fragile\"",
                "notify_customer": true
              }
            },
            "original_fulfillment_order": {
              "name": "original_fulfillment_order",
              "description": "原履约单信息",
              "type": "object",
              "properties": {
                "id": {
                  "name": "id",
                  "description": "标识id",
                  "type": "string",
                  "example": "\"21057401932826316666967110_4005740193290131085320\""
                },
                "requestStatus": {
                  "name": "requestStatus",
                  "description": "请求状态",
                  "type": "string",
                  "example": "\"unsubmitted\""
                },
                "status": {
                  "name": "status",
                  "description": "履约状态",
                  "type": "string",
                  "example": "\"open\""
                }
              },
              "example": {
                "id": "\"21057401932826316666967110_4005740193290131085320\"",
                "requestStatus": "\"unsubmitted\"",
                "status": "\"open\""
              }
            },
            "submitted_fulfillment_order": {
              "name": "submitted_fulfillment_order",
              "description": "履约单信息",
              "type": "object",
              "properties": {
                "id": {
                  "name": "id",
                  "description": "标识id",
                  "type": "string",
                  "example": "\"21057401932826316666967110_4005740193290131085320\""
                },
                "request_status": {
                  "name": "request_status",
                  "description": "请求状态",
                  "type": "string",
                  "example": "\"submitted\""
                },
                "status": {
                  "name": "status",
                  "description": "履约状态",
                  "type": "string",
                  "example": "\"open\""
                }
              },
              "example": {
                "id": "\"21057401932826316666967110_4005740193290131085320\"",
                "request_status": "\"submitted\"",
                "status": "\"open\""
              }
            }
          },
          "example": {
            "fulfillment_order_merchant_request": {
              "message": "\"Fragile\"",
              "notify_customer": true
            },
            "original_fulfillment_order": {
              "id": "\"21057401932826316666967110_4005740193290131085320\"",
              "requestStatus": "\"unsubmitted\"",
              "status": "\"open\""
            },
            "submitted_fulfillment_order": {
              "id": "\"21057401932826316666967110_4005740193290131085320\"",
              "request_status": "\"submitted\"",
              "status": "\"open\""
            }
          }
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "收到 SHOPLINE 发送的 Webhook 通知后，你需要按照如下 SHOPLINE 要求的格式进行响应。\n\n``` HTTP/1.1 200 OK ``` \n\n关于如何订阅 Webhooks 及更多 Webhook 响应规则说明，请参考 [Webhook 概述](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/webhooks/overview.md)。"
    }
  },
  "info": {
    "title": "履约提交请求",
    "version": "v20270301"
  }
}
```