跳到主要内容
版本:202607

标记订单支付成功

POST 

/openapi/2026-07/orders/:order_id/payment/success

完成订单支付并将订单状态更新为支付成功。

用法:

  1. 不传任何参数:走默认测试支付(bogus),模拟订单支付完成
  2. 仅传 payment_line:指定真实支付渠道 示例:{"payment_line":{"payment_channel":"stripe","payment_method":"credit_card","transaction_no":"txn_xxx"}}
  3. 仅传 gateway:自定义支付方式(如线下转账等) 示例:{"gateway":"bank_transfer"}
  4. 同时传 gateway + payment_line:真实渠道走 payment_line,显示名用 gateway 自定义 示例:{"gateway":"My Custom Name","payment_line":{"payment_channel":"stripe","payment_method":"credit_card","transaction_no":"txn_xxx"}}

请求

Path参数

    order_id string必填

    订单 ID

请求体必填

    billing_address object

    账单地址详情。若未提供,则保留原有账单地址不变

    first_namestring

    last_namestring

    emailstring

    电子邮件地址

    countrystring

    国家名称

    country_codestring

    国家代码(如 CN)

    provincestring

    省份或州

    province_codestring

    省份代码

    areastring

    地区或区域

    citystring

    城市

    addressstring

    地址

    address1string

    主要地址行

    companystring

    公司名称

    longitudestring

    经度坐标

    latitudestring

    纬度坐标

    zipstring

    邮政编码

    sourcestring

    首次访问落地页

    tagsstring

    标签列表

    phonestring

    电话号码

    phone_area_codestring

    电话号码区号

    gatewaystring

    支付网关名称,可用于自定义支付网关名称,参考接口用法说明

    payment_line object

    支付行。指定实际的支付渠道、支付方式和交易号。

    payment_methodstring必填

    订单的支付方式(如 credit_card)。使用店铺已有的支付方式完成订单,参考接口用法说明

    payment_channelstring必填

    订单的支付渠道(收单机构/网关,如 stripe、paypal)。使用店铺已有的支付方式完成订单,参考接口用法说明

    transaction_nostring必填

    支付的交易号

    credit_card_numberstring

    信用卡号

    payment_lines object[]

    支付行列表

  • Array [
  • payment_methodstring必填

    订单的支付方式(如 credit_card)。使用店铺已有的支付方式完成订单,参考接口用法说明

    payment_channelstring必填

    订单的支付渠道(收单机构/网关,如 stripe、paypal)。使用店铺已有的支付方式完成订单,参考接口用法说明

    transaction_nostring必填

    支付的交易号

    credit_card_numberstring

    信用卡号

  • ]

响应

OK

数据结构
    codestring

    错误码

    messagestring

    错误信息

    data object
    order object

    订单

    idstring

    订单 ID

    created_atstring

    订单创建时间(如 2018-11-02T12:30:10Z)

    updated_atstring

    订单更新时间(如 2018-11-02T12:30:10Z)

    notestring

    商家针对该订单输入的自定义备注

    numberstring

    订单号

    total_pricestring

    顾客支付的最终金额,包含税费、折扣、小费、附加费和运费

    sub_totalstring

    订单中所有商品行的价格总和 若 order.config.product_tax_included 为 true,则含税(不含运费税);否则不含税。 计算公式:sub_total = sum(line_item.price * line_item.quantity)。

    currencystring

    订单的货币代码

    financial_statusstring

    订单的支付状态:

    • waiting: 待支付
    • paying: 支付审核中
    • authorized: 已授权
    • partially_paid: 部分支付
    • paid: 已支付
    • cancelled: 已取消
    • failed: 支付失败
    • refunding: 退款中
    • refund_failed: 退款失败
    • refunded: 已全退
    • partially_refunded: 部分退
    statusstring

    订单状态:

    • opened: 待支付
    • cancelled: 已取消
    • placed: 进行中
    • finished: 已完成
    cancelled_atstring

    订单取消时间

    cancel_reasonstring

    订单取消原因

    payment_methodstring

    订单使用的支付方式(如 apple_pay、credit_card、online)

    fulfillment_statusstring

    订单物流状态:

    • initialled: 初始
    • waiting: 待发货
    • partially_shipped: 部分发货
    • shipped: 全部发货
    • partially_finished: 部分收货
    • finished: 全部收货
    • cancelled: 已取消
    • returning: 退货中
    • partially_returned: 部分退货
    • returned: 全部退货
    customer_deleted_atstring

    订单关联顾客的删除时间

    deleted_atstring

    订单删除时间

    placed_atstring

    订单支付时间

    tagsstring

    商家或系统为订单添加的自定义标签

    buyer_accepts_marketingboolean

    顾客是否同意接收营销推广信息

    code_discount_totalstring

    订单中折扣码带来的总折扣金额

    customer_notestring

    顾客在结账时填写的备注信息

    total_discountstring

    订单总折扣金额,包含商品折扣、运费折扣和支付折扣

    total_taxstring

    订单商品税总额,不含运费税

    total_shippingstring

    订单总运费

    line_items object[]

    购买商品列表

  • Array [
  • idstring

    订单商品项 ID

    product_idstring

    商品 ID

    product_titlestring

    已购商品名称

    variant_idstring

    子款式 ID

    variant_titlestring

    子款式标题,例如 Blue, Size M

    quantityuint32

    已购该商品的数量

    notestring

    订单商品项的商品备注

    image object

    商品图片

    srcstring

    图片来源 URL

    widthint32

    图片宽度(像素)

    heightint32

    图片高度(像素)

    altstring

    图片替代文本

    pricestring

    售价

    compare_at_pricestring

    划线价

    total_pricestring

    总价

    fulfillment_statusstring

    订单商品项的履约状态,例如 fulfilled(已履约)、unfulfilled(未履约);详见履约状态文档

    skustring

    SKU

    weightstring

    商品重量

    weight_unitstring

    商品重量的计量单位,例如 kglbs

    vendorstring

    商品供应商

    product_urlstring

    商品页面 URL

    created_atstring

    创建时间(ISO-8601 格式)

    updated_atstring

    最后更新时间(ISO-8601 格式)

    options object[]

    订单商品项关联的商品款式属性列表

  • Array [
  • namestring

    商品款式属性名称

    valuestring

    商品款式属性值

  • ]
  • product_slugstring

    商品的 URL 友好标识

    taxableboolean

    是否需要纳税

    requires_shippingboolean

    订单商品项是否需要物流

    spustring

    标准商品单元(SPU)

    product_tagsstring

    商品标签

    refund_quantity_totaluint32

    退款数量

    customboolean

    是否为自定义商品项

    trunk_pricestring

    主干价格

    discount_applicationsstring

    订单商品项运费的折扣应用数量

    tax_pricestring

    订单商品项的税费

    duty_pricestring

    关税费用

    payment_discount_pricestring

    应用于订单商品项的支付折扣金额

    custom_propertiesobject

    订单商品项的自定义属性(如尺码、颜色等),JSON 格式

  • ]
  • payment_line object

    支付详情

    idstring

    支付行 ID

    payment_namestring

    支付渠道的显示名称(如 PayPal、信用卡)

    payment_channelstring

    交易使用的支付渠道(如 PayPal、Stripe、银行转账)

    payment_methodstring

    渠道内使用的具体支付方式(如 Visa、MasterCard、在线支付)

    credit_card_numberstring

    所使用信用卡的末几位数字

    trans_channelstring

    交易渠道

    trans_methodstring

    交易方式

    transaction_nostring

    与本次支付关联的唯一交易号

    merchant_emailstring

    商家电子邮件地址

    shipping_line object

    订单所选物流方案的信息

    idstring

    配送 ID

    namestring

    名称

    descstring

    描述

    delivery_methodint32

    配送方式

    billing_address object

    账单地址

    first_namestring

    收件人的名

    last_namestring

    收件人的姓

    addressstring

    主要配送地址(如 1 Rue des Carrieres)

    address1string

    附加地址信息(如 Suite 1234)

    phonestring

    电话号码(如 +86 1231231234)

    citystring

    城市(如 SAN JOSE)

    zipstring

    邮政编码(如 87036)

    provincestring

    省份(如 New Mexico)

    countrystring

    国家(如 United States)

    companystring

    公司名称(如 ABC Limited)

    latitudestring

    配送地址的纬度(如 22.54)

    longitudestring

    配送地址的经度(如 114.06)

    namestring

    收件人姓名

    country_codestring

    国家代码(如 US)

    province_codestring

    省份代码(如 NM)

    phone_area_codestring

    区号(如 +86)

    emailstring

    电子邮件地址

    areastring

    地区(如 Bay area)

    extra_info object

    特殊物流信息字段,包含税号等

    addition object

    特殊物流信息的附加键值项,例如税号字段

    property name* AdditionItem
    namestring

    名称

    valstring

    cpfstring

    个人税号

    tax_textstring

    税费文本

    shipping_address object

    收货地址

    first_namestring

    收件人的名

    last_namestring

    收件人的姓

    addressstring

    主要配送地址(如 1 Rue des Carrieres)

    address1string

    附加地址信息(如 Suite 1234)

    phonestring

    电话号码(如 +86 1231231234)

    citystring

    城市(如 SAN JOSE)

    zipstring

    邮政编码(如 87036)

    provincestring

    省份(如 New Mexico)

    countrystring

    国家(如 United States)

    companystring

    公司名称(如 ABC Limited)

    latitudestring

    配送地址的纬度(如 22.54)

    longitudestring

    配送地址的经度(如 114.06)

    namestring

    收件人姓名

    country_codestring

    国家代码(如 US)

    province_codestring

    省份代码(如 NM)

    phone_area_codestring

    区号(如 +86)

    emailstring

    电子邮件地址

    areastring

    地区(如 Bay area)

    extra_info object

    特殊物流信息字段,包含税号等

    addition object

    特殊物流信息的附加键值项,例如税号字段

    property name* AdditionItem
    namestring

    名称

    valstring

    cpfstring

    个人税号

    tax_textstring

    税费文本

    fulfillments object[]

    物流记录列表

  • Array [
  • idstring

    履约 ID

    order_idstring

    订单 ID

    statusstring

    物流单状态:

    • pending: 待发货
    • shipped: 已发货
    • finished: 已完成
    • cancelled: 已取消
    created_atstring

    创建时间(ISO-8601 格式)

    updated_atstring

    最后更新时间(ISO-8601 格式)

    tracking_companystring

    物流商

    tracking_numberstring

    运单号

    tracking_company_codestring

    物流商编码

    line_items object[]

    本次履约包含的订单商品项列表

  • Array [
  • idstring

    订单商品项 ID

    product_idstring

    商品 ID

    product_titlestring

    已购商品名称

    variant_idstring

    子款式 ID

    variant_titlestring

    子款式标题,例如 Blue, Size M

    quantityuint32

    已购该商品的数量

    notestring

    订单商品项的商品备注

    image object

    商品图片

    srcstring

    图片来源 URL

    widthint32

    图片宽度(像素)

    heightint32

    图片高度(像素)

    altstring

    图片替代文本

    pricestring

    售价

    compare_at_pricestring

    划线价

    total_pricestring

    总价

    fulfillment_statusstring

    订单商品项的履约状态,例如 fulfilled(已履约)、unfulfilled(未履约);详见履约状态文档

    skustring

    SKU

    weightstring

    商品重量

    weight_unitstring

    商品重量的计量单位,例如 kglbs

    vendorstring

    商品供应商

    product_urlstring

    商品页面 URL

    created_atstring

    创建时间(ISO-8601 格式)

    updated_atstring

    最后更新时间(ISO-8601 格式)

    options object[]

    订单商品项关联的商品款式属性列表

  • Array [
  • namestring

    商品款式属性名称

    valuestring

    商品款式属性值

  • ]
  • product_slugstring

    商品的 URL 友好标识

    taxableboolean

    是否需要纳税

    requires_shippingboolean

    订单商品项是否需要物流

    spustring

    标准商品单元(SPU)

    product_tagsstring

    商品标签

    refund_quantity_totaluint32

    退款数量

    ship_quantityuint32

    发货数量

    customboolean

    是否为自定义商品项

    trunk_pricestring

    主干价格

    discount_applicationsstring

    订单商品项运费的折扣应用数量

    tax_pricestring

    订单商品项的税费

    duty_pricestring

    关税费用

    payment_discount_pricestring

    应用于订单商品项的支付折扣金额

    custom_propertiesobject

    订单商品项的自定义属性(如尺码、颜色等),JSON 格式

  • ]
  • tracking_urlstring

    物流链接

    phone_numberstring

    电话号码

    tracking_items object[]

    本次履约包含的物流运单列表

  • Array [
  • tracking_numberstring

    运单号

    tracking_companystring

    物流商

    tracking_company_codestring

    物流商编码

    tracking_urlstring

    物流链接

  • ]
  • ]
  • customer object

    顾客详情

    idstring

    订单 ID

    emailstring

    电子邮件地址

    first_namestring

    last_namestring

    phonestring

    电话号码

    created_atstring

    顾客记录创建时间(如 2018-11-02T12:30:10Z)

    updated_atstring

    顾客记录最后更新时间(如 2018-11-02T12:30:10Z)

    order_countint32

    订单数量

    total_spentstring

    顾客总消费金额

    refer_infostring

    访问来源信息

    sales_platformstring

    销售渠道

    total_refund_pricestring

    已成功处理的退款总金额,数字字符串(如 "9.99")

    primary_market_price object

    主市场价格

    compare_at_pricestring

    店铺/主要货币的划线价

    pricestring

    主要货币的单价

    total_pricestring

    总价(主要货币单价 × 数量)

    actual_ratestring

    实际使用的换算汇率

    total_tip_receivedstring

    订单收到的小费总额

    discount_applicationsstring

    已应用折扣的详情

    refund_statusstring

    退款状态:

    • pending: 退款中
    • finished: 退款完成
    • failed: 退款失败
    email_statusstring

    订单召回邮件的状态:

    • waiting: 待发送
    • send: 已发送
    recovery_statusstring

    订单召回流程进度:

    • waiting: 等待召回
    • sending: 召回通知发送中
    • recalling: 召回进行中
    • failed: 召回失败
    • success: 召回成功
    total_paidstring

    顾客为订单支付的总金额

    payment_lines object[]

    支付行列表

  • Array [
  • idstring

    支付行 ID

    payment_namestring

    支付渠道的显示名称(如 PayPal、信用卡)

    payment_channelstring

    交易使用的支付渠道(如 PayPal、Stripe、银行转账)

    payment_methodstring

    渠道内使用的具体支付方式(如 Visa、MasterCard、在线支付)

    credit_card_numberstring

    所使用信用卡的末几位数字

    trans_channelstring

    交易渠道

    trans_methodstring

    交易方式

    transaction_nostring

    与本次支付关联的唯一交易号

    merchant_emailstring

    商家电子邮件地址

  • ]
  • gift_card_totalstring

    礼品卡折扣金额,数字字符串(如 "9.99")

    logistics_codestring

    物流代码

    shipping_tax_totalstring

    订单运费税总额

    location_line object

    商家仓库地址

    idstring

    仓库位置 ID

    location_idstring

    关联位置的标识符

    location_namestring

    位置名称,如店铺或仓库名称

    additional_totalstring

    附加费用总额,数字字符串(如 "9.99")

    additional_prices object[]

    附加费用明细列表

  • Array [
  • namestring

    附加费用名称

    pricestring

    附加费用金额

    biz_idstring

    业务 ID

    fee_titlestring

    自定义收费名称

  • ]
  • config object

    订单配置信息

    page_typestring

    结账页类型(如三页式 three_step)

    requires_shippingboolean

    指定订单是否需要配送

    product_tax_includedboolean

    指定商品价格是否含税

    market_setting object

    指定订单的市场特定配置(如区域税、货币设置)

    primary_market_langstring

    主要市场语言

    market_langstring

    市场语言(如 en-US)

    market_idstring

    市场配置 ID

    market_currencystring

    市场货币代码(如 USD)

    market_currency_symbol object

    市场货币符号

    codestring

    货币代码(如 USD)

    valstring

    货币符号(如 $)

    leftstring

    数字左侧显示的内容(如 $)

    rightstring

    数字右侧显示的内容

    market_base_idstring

    市场基础 ID

    market_base_currencystring

    市场基础货币(如 USD)

    market_base_currency_symbol object

    市场基础货币符号

    codestring

    货币代码(如 USD)

    valstring

    货币符号(如 $)

    leftstring

    数字左侧显示的内容(如 $)

    rightstring

    数字右侧显示的内容

    primary_market_idstring

    主要市场 ID

    primary_market_currencystring

    主要市场货币代码(如 USD)

    primary_market_currency_symbol object

    主要市场货币符号

    codestring

    货币代码(如 USD)

    valstring

    货币符号(如 $)

    leftstring

    数字左侧显示的内容(如 $)

    rightstring

    数字右侧显示的内容

    market_price_setting object

    市场价格设置

    local_currency_enabledboolean

    本地货币启用状态

    custom_rate_enabledboolean

    自定义汇率启用状态

    custom_ratefloat

    自定义汇率:主要市场货币 → 市场基础货币

    ratefloat

    汇率:主要市场货币 → 市场基础货币/本地货币

    back_ratefloat

    反向汇率:市场基础货币/本地货币 → 主要市场货币

    actual_ratefloat

    实际汇率:主要市场货币 → 市场基础货币/本地货币

    base_to_ratefloat

    汇率:市场基础货币 → 本地货币

    local_to_ratefloat

    本地汇率

    adjustint32

    价格调整值

    price_round_enabledboolean

    启用价格取整

    market_countrystring

    市场国家(如 US)

    checkout_urlstring

    订单结账页面的 URL(含店铺域名)

    duty_totalstring

    关税税费总额

    order_confirm_notifyint32

    是否发送订单确认通知

    fulfillment_notifyint32

    是否发送订单物流通知:

    • 0: 使用系统配置
    • 1: 发送邮件
    • 2: 不发送邮件
    partial_fulfillment_notifyint32

    是否发送部分物流通知:

    • 0: 使用系统配置
    • 1: 发送邮件
    • 2: 不发送邮件
    order_delivered_notifyint32

    是否发送配送通知

    finished_atstring

    订单完成时间

    devicestring

    设备

    order_typestring

    订单类型:

    • 0: 普通订单
    • 1: 礼品卡订单
    sourcestring

    首次访问落地页

    source_namestring

    首次互动来源

    last_landing_urlstring

    最后一次访问落地页 URL

    last_referrer_showstring

    最后一次互动来源

    browser_ipstring

    浏览器 IP 地址