结账创建

事件分组事件标识
checkoutscheckouts/create
当结账页被创建时触发。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • 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
请求体
  • abandoned_checkout_url string
    可以进入结账页面的链接。
    例子: https://example.myshopline.com/trade/checkouts/c2c4a7b0c586a273f781c271f6a1b6f6?mark=345B5E216A2080FBA20456099D2B8468A895199B21CA87BAE83141EF693C0033
  • applied_discountsobject[]
    应用在整单级别的折扣或活动。
  • amount string
    折扣的金额，数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8.00
  • application_type string
    折扣类型，有效枚举值包括：
    • MANUAL_DISCOUNT：手动折扣
    • FULL_DISCOUNT：满减满折、免邮
    • TIME_LIMITED：限时促销
    • BUNDLED：捆绑组合
    • DISCOUNT_CODE：优惠码
    • GIFT：赠品活动
    • PRE_ORDER：预售
  • target_selection string
    折扣范围。有效枚举值包括：
    • explicit：单个商品维度的折扣
    • entitled：整个商品行维度的折扣
    • all：若 target_type 为 line_item，折扣适用于整单；若 target_type 为 shipping_line，折扣适用于运费
  • target_type string
    折扣适用的类型，有效枚举值包括：
    • line_item：在商品行应用的折扣
    • shipping_line：在运费中应用的折扣
  • title string
    折扣活动的标题。
  • value string
    折扣的具体值。
    • 当 value_type 为 fix_amount 时，此字段值表示特定的折扣金额。例如，如果值为 10，币种为人民币，则表示折扣为 10 元。
    • 当 value_type 为 percentage 时，此字段值的值表示特定的折扣百分比。例如，10 表示订单金额的 10% 折扣。
  • value_type string
    折扣值的类型。有效枚举值包含：
    • fix_amount：固定金额折扣。例如，如果 value 为 10，则意味着折扣为 10 元。
    • percentage：百分比折扣。例如，如果 value 为 10，则表示订单金额的 10% 折扣。
  • billing_addressobject
    用于邮寄账单发票的地址。
  • address1 string
    账单地址的第一行。通常是街道地址或邮政信箱编号等信息。
  • address2 string
    账单地址的第二行。通常是公寓、套房或单元等信息。
  • city string
    账单地址中的城市。
    例子: New York
  • country string
    账单地址中的国家或区域。
    例子: USA
  • country_code string
    账单地址中国家或地区的二位码，遵循 ISO 3166-1国际标准。
    例子: US
  • first_name string
    账单收件人的名。
  • last_name string
    账单收件人的姓。
  • name string
    账单收件人的全名。
  • phone string
    账单收件人的手机号码。
  • province string
    账单地址中的省份。
    例子: California
  • province_code string
    账单地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
    例子: 4200006
  • zip string
    账单地址的邮编信息。
  • buyer_accepts_marketing boolean
    买家是否订阅优惠及订单更新信息。
    • true：订阅
    • false：不订阅
  • cart_token string
    购物车数据的唯一凭证。
    例子: c4a54360f2b2460fbb6973bb80406111
  • closed_at string
    结账关闭时间。格式：ISO 8601。关闭流程包含以下两种方式：
    • 自动关闭：若 60 天内未完成订单，系统将自动关闭该弃单。
    • 订单生成：通过该弃单生成订单时，将触发关闭操作。
    例子: 2024-08-31T02:20:26+08:00
  • completed_at string
    结账完成时间。格式：ISO 8601。
    例子: 2024-08-31T02:20:26+08:00
  • created_at string
    结账创建时间。格式：ISO 8601。
    例子: 2024-08-31T02:20:26+08:00
  • currency string
    三位币种码，以店铺币种展示，遵循 ISO 4217 国际标准。
    例子: USD
  • customerobject
    买家信息。
  • addressesobject
    买家地址信息。
  • address1 string
    买家地址的第一行。通常是街道地址或邮政信箱编号等信息。
  • address2 string
    买家地址的第二行。通常是公寓、套房或单元等信息。
  • city string
    买家地址中的城市。
    例子: New York
  • country string
    买家地址中的国家或区域。
    例子: USA
  • country_code string
    买家地址中国家或地区的二位码，遵循 ISO 3166-1国际标准。
    例子: US
  • first_name string
    买家地址中收件人的名。
  • last_name string
    买家地址中收件人的姓。
  • name string
    买家地址中收件人的全名。
  • phone string
    买家地址中收件人的手机号码。
  • province string
    买家地址中的省份。
    例子: California
  • province_code string
    买家地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
    例子: 4200006
  • zip string
    地址的邮编信息。
    例子: 92503
  • currency string
    三位币种码，以店铺币种展示，遵循 ISO 4217 国际标准。
    例子: USD
  • email string
    买家的邮箱地址。
    例子: example@example.com
  • first_name string
    买家的名。
  • id string
    买家 ID。
    例子: 4201057495
  • last_name string
    买家的姓。
  • phone string
    买家的手机号码。
  • discount_codesobject[]
    折扣码信息列表。
  • amount double
    折扣码优惠金额，数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8
  • title string
    折扣码活动的标题。
  • type integer
    折扣码优惠类型，有效枚举值包括：
    • 1：减金额
    • 2：打折
    • 3：免运费
    • 4：加价品
    • 5：任意 N 件优惠价
    • 6：A+B 组合优惠价
    • 7：赠品
    • 8：固定售价
    • 9：最低价商品免费
    • 10：打包价
    • 11：第 N 件打折
    • 12：买 X 送 Y
    • 13：自定义
  • email string
    用户联系邮箱。
    例子: email@example.cpm
  • id string
    结账的唯一凭证。
    例子: c2c4a7b1e182e894f6e194a99489f870
  • line_itemsobject[]
    结账商品信息列表。
  • applied_discountsobject[]
    应用在商品行级别的折扣或活动。
  • amount string
    折扣的金额，数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8.00
  • application_type string
    折扣类型，有效枚举值包括：
    • MANUAL_DISCOUNT：手动折扣
    • FULL_DISCOUNT：满减满折、免邮
    • TIME_LIMITED：限时促销
    • BUNDLED：捆绑组合
    • DISCOUNT_CODE：优惠码
    • GIFT：赠品活动
    • PRE_ORDER：预售
  • target_selection string
    折扣范围。有效枚举值包括：
    • explicit：单个商品维度的折扣
    • entitled：整个商品行维度的折扣
    • all：若 target_type 为 line_item，折扣适用于整单；若 target_type 为 shipping_line，折扣适用于运费
  • target_type string
    折扣适用的对象。有效枚举值包括：
    • line_item：在商品行应用的折扣
    • shipping_line：在运费中应用的折扣
  • title string
    折扣活动的标题。
  • value string
    折扣的具体值。
    • 当 value_type 为 fix_amount 时，此字段值表示特定的折扣金额。例如，如果值为 10，币种为人民币，则表示折扣为 10 元。
    • 当 value_type 为 percentage 时，此字段值的值表示特定的折扣百分比。例如，10 表示订单金额的 10% 折扣。
  • value_type string
    折扣值的类型。有效枚举值包含：
    • fix_amount：固定金额折扣。例如，如果 value 为 10，则意味着折扣为 10 元。
    • percentage：百分比折扣。例如，如果 value 为 10，则表示订单金额的 10% 折扣。
  • gift_card boolean
    是否为礼品卡商品。
    • true：是礼品卡商品
    • false：不是礼品卡商品
  • grams double
    重量，单位：g。
    例子: 100
  • line_price double
    行价格。商品售价乘数量后的金额。数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
  • presentment_title string
    当前商品标题。
  • price double
    商品售价，数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8
  • product_id string
    商品的唯一标识符 ID。
    例子: 16060214426601453066501487
  • propertiesobject[]
    商品定制信息列表。
  • name string
    自定义属性名称。
  • show boolean
    定制信息是否可见。
    • true：信息可见
    • false：信息不可见
  • urls array
    URL 列表。
    • 如果 type 是 picture，可通过 urls 获取缩略图。
    • 如果 type 是 link，那么超链接为 urls 的第一个。
  • value string
    自定义属性值。
  • quantity integer
    订单中的商品数量。
  • requires_shipping boolean
    商品是否需要发货。
    • true：需要发货
    • false：不需要发货
  • sku string
    商品 SKU 序列号。
    例子: 18065562457702740835053185
  • tax_linesobject[]
    税费明细列表。
  • price double
    税费，数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8
  • tax_no string
    税号。
    例子: 385642
  • title string
    税费说明标题。该信息只做展示作用。
  • type string
    订单的税费类型。有效枚举值包含：
    • product_tax：商品税
    • shipping_tax：运费税
    • duty_tax：关税
  • taxable boolean
    该商品是否需要收税。
    • true：需要收税
    • false：不需要收税
  • title string
    商品标题。
  • user_id string
    买家 ID。
    例子: 4603327877
  • variant_id string
    款式的唯一标识 ID。
  • variant_price double
    商品售价，数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8
  • name string
    由 # 与结账的唯一凭证拼接而成的字符串。
    例子: #c2c4a7b1e182e894f6e194a99489f870
  • note string
    买家备注。
  • note_attributesobject[]
    商家附加在结账上的信息。
  • name string
    自定义属性名称。
  • value string
    自定义属性值。
  • phone string
    用户联系手机号。
  • phone_area_code string
    国家或地区的手机区号。
    例子: +1
  • presentment_currency string
    当前结账币种。如果商家设置了多市场币种则为结账对应市场币种，否则为店铺币种。三位币种码，遵循 ISO 4217 国际标准。
    例子: USD
  • shipping_addressobject
    收货地址。
  • address1 string
    地址的第一行。通常是街道地址或邮政信箱编号等信息。
  • address2 string
    地址的第二行。通常是公寓、套房或单元等信息。
  • city string
    地址中的城市。
    例子: New York
  • country string
    地址中的国家或区域。
    例子: USA
  • country_code string
    地址中国家或地区的二位码，遵循 ISO 3166-1国际标准。
    例子: US
  • first_name string
    收件人的名。
  • last_name string
    收件人的姓。
  • name string
    收件人的全名。
  • phone string
    收件人的手机号码。
  • province string
    地址中的省份。
    例子: California
  • province_code string
    地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
    例子: 4200006
  • zip string
    地址的邮编信息。
    例子: 92503
  • shipping_linesobject[]
    运费列表。
  • code string
    只有本地配送运费方案有值，返回 Local delivery。
  • delivery_name string
    运费方案名称。
  • delivery_seq string
    送货方式 ID。
    例子: DP7026099381353365514
  • logistics_amount double
    运费金额。数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8
  • phone string
    买家的手机号。
  • sub_total_price double
    商品优惠后的金额。数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8
  • taxes_included boolean
    该订单是否包含税费金额。
    • true：包含税费金额
    • false：不包含税费金额
  • token string
    结账的唯一凭证。
    例子: c2c4a7b1e182e894f6e194a99489f870
  • total_discount double
    折扣总金额。数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
  • total_duties string
    总关税。数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8.00
  • total_price double
    打折后的订单总金额，包括运费和税费。数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
  • total_tax double
    订单总税费金额。数值保留到小数点后两位，以 presentment_currency 对应的币种展示。
    例子: 8
  • total_weight double
    商品总重量，单位：g。
  • update_at string
    结账更新时间。格式：ISO 8601。
    例子: 2024-08-31T02:20:26+08:00
  • user_id string
    买家 ID。
    例子: 4603327877
状态码
收到 SHOPLINE 发送的 Webhook 通知后，你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明，请参考 Webhook 概述。
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.