Skip to main content
Version: 202201

Order Payment Success

POST 
/openapi/2022-01/orders/:id/payment/success

Finalizes payment for an order and updates its status to indicate that payment has been completed.

Request​

Path Parameters

    id stringrequired

    Order's ID

Body

    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

Responses​

200

Schema
    order object
    idstring
    Example: 633130-00000009
    note
    numberstring
    Example: 9
    financial_statusstring
    Example: paid
    statusstring
    Example: placed
    cancel_reason
    payment_methodstring
    Example: bogus_gateway
    fulfillment_statusstring
    Example: waiting
    discount_codestring
    Example:
    discount_applicationsstring
    Example: []
    customer_notestring
    Example:
    sales_platformstring
    Example: shoplazza
    landing_sitestring
    Example: https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e
    buyer_accepts_marketingboolean
    Default value: true
    Example: true
    currencystring
    Example: CNY
    total_pricestring
    Example: 81.00
    total_discountstring
    Example: 0.00
    total_taxstring
    Example: 0.00
    total_shippingstring
    Example: 0.00
    sub_totalstring
    Example: 81.00
    code_discount_totalstring
    Example: 0.00
    line_item_discount_totalstring
    Example: 0.00
    tagsstring
    Example: recovered
    created_atstring
    Example: 2024-04-22T02:37:25Z
    updated_atstring
    Example: 2024-04-22T08:07:30Z
    canceled_at
    customer_deleted_at
    deleted_at
    placed_atstring
    Example: 2024-04-22T08:07:30Z
    total_refund_pricestring
    Example: 0.00
    total_refund_taxstring
    Example: 0.00
    total_refund_discountstring
    Example: 0.00
    refund_status
    total_tip_receivedstring
    Example: 0.00
    browser_ipstring
    Example: 183.15.177.205
    sourcestring
    Example: https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e
    last_landing_urlstring
    Example:
    email_statusstring
    Example: send
    recovery_statusstring
    Example: success
    total_paidstring
    Example: 81.00
    source_name object
    datastring
    Example:
    created_atstring
    Example:
    last_referrer_show object
    datastring
    Example:
    created_atstring
    Example:
    shipping_line
    customer object
    idstring
    Example: f6de152d-ec40-4734-81e5-62db979da04e
    emailstring
    Example: [email protected]
    first_namestring
    Example: zhang
    last_namestring
    Example: senjun
    phonestring
    Example: +8615014471143
    created_atstring
    Example: 2024-04-17T08:43:37Z
    updated_atstring
    Example: 2024-04-22T07:21:39Z
    orders_countinteger
    Default value: 0
    Example: 6
    total_spentstring
    Example: 163.99
    shipping_address object
    first_namestring
    Example: test
    last_namestring
    Example: test
    address1string
    Example: 6 三聖街
    address2string
    Example: 1111
    phonestring
    Example: +8615014471143
    citystring
    Example: 北京
    zipstring
    Example: 100000
    provincestring
    Example: Beijing
    countrystring
    Example: China mainland
    companystring
    Example:
    latitude
    longitude
    namestring
    Example: test test
    country_codestring
    Example: CN
    province_codestring
    Example: CN-BJ
    phone_area_codestring
    Example: CN_86
    emailstring
    Example: [email protected]
    areastring
    Example:
    extra_info
    billing_address object
    first_namestring
    Example: test
    last_namestring
    Example: test
    address1string
    Example: 6 三聖街
    address2string
    Example: 1111
    citystring
    Example: 沧州
    zipstring
    Example: 061000
    provincestring
    Example: Hebei
    countrystring
    Example: China mainland
    companystring
    Example:
    latitude
    longitude
    namestring
    Example: test test
    country_codestring
    Example: CN
    province_codestring
    Example: CN-HE
    emailstring
    Example: [email protected]
    areastring
    Example:
    phonestring
    Example:
    payment_line object
    payment_channelstring
    Example: bogus
    payment_methodstring
    Example: bogus_gateway
    transaction_nostring
    Example: test_633130-00000009
    merchant_id
    merchant_email
    payment_lines object[]
  • Array [
    • payment_channelstring
    Example: bogus
    payment_methodstring
    Example: bogus_gateway
    transaction_nostring
    Example: test_633130-00000009
    merchant_id
    merchant_email
    paid_totalstring
    Example: 81.00
  • ]
    • line_items object[]
  • Array [
    • idstring
    Example: 853cfb69-7688-4266-ab9d-506abafe8f0a
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    variant_idstring
    Example: 88e68830-4ef5-4125-bf7d-aef8047176b2
    variant_titlestring
    Example: S-blue-T
    product_titlestring
    Example: shirt
    product_handlestring
    Example: shirt
    quantityinteger
    Default value: 0
    Example: 1
    notestring
    Example:
    fulfillment_statusstring
    Example: waiting
    skustring
    Example: T-M-S-blue-T-A001004
    weight_unitstring
    Example: kg
    vendorstring
    Example: shoplazza
    product_urlstring
    Example: /products/shirt
    compare_at_pricestring
    Example: 97.00
    imagestring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    pricestring
    Example: 81.00
    totalstring
    Example: 81.00
    weightstring
    Example: 1.10
    properties object[]
  • Array [
    • namestring
    Example: size
    valuestring
    Example: S
  • ]
    • custom_properties
    refund_quantityinteger
    Default value: 0
    Example: 0
    refund_totalstring
    Example: 0.00
    base_pricestring
    Example: 0.00
    discount_applicationsstring
    Example: []
  • ]
    • fulfillments object[]
  • Array [
    • object
  • ]
    • gift_card_totalstring
    Example: 0.00
    shipping_tax_totalstring
    Example: 0.00
    product_tax_includedboolean
    Default value: true
    Example: true
    refer_infostring
    Example: {"$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
    Example: 0.00
    additional_prices object[]
  • Array [
    • object
  • ]
    • logistics_codestring
    Example:
    config object
    page_typestring
    Example: three_step
    requires_shippingboolean
    Default value: true
    Example: true
    checkout_business_typeinteger
    Default value: 0
    Example: 0
    product_tax_includedboolean
    Default value: true
    Example: true
    checkout_template_typeinteger
    Default value: 0
    Example: 0
    market_setting object
    primary_market_langstring
    Example: en-US
    market_langstring
    Example: en-US
    market_idstring
    Example: 370871064999238186
    market_currencystring
    Example: CNY
    market_currency_symbol object
    codestring
    Example: CNY
    valstring
    Example: ¥
    leftstring
    Example: ¥
    rightstring
    Example:
    market_base_idstring
    Example:
    market_base_currencystring
    Example: CNY
    market_base_currency_symbol object
    codestring
    Example: CNY
    valstring
    Example: ¥
    leftstring
    Example: ¥
    rightstring
    Example:
    primary_market_idstring
    Example: 311711862569844266
    primary_market_currencystring
    Example: USD
    primary_market_currency_symbol object
    codestring
    Example: USD
    valstring
    Example: $
    leftstring
    Example: $
    rightstring
    Example:
    market_price_setting object
    local_currency_enabledboolean
    Default value: true
    Example: false
    custom_rate_enabledboolean
    Default value: true
    Example: false
    custom_rateinteger
    Default value: 0
    Example: 0
    ratenumber
    Default value: 0
    Example: 7.239804
    back_ratenumber
    Default value: 0
    Example: 0.138125
    actual_ratenumber
    Default value: 0
    Example: 7.239804
    base_to_localinteger
    Default value: 0
    Example: 0
    local_to_baseinteger
    Default value: 0
    Example: 0
    adjustinteger
    Default value: 0
    Example: 10
    price_round_enabledboolean
    Default value: true
    Example: true
    market_countrystring
    Example: CN
    checkout_urlstring
    Example: /checkout/1179396-00000010?key=eca1d627f5a38ed33189e6172e2a60