事件分组事件标识
fulfillment_orderfulfillment_order/create
履约单创建事件
请求头
  • X-Shopline-Topic string required
    事件的唯一标识。
    例子: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    该请求的签名。收到请求后,你需要对该签名进行 验签 以验证数据的真实性和完整性。
    例子: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    店铺的域名。
    例子: example.myshopline.com
  • X-Shopline-Shop-Id string required
    店铺 ID。
    例子: 1610418123456
  • X-Shopline-Merchant-Id string required
    商家 ID。
    例子: 2000001234
  • X-Shopline-API-Version string required
    API 版本号。
    例子: v20250601
  • X-Shopline-Webhook-Id string required
    该 Webhook 事件的 ID。
    例子: b54557e48a5fbf7d70bcd043
请求体
  • fulfillment_orderobject
    履约详情
  • assigned_locationobject
    被分配的地点详情
  • address1 string
    地址1
    例子: "Chestnut Street 92"
  • address2 string
    地址2
    例子: "Chestnut Street 92"
  • city string
    城市
    例子: "Louisville"
  • country string
    国家
    例子: "United States"
  • country_code string
    国家码
    例子: "US"
  • location_id string
    地址id
    例子: "5327026538935748524"
  • name string
    名称
    例子: "Apple Api Shipwire"
  • phone string
    手机
    例子: "+1(502)-459-3417"
  • province string
    省份
    例子: "Kentucky"
  • zip string
    邮编
    例子: "40202"
  • assigned_location_id string
    被分配的地点id
    例子: "5327026538935748524"
  • created_at string
    履约单创建时间。格式:ISO 8601
  • delivery_methodobject
    履约单配送方式信息
  • max_delivery_date_time string
    最晚发货时间
    例子: "2021-05-26T10:00:00-04:00"
  • method_type string
    配送方式:local、none、pick_up、retail、shipping
    例子: "none"
  • min_delivery_date_time string
    可发货时间
    例子: "2021-05-26T10:00:00-04:00"
  • service_code string
    承运商运费方案编号。
  • shipping_rate_name string
    运费方案名称,当发货方式为 SHIPPINGLOCAL_DELIVERY,才有运费方案名称。
  • shipping_strategy_name string
    物流分组名称,当发货方式为 SHIPPINGLOCAL_DELIVERY,才有对应的值。
  • destinationobject
    收货人信息
  • address1 string
    地址1
    例子: "Chestnut Street 92"
  • address2 string
    地址2
    例子: "Chestnut Street 92"
  • city string
    城市
    例子: "Louisville"
  • company string
    公司
    例子: "Apple inc"
  • country string
    国家
    例子: "US"
  • country_code string
    国家码
    例子: "US"
  • delivery_store_code string
    本地配送门店id,仅本地配送时提供
    例子: "A121"
  • delivery_store_name string
    本地配送门店名称,仅本地配送时提供
    例子: "Napo Shop"
  • email string
    邮箱
    例子: "bob.norman@mail.example.com"
  • first_name string
    名称
    例子: "Bob"
  • last_name string
    姓氏
    例子: "Norman"
  • name string
    姓名
    例子: "Bob Norman"
  • phone string
    手机
    例子: "+1(502)-459-3417"
  • province string
    省份
    例子: "Kentucky"
  • province_code string
    州或是省编码,IOS 3166-2编码
    例子: "KY"
  • zip string
    邮编
    例子: "40202"
  • fulfillment_holdsobject[]
    暂停信息
  • reason string
    暂停原因
    例子: "out of stock"
  • reason_note string
    暂停备注
    例子: "customer require"
  • id string
    履约单id
    例子: "4005740193290131085320"
  • line_itemsobject[]
    商品行信息
  • country_code_of_origin string
    原产地/发货地的国家代码
    例子: "US"
  • fulfillable_quantity string
    可履约商品数量
    例子: 1
  • fulfillment_order_id string
    履约单id
    例子: "4005740193290131085320"
  • harmonized_system_code string
    海关编码
    例子: "121"
  • id string
    履约单商品行id
    例子: "1039283"
  • line_item_id string
    商品行id
    例子: "518995019"
  • quantity long
    订单商品行商品数量
    例子: 1
  • shop_id string
    店铺id
    例子: "1644828244663"
  • variant_id string
    商品sku
    例子: "18055128824718541486811487"
  • merchant_requestsobject[]
    请求发货信息列表
  • kind string
    请求类型: ① fulfillment_request ② cancellation_request
    例子: "fulfillment_request"
  • message string
    履约发货应用的备注
    例子: "accept"
  • request_optionsobject
    请求参数
  • notify_customer boolean
    是否通知客户
  • send_at string
    请求时间
    例子: "2021-05-26T10:00:00-04:00"
  • order_id string
    订单id
    例子: "21057401932826316666967110"
  • request_status string
    履约单请求状态,包括:accepted,cancellation_accepted,cancellation_rejected,cancellation_requested,closed,rejected,submitted,unsubmitted
    例子: "submitted"
  • shop_id string
    店铺id
    例子: "1644828244663"
  • status string
    履约单状态,包括:open,in_progress,closed,cancelled,incomplete,on_hold,scheduled
    例子: "open"
  • supported_actions array
    履约单支持的操作,包括:create_fulfillment -- 创建发货,move -- 移动到新地点,hold -- 暂停发货,release_hold -- (暂停之后)开始发货
    例子: ["\"release_hold\""]
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述
这篇文章对你有帮助吗?