Skip to main content
Version: 202201

Partial Order Refund

POST 
/openapi/2022-01/orders/:id/partial_refund

Request​

Path Parameters

    id stringrequired

    Order's ID

Body

    is_returnboolean

    Whether to return the fulfillments, for example: true or false

    pricestring

    Refund Amount, for example: 10.00

    line_items object[]

    Refund line items, only the Unfulfilled Order is supported

  • Array [
    • idstring

    Line item ID

    quantityint32

    Quantity for this product

  • ]

Responses​

200

Schema
    idstring
    Example: e18d1fc2-df36-4d6e-8e03-f1586d963b5f
    statusstring
    Example: finished
    numberstring
    Example: 00000013-S1
    created_atstring
    Example: 2024-04-22T07:22:51Z
    notestring
    Example:
    refund_fail_reasonstring
    Example:
    all_refundedboolean
    Default value: true
    Example: false
    refund_statusstring
    Example: general
    order object
    idstring
    Example: 633130-00000013
    note
    numberstring
    Example: 00000013
    financial_statusstring
    Example: partially_refunded
    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: 242.00
    total_discountstring
    Example: 0.00
    total_taxstring
    Example: 0.00
    total_shippingstring
    Example: 80.00
    sub_totalstring
    Example: 162.00
    code_discount_totalstring
    Example: 0.00
    line_item_discount_totalstring
    Example: 0.00
    tagsstring
    Example:
    created_atstring
    Example: 2024-04-22T07:21:34Z
    updated_atstring
    Example: 2024-04-22T07:22:52Z
    canceled_at
    customer_deleted_at
    deleted_at
    placed_atstring
    Example: 2024-04-22T07:21:48Z
    total_refund_pricestring
    Example: 81.00
    total_refund_taxstring
    Example: 0.00
    total_refund_discountstring
    Example: 0.00
    refund_statusstring
    Example: general
    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: waiting
    recovery_statusstring
    Example: waiting
    total_paidstring
    Example: 242.00
    source_name object
    datastring
    Example:
    created_atstring
    Example:
    last_referrer_show object
    datastring
    Example:
    created_atstring
    Example:
    shipping_line object
    namestring
    Example: test
    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: 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
    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: +8615014471143
    payment_line object
    payment_channelstring
    Example: bogus
    payment_methodstring
    Example: bogus_gateway
    transaction_nostring
    Example: test_633130-00000013
    merchant_idstring
    Example:
    merchant_emailstring
    Example:
    payment_lines object[]
  • Array [
    • payment_channelstring
    Example: bogus
    payment_methodstring
    Example: bogus_gateway
    transaction_nostring
    Example: test_633130-00000013
    merchant_idstring
    Example:
    merchant_emailstring
    Example:
    paid_totalstring
    Example: 242.00
  • ]
    • line_items object[]
  • Array [
    • idstring
    Example: 31d95f28-baf0-47c9-ad53-dbf3833f1b85
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    variant_idstring
    Example: cbd7a7b0-5dd7-4902-9466-e21bd02688b4
    variant_titlestring
    Example: L-red-S
    product_titlestring
    Example: shirt
    product_handlestring
    Example: shirt
    quantityinteger
    Default value: 0
    Example: 2
    notestring
    Example:
    fulfillment_statusstring
    Example: waiting
    skustring
    Example: T-M-L-red-S-A001011
    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: 162.00
    weightstring
    Example: 1.10
    properties object[]
  • Array [
    • namestring
    Example: size
    valuestring
    Example: L
  • ]
    • custom_properties
    refund_quantityinteger
    Default value: 0
    Example: 1
    refund_totalstring
    Example: 81.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://myaccount.stg.shoplazza.com/","$latest_referrer_host":"myaccount.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":"1713767538649476","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
    refund object
    idstring
    Example: 371921398756556394
    order_idstring
    Example: 633130-00000013
    notestring
    Example:
    refund_pricestring
    Example: 81.00
    currencystring
    Example: CNY
    created_atstring
    Example: 2024-04-22T07:22:51Z
    updated_atstring
    Example: 2024-04-22T07:22:51Z
    refund_line_items object[]
  • Array [
    • refund_quantityinteger
    Default value: 0
    Example: 1
    line_item_idstring
    Example: 31d95f28-baf0-47c9-ad53-dbf3833f1b85
    line_item object
    idstring
    Example: 31d95f28-baf0-47c9-ad53-dbf3833f1b85
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    variant_idstring
    Example: cbd7a7b0-5dd7-4902-9466-e21bd02688b4
    variant_titlestring
    Example: L-red-S
    product_titlestring
    Example: shirt
    product_handlestring
    Example: shirt
    quantityinteger
    Default value: 0
    Example: 2
    notestring
    Example:
    fulfillment_statusstring
    Example: waiting
    skustring
    Example: T-M-L-red-S-A001011
    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: 162.00
    weightstring
    Example: 1.10
    properties object[]
  • Array [
    • namestring
    Example: size
    valuestring
    Example: L
  • ]
    • custom_properties
    refund_quantityinteger
    Default value: 0
    Example: 1
    refund_totalstring
    Example: 81.00
    base_pricestring
    Example: 0.00
    discount_applicationsstring
    Example:
  • ]