版本：202201
标记订单支付成功
POST/openapi/2022-01/orders/:id/payment/success
完成订单支付并将订单状态更新为支付成功。
请求
Path参数
id string必填
Order's ID
- application/json
- 请求体
- 示例
请求体
billing_address object
first_namestring
The first name of the person associated with the payment method
last_namestring
The last name of the person associated with the payment method
emailstring
The email number at the billing address
countrystring
The name of the country of the billing address, for example: "United States"
country_codestring
The two-letter code for the country of the billing address, for example: "US"
provincestring
The name of the region (for example, province, state, or prefecture) of the billing address, for example: "Alaska"
province_codestring
The abbreviation of the region of the billing address, for example: "US-AK"
areastring
The area of the billing address
citystring
The city, town, or village of the billing address
address1string
Street address, for example: 1 Rue des Carrieres
address2string
Apartment/floor/room number, for example: Suite 1234
companystring
Company, for example: ABC Limited
latitudestring
The latitude of the billing address, for example: 22.54
longitudestring
The longitude of the billing address, for example: 114.06
zipstring
ZIP code, for example: 87036
{
"billing_address": {
"first_name": "string",
"last_name": "string",
"email": "string",
"country": "string",
"country_code": "string",
"province": "string",
"province_code": "string",
"area": "string",
"city": "string",
"address1": "string",
"address2": "string",
"company": "string",
"latitude": "string",
"longitude": "string",
"zip": "string"
}
}
响应
- 200
200
- application/json
- 数据结构
- 示例
- Result
数据结构
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
order object
idstring
示例：
633130-00000009note
numberstring
示例：
9financial_statusstring
示例：
paidstatusstring
示例：
placedcancel_reason
payment_methodstring
示例：
bogus_gatewayfulfillment_statusstring
示例：
waitingdiscount_codestring
示例：
discount_applicationsstring
示例：
[]customer_notestring
示例：
sales_platformstring
示例：
shoplazzalanding_sitestring
示例：
https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8ebuyer_accepts_marketingboolean
默认值：
true示例：
truecurrencystring
示例：
CNYtotal_pricestring
示例：
81.00total_discountstring
示例：
0.00total_taxstring
示例：
0.00total_shippingstring
示例：
0.00sub_totalstring
示例：
81.00code_discount_totalstring
示例：
0.00line_item_discount_totalstring
示例：
0.00tagsstring
示例：
recoveredcreated_atstring
示例：
2024-04-22T02:37:25Zupdated_atstring
示例：
2024-04-22T08:07:30Zcanceled_at
customer_deleted_at
deleted_at
placed_atstring
示例：
2024-04-22T08:07:30Ztotal_refund_pricestring
示例：
0.00total_refund_taxstring
示例：
0.00total_refund_discountstring
示例：
0.00refund_status
total_tip_receivedstring
示例：
0.00browser_ipstring
示例：
183.15.177.205sourcestring
示例：
https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8elast_landing_urlstring
示例：
email_statusstring
示例：
sendrecovery_statusstring
示例：
successtotal_paidstring
示例：
81.00source_name object
datastring
示例：
created_atstring
示例：
last_referrer_show object
datastring
示例：
created_atstring
示例：
shipping_line
customer object
idstring
示例：
f6de152d-ec40-4734-81e5-62db979da04eemailstring
first_namestring
示例：
zhanglast_namestring
示例：
senjunphonestring
示例：
+8615014471143created_atstring
示例：
2024-04-17T08:43:37Zupdated_atstring
示例：
2024-04-22T07:21:39Zorders_countinteger
默认值：
0示例：
6total_spentstring
示例：
163.99shipping_address object
first_namestring
示例：
testlast_namestring
示例：
testaddress1string
示例：
6 三聖街address2string
示例：
1111phonestring
示例：
+8615014471143citystring
示例：
北京zipstring
示例：
100000provincestring
示例：
Beijingcountrystring
示例：
China mainlandcompanystring
示例：
latitude
longitude
namestring
示例：
test testcountry_codestring
示例：
CNprovince_codestring
示例：
CN-BJphone_area_codestring
示例：
CN_86emailstring
areastring
示例：
extra_info
billing_address object
first_namestring
示例：
testlast_namestring
示例：
testaddress1string
示例：
6 三聖街address2string
示例：
1111citystring
示例：
沧州zipstring
示例：
061000provincestring
示例：
Hebeicountrystring
示例：
China mainlandcompanystring
示例：
latitude
longitude
namestring
示例：
test testcountry_codestring
示例：
CNprovince_codestring
示例：
CN-HEemailstring
areastring
示例：
phonestring
示例：
payment_line object
payment_channelstring
示例：
boguspayment_methodstring
示例：
bogus_gatewaytransaction_nostring
示例：
test_633130-00000009merchant_id
merchant_email
payment_lines object[]
payment_channelstring
示例：
boguspayment_methodstring
示例：
bogus_gatewaytransaction_nostring
示例：
test_633130-00000009merchant_id
merchant_email
paid_totalstring
示例：
81.00line_items object[]
idstring
示例：
853cfb69-7688-4266-ab9d-506abafe8f0aproduct_idstring
示例：
a1a88be0-a1d4-47e4-a2f2-ba6e131cf447variant_idstring
示例：
88e68830-4ef5-4125-bf7d-aef8047176b2variant_titlestring
示例：
S-blue-Tproduct_titlestring
示例：
shirtproduct_handlestring
示例：
shirtquantityinteger
默认值：
0示例：
1notestring
示例：
fulfillment_statusstring
示例：
waitingskustring
示例：
T-M-S-blue-T-A001004weight_unitstring
示例：
kgvendorstring
示例：
shoplazzaproduct_urlstring
示例：
/products/shirtcompare_at_pricestring
示例：
97.00imagestring
示例：
//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpegpricestring
示例：
81.00totalstring
示例：
81.00weightstring
示例：
1.10properties object[]
namestring
示例：
sizevaluestring
示例：
Scustom_properties
refund_quantityinteger
默认值：
0示例：
0refund_totalstring
示例：
0.00base_pricestring
示例：
0.00discount_applicationsstring
示例：
[]fulfillments object[]
object
gift_card_totalstring
示例：
0.00shipping_tax_totalstring
示例：
0.00product_tax_includedboolean
默认值：
true示例：
truerefer_infostring
示例：
{"$latest_referrer":"https://sso.stg.shoplazza.com/","$latest_search_keyword":"未取到值","$latest_traffic_source_type":"引荐流量","address_check":true,"client_id":"1703040491710183","country":"CN","customer_session":"e198c29a-70bb-4f9d-9d43-b1ab12b557fb","domain":"test-shoplazza.stg.myshoplaza.com","fbc":"","fbp":"fb.1.1701051195560.2038310036","inventory_deduction":"order_created","ip":"183.15.177.205","session_id":"1713753352271144","source":"buy_now","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"}additional_totalstring
示例：
0.00additional_prices object[]
object
logistics_codestring
示例：
config object
page_typestring
示例：
three_steprequires_shippingboolean
默认值：
true示例：
truecheckout_business_typeinteger
默认值：
0示例：
0product_tax_includedboolean
默认值：
true示例：
truecheckout_template_typeinteger
默认值：
0示例：
0market_setting object
primary_market_langstring
示例：
en-USmarket_langstring
示例：
en-USmarket_idstring
示例：
370871064999238186market_currencystring
示例：
CNYmarket_currency_symbol object
codestring
示例：
CNYvalstring
示例：
¥leftstring
示例：
¥rightstring
示例：
market_base_idstring
示例：
market_base_currencystring
示例：
CNYmarket_base_currency_symbol object
codestring
示例：
CNYvalstring
示例：
¥leftstring
示例：
¥rightstring
示例：
primary_market_idstring
示例：
311711862569844266primary_market_currencystring
示例：
USDprimary_market_currency_symbol object
codestring
示例：
USDvalstring
示例：
$leftstring
示例：
$rightstring
示例：
market_price_setting object
local_currency_enabledboolean
默认值：
true示例：
falsecustom_rate_enabledboolean
默认值：
true示例：
falsecustom_rateinteger
默认值：
0示例：
0ratenumber
默认值：
0示例：
7.239804back_ratenumber
默认值：
0示例：
0.138125actual_ratenumber
默认值：
0示例：
7.239804base_to_localinteger
默认值：
0示例：
0local_to_baseinteger
默认值：
0示例：
0adjustinteger
默认值：
0示例：
10price_round_enabledboolean
默认值：
true示例：
truemarket_countrystring
示例：
CNcheckout_urlstring
示例：
/checkout/1179396-00000010?key=eca1d627f5a38ed33189e6172e2a60{
"order": {
"id": "633130-00000009",
"note": {},
"number": 9,
"financial_status": "paid",
"status": "placed",
"cancel_reason": {},
"payment_method": "bogus_gateway",
"fulfillment_status": "waiting",
"discount_code": "",
"discount_applications": "[]",
"customer_note": "",
"sales_platform": "shoplazza",
"landing_site": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
"buyer_accepts_marketing": true,
"currency": "CNY",
"total_price": "81.00",
"total_discount": "0.00",
"total_tax": "0.00",
"total_shipping": "0.00",
"sub_total": "81.00",
"code_discount_total": "0.00",
"line_item_discount_total": "0.00",
"tags": "recovered",
"created_at": "2024-04-22T02:37:25Z",
"updated_at": "2024-04-22T08:07:30Z",
"canceled_at": {},
"customer_deleted_at": {},
"deleted_at": {},
"placed_at": "2024-04-22T08:07:30Z",
"total_refund_price": "0.00",
"total_refund_tax": "0.00",
"total_refund_discount": "0.00",
"refund_status": {},
"total_tip_received": "0.00",
"browser_ip": "183.15.177.205",
"source": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
"last_landing_url": "",
"email_status": "send",
"recovery_status": "success",
"total_paid": "81.00",
"source_name": {
"data": "",
"created_at": ""
},
"last_referrer_show": {
"data": "",
"created_at": ""
},
"shipping_line": {},
"customer": {
"id": "f6de152d-ec40-4734-81e5-62db979da04e",
"first_name": "zhang",
"last_name": "senjun",
"phone": "+8615014471143",
"created_at": "2024-04-17T08:43:37Z",
"updated_at": "2024-04-22T07:21:39Z",
"orders_count": 6,
"total_spent": "163.99"
},
"shipping_address": {
"first_name": "test",
"last_name": "test",
"address1": "6 三聖街",
"address2": "1111",
"phone": "+8615014471143",
"city": "北京",
"zip": "100000",
"province": "Beijing",
"country": "China mainland",
"company": "",
"latitude": {},
"longitude": {},
"name": "test test",
"country_code": "CN",
"province_code": "CN-BJ",
"phone_area_code": "CN_86",
"area": "",
"extra_info": {}
},
"billing_address": {
"first_name": "test",
"last_name": "test",
"address1": "6 三聖街",
"address2": "1111",
"city": "沧州",
"zip": "061000",
"province": "Hebei",
"country": "China mainland",
"company": "",
"latitude": {},
"longitude": {},
"name": "test test",
"country_code": "CN",
"province_code": "CN-HE",
"area": "",
"phone": ""
},
"payment_line": {
"payment_channel": "bogus",
"payment_method": "bogus_gateway",
"transaction_no": "test_633130-00000009",
"merchant_id": {},
"merchant_email": {}
},
"payment_lines": [
{
"payment_channel": "bogus",
"payment_method": "bogus_gateway",
"transaction_no": "test_633130-00000009",
"merchant_id": {},
"merchant_email": {},
"paid_total": "81.00"
}
],
"line_items": [
{
"id": "853cfb69-7688-4266-ab9d-506abafe8f0a",
"product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
"variant_id": "88e68830-4ef5-4125-bf7d-aef8047176b2",
"variant_title": "S-blue-T",
"product_title": "shirt",
"product_handle": "shirt",
"quantity": 1,
"note": "",
"fulfillment_status": "waiting",
"sku": "T-M-S-blue-T-A001004",
"weight_unit": "kg",
"vendor": "shoplazza",
"product_url": "/products/shirt",
"compare_at_price": "97.00",
"image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
"price": "81.00",
"total": "81.00",
"weight": "1.10",
"properties": [
{
"name": "size",
"value": "S"
}
],
"custom_properties": {},
"refund_quantity": 0,
"refund_total": "0.00",
"base_price": "0.00",
"discount_applications": "[]"
}
],
"fulfillments": [
{}
],
"gift_card_total": "0.00",
"shipping_tax_total": "0.00",
"product_tax_included": true,
"refer_info": "{\"$latest_referrer\":\"https://sso.stg.shoplazza.com/\",\"$latest_search_keyword\":\"未取到值\",\"$latest_traffic_source_type\":\"引荐流量\",\"address_check\":true,\"client_id\":\"1703040491710183\",\"country\":\"CN\",\"customer_session\":\"e198c29a-70bb-4f9d-9d43-b1ab12b557fb\",\"domain\":\"test-shoplazza.stg.myshoplaza.com\",\"fbc\":\"\",\"fbp\":\"fb.1.1701051195560.2038310036\",\"inventory_deduction\":\"order_created\",\"ip\":\"183.15.177.205\",\"session_id\":\"1713753352271144\",\"source\":\"buy_now\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36\"}",
"additional_total": "0.00",
"additional_prices": [
{}
],
"logistics_code": "",
"config": {
"page_type": "three_step",
"requires_shipping": true,
"checkout_business_type": 0,
"product_tax_included": true,
"checkout_template_type": 0,
"market_setting": {
"primary_market_lang": "en-US",
"market_lang": "en-US",
"market_id": "370871064999238186",
"market_currency": "CNY",
"market_currency_symbol": {
"code": "CNY",
"val": "¥",
"left": "¥",
"right": ""
},
"market_base_id": "",
"market_base_currency": "CNY",
"market_base_currency_symbol": {
"code": "CNY",
"val": "¥",
"left": "¥",
"right": ""
},
"primary_market_id": "311711862569844266",
"primary_market_currency": "USD",
"primary_market_currency_symbol": {
"code": "USD",
"val": "$",
"left": "$",
"right": ""
},
"market_price_setting": {
"local_currency_enabled": false,
"custom_rate_enabled": false,
"custom_rate": 0,
"rate": 7.239804,
"back_rate": 0.138125,
"actual_rate": 7.239804,
"base_to_local": 0,
"local_to_base": 0,
"adjust": 10,
"price_round_enabled": true
},
"market_country": "CN"
}
},
"checkout_url": "/checkout/1179396-00000010?key=eca1d627f5a38ed33189e6172e2a60"
}
}
{
"order": {
"id": "633130-00000009",
"note": null,
"number": "00000009",
"financial_status": "paid",
"status": "placed",
"cancel_reason": null,
"payment_method": "bogus_gateway",
"fulfillment_status": "waiting",
"discount_code": "",
"discount_applications": "[]",
"customer_note": "",
"sales_platform": "shoplazza",
"landing_site": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
"buyer_accepts_marketing": true,
"currency": "CNY",
"total_price": "81.00",
"total_discount": "0.00",
"total_tax": "0.00",
"total_shipping": "0.00",
"sub_total": "81.00",
"code_discount_total": "0.00",
"line_item_discount_total": "0.00",
"tags": "recovered",
"created_at": "2024-04-22T02:37:25Z",
"updated_at": "2024-04-22T08:07:30Z",
"canceled_at": null,
"customer_deleted_at": null,
"deleted_at": null,
"placed_at": "2024-04-22T08:07:30Z",
"total_refund_price": "0.00",
"total_refund_tax": "0.00",
"total_refund_discount": "0.00",
"refund_status": null,
"total_tip_received": "0.00",
"browser_ip": "183.15.177.205",
"source": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
"last_landing_url": "",
"email_status": "send",
"recovery_status": "success",
"total_paid": "81.00",
"source_name": {
"data": "",
"created_at": ""
},
"last_referrer_show": {
"data": "",
"created_at": ""
},
"shipping_line": null,
"customer": {
"id": "f6de152d-ec40-4734-81e5-62db979da04e",
"first_name": "zhang",
"last_name": "senjun",
"phone": "+8615014471143",
"created_at": "2024-04-17T08:43:37Z",
"updated_at": "2024-04-22T07:21:39Z",
"orders_count": 6,
"total_spent": "163.99"
},
"shipping_address": {
"first_name": "test",
"last_name": "test",
"address1": "6 三聖街",
"address2": "1111",
"phone": "+8615014471143",
"city": "北京",
"zip": "100000",
"province": "Beijing",
"country": "China mainland",
"company": "",
"latitude": null,
"longitude": null,
"name": "test test",
"country_code": "CN",
"province_code": "CN-BJ",
"phone_area_code": "CN_86",
"area": "",
"extra_info": null
},
"billing_address": {
"first_name": "test",
"last_name": "test",
"address1": "6 三聖街",
"address2": "1111",
"city": "沧州",
"zip": "061000",
"province": "Hebei",
"country": "China mainland",
"company": "",
"latitude": null,
"longitude": null,
"name": "test test",
"country_code": "CN",
"province_code": "CN-HE",
"area": "",
"phone": ""
},
"payment_line": {
"payment_channel": "bogus",
"payment_method": "bogus_gateway",
"transaction_no": "test_633130-00000009",
"merchant_id": null,
"merchant_email": null
},
"payment_lines": [
{
"payment_channel": "bogus",
"payment_method": "bogus_gateway",
"transaction_no": "test_633130-00000009",
"merchant_id": null,
"merchant_email": null,
"paid_total": "81.00"
}
],
"line_items": [
{
"id": "853cfb69-7688-4266-ab9d-506abafe8f0a",
"product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
"variant_id": "88e68830-4ef5-4125-bf7d-aef8047176b2",
"variant_title": "S-blue-T",
"product_title": "shirt",
"product_handle": "shirt",
"quantity": 1,
"note": "",
"fulfillment_status": "waiting",
"sku": "T-M-S-blue-T-A001004",
"weight_unit": "kg",
"vendor": "shoplazza",
"product_url": "/products/shirt",
"compare_at_price": "97.00",
"image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
"price": "81.00",
"total": "81.00",
"weight": "1.10",
"properties": [
{
"name": "size",
"value": "S"
},
{
"name": "color",
"value": "blue"
},
{
"name": "type",
"value": "T"
}
],
"custom_properties": null,
"refund_quantity": 0,
"refund_total": "0.00",
"base_price": "0.00",
"discount_applications": "[]"
}
],
"fulfillments": [],
"gift_card_total": "0.00",
"shipping_tax_total": "0.00",
"product_tax_included": true,
"refer_info": "{\"$latest_referrer\":\"https://sso.stg.shoplazza.com/\",\"$latest_search_keyword\":\"未取到值\",\"$latest_traffic_source_type\":\"引荐流量\",\"address_check\":true,\"client_id\":\"1703040491710183\",\"country\":\"CN\",\"customer_session\":\"e198c29a-70bb-4f9d-9d43-b1ab12b557fb\",\"domain\":\"test-shoplazza.stg.myshoplaza.com\",\"fbc\":\"\",\"fbp\":\"fb.1.1701051195560.2038310036\",\"inventory_deduction\":\"order_created\",\"ip\":\"183.15.177.205\",\"session_id\":\"1713753352271144\",\"source\":\"buy_now\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36\"}",
"additional_total": "0.00",
"additional_prices": [],
"logistics_code": "",
"config": {
"page_type": "three_step",
"requires_shipping": true,
"checkout_business_type": 0,
"product_tax_included": true,
"checkout_template_type": 0,
"market_setting": {
"primary_market_lang": "en-US",
"market_lang": "en-US",
"market_id": "370871064999238186",
"market_currency": "CNY",
"market_currency_symbol": {
"code": "CNY",
"val": "¥",
"left": "¥",
"right": ""
},
"market_base_id": "",
"market_base_currency": "CNY",
"market_base_currency_symbol": {
"code": "CNY",
"val": "¥",
"left": "¥",
"right": ""
},
"primary_market_id": "311711862569844266",
"primary_market_currency": "USD",
"primary_market_currency_symbol": {
"code": "USD",
"val": "$",
"left": "$",
"right": ""
},
"market_price_setting": {
"local_currency_enabled": false,
"custom_rate_enabled": false,
"custom_rate": 0,
"rate": 7.239804,
"back_rate": 0.138125,
"actual_rate": 7.239804,
"base_to_local": 0,
"local_to_base": 0,
"adjust": 10,
"price_round_enabled": true
},
"market_country": "CN"
}
},
"checkout_url": "/checkout/1179396-00000010?key=eca1d627f5a38ed33189e6172e2a60"
}
}