跳到主要内容
版本:202201

创建订单退款记录

POST 

/openapi/2022-01/orders/:id/refund

为指定订单新增一条退款记录,声明退款金额及使用的支付渠道;返回新建退款 记录的 ID 与关联的售后记录 ID。

请求

Path参数

    id string必填

    Order's ID

响应

200

数据结构
    idstring
    示例: 31e27a7a-6899-4709-93e2-b3d6177c7458
    statusstring
    示例: finished
    numberstring
    示例: SPZ00000020-S1
    created_atstring
    示例: 2024-06-24T08:17:59Z
    notestring
    示例:
    refund_fail_reasonstring
    示例:
    all_refundedboolean
    默认值: true
    示例: true
    refund_statusstring
    示例: finished
    order object
    idstring
    示例: 633130-SPZ00000020
    note
    numberstring
    示例: SPZ00000020
    financial_statusstring
    示例: refunded
    statusstring
    示例: placed
    cancel_reason
    payment_methodstring
    示例: bogus_gateway
    fulfillment_statusstring
    示例: waiting
    discount_codestring
    示例:
    discount_applicationsstring
    示例: []
    customer_notestring
    示例:
    sales_platformstring
    示例: shoplazza
    landing_sitestring
    示例: https://zhangsenjun-shoplazza.stg.myshoplaza.com/?preview_theme_id=
    buyer_accepts_marketingboolean
    默认值: true
    示例: true
    currencystring
    示例: USD
    total_pricestring
    示例: 21.10
    total_discountstring
    示例: 0.00
    total_taxstring
    示例: 0.00
    total_shippingstring
    示例: 11.00
    sub_totalstring
    示例: 10.10
    code_discount_totalstring
    示例: 0.00
    line_item_discount_totalstring
    示例: 0.00
    tagsstring
    示例:
    created_atstring
    示例: 2024-06-24T08:16:57Z
    updated_atstring
    示例: 2024-06-24T08:18:00Z
    canceled_at
    customer_deleted_at
    deleted_at
    placed_atstring
    示例: 2024-06-24T08:17:12Z
    total_refund_pricestring
    示例: 21.10
    total_refund_taxstring
    示例: 0.00
    total_refund_discountstring
    示例: 0.00
    refund_statusstring
    示例: customize
    total_tip_receivedstring
    示例: 0.00
    browser_ipstring
    示例: 39.109.76.165
    sourcestring
    示例: https://zhangsenjun-shoplazza.stg.myshoplaza.com/?preview_theme_id=
    last_landing_urlstring
    示例: https://zhangsenjun-shoplazza.stg.myshoplaza.com/?preview_theme_id=
    email_statusstring
    示例: waiting
    recovery_statusstring
    示例: waiting
    total_paidstring
    示例: 21.10
    source_name object
    datastring
    示例: Direct
    created_atstring
    示例: 2024-06-21T10:44:09Z
    last_referrer_show object
    datastring
    示例: Direct
    created_atstring
    示例: 2024-06-24T07:36:48Z
    shipping_line object
    namestring
    示例: test
    customer object
    idstring
    示例: f6de152d-ec40-4734-81e5-62db979da04e
    emailstring
    first_namestring
    示例: zhang
    last_namestring
    示例: senjun
    phonestring
    示例: +8615014471143
    created_atstring
    示例: 2024-04-17T08:43:37Z
    updated_atstring
    示例: 2024-04-24T06:02:42Z
    orders_countinteger
    默认值: 0
    示例: 14
    total_spentstring
    示例: 358.65
    shipping_address object
    first_namestring
    示例: test
    last_namestring
    示例: test
    address1string
    示例: 6 三聖街
    address2string
    示例: Sam Shing Estate
    phonestring
    示例: +8615014471143
    citystring
    示例: Tuen Mun
    zipstring
    示例: 515300
    provincestring
    示例: New Territories
    countrystring
    示例: Hong Kong SAR, China
    companystring
    示例:
    latitude
    longitude
    namestring
    示例: test test
    country_codestring
    示例: HK
    province_codestring
    示例: NT
    phone_area_codestring
    示例: CN_86
    emailstring
    areastring
    示例:
    extra_info
    billing_address object
    first_namestring
    示例: test
    last_namestring
    示例: test
    address1string
    示例: 6 三聖街
    address2string
    示例: Sam Shing Estate
    citystring
    示例: Tuen Mun
    zipstring
    示例: 515300
    provincestring
    示例: New Territories
    countrystring
    示例: Hong Kong SAR, China
    companystring
    示例:
    latitude
    longitude
    namestring
    示例: test test
    country_codestring
    示例: HK
    province_codestring
    示例: NT
    emailstring
    areastring
    示例:
    phonestring
    示例: +8615014471143
    payment_line object
    payment_channelstring
    示例: bogus
    payment_methodstring
    示例: bogus_gateway
    transaction_nostring
    示例: test_633130-SPZ00000020
    merchant_idstring
    示例:
    merchant_emailstring
    示例:
    payment_lines object[]
  • Array [
  • payment_channelstring
    示例: bogus
    payment_methodstring
    示例: bogus_gateway
    transaction_nostring
    示例: test_633130-SPZ00000020
    merchant_idstring
    示例:
    merchant_emailstring
    示例:
    paid_totalstring
    示例: 21.10
  • ]
  • line_items object[]
  • Array [
  • idstring
    示例: be0b061c-3895-4ebf-9566-ff282f0f452c
    product_idstring
    示例: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    variant_idstring
    示例: 88e68830-4ef5-4125-bf7d-aef8047176b2
    variant_titlestring
    示例: S-blue-T
    product_titlestring
    示例: shirt
    product_handlestring
    示例: shirt
    quantityinteger
    默认值: 0
    示例: 1
    notestring
    示例:
    fulfillment_statusstring
    示例: waiting
    skustring
    示例: T-M-S-blue-T-A001004
    weight_unitstring
    示例: kg
    vendorstring
    示例: shoplazza
    product_urlstring
    示例: /products/shirt
    compare_at_pricestring
    示例: 12.10
    imagestring
    示例: //img.staticdj.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    pricestring
    示例: 10.10
    totalstring
    示例: 10.10
    weightstring
    示例: 1.10
    properties object[]
  • Array [
  • namestring
    示例: size
    valuestring
    示例: S
  • ]
  • custom_properties object
    object
    refund_quantityinteger
    默认值: 0
    示例: 0
    refund_totalstring
    示例: 0.00
    base_pricestring
    示例: 0.00
    discount_applicationsstring
    示例: []
  • ]
  • fulfillments object[]
  • Array [
  • object
  • ]
  • gift_card_totalstring
    示例: 0.00
    shipping_tax_totalstring
    示例: 0.00
    product_tax_includedboolean
    默认值: true
    示例: true
    refer_infostring
    示例: {"$latest_referrer":"https://sso.stg.shoplazza.com/","$latest_referrer_host":"sso.stg.shoplazza.com","$latest_search_keyword":"未取到值","$latest_traffic_source_type":"引荐流量","address_check":true,"client_id":"1703040491710183","country":"HK","customer_session":"3e86e183-eb19-4e48-b390-1a42738b1de5","domain":"zhangsenjun-shoplazza.stg.myshoplaza.com","fbc":"","fbp":"fb.1.1701051195560.2038310036","inventory_deduction":"order_created","ip":"39.109.76.165","session_id":"1718966647667364","source":"buy_now","traffic":{"tiktok":{"_ttp":"4Czre7yjs-SB67iq0jHoGcl1vmx"}},"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36"}
    additional_totalstring
    示例: 0.00
    additional_prices object[]
  • Array [
  • object
  • ]
  • logistics_codestring
    示例:
    config object
    page_typestring
    示例: three_step
    requires_shippingboolean
    默认值: true
    示例: true
    checkout_business_typeinteger
    默认值: 0
    示例: 0
    product_tax_includedboolean
    默认值: true
    示例: true
    checkout_template_typeinteger
    默认值: 0
    示例: 0
    market_setting object
    primary_market_langstring
    示例: en-US
    market_langstring
    示例: en-US
    market_idstring
    示例: 311711862569844266
    market_currencystring
    示例: USD
    market_currency_symbol object
    codestring
    示例: USD
    valstring
    示例: $
    leftstring
    示例: $
    rightstring
    示例:
    market_base_idstring
    示例:
    market_base_currencystring
    示例: USD
    market_base_currency_symbol object
    codestring
    示例: USD
    valstring
    示例: $
    leftstring
    示例: $
    rightstring
    示例:
    primary_market_idstring
    示例: 311711862569844266
    primary_market_currencystring
    示例: USD
    primary_market_currency_symbol object
    codestring
    示例: USD
    valstring
    示例: $
    leftstring
    示例: $
    rightstring
    示例:
    market_price_setting object
    local_currency_enabledboolean
    默认值: true
    示例: false
    custom_rate_enabledboolean
    默认值: true
    示例: false
    custom_rateinteger
    默认值: 0
    示例: 0
    rateinteger
    默认值: 0
    示例: 1
    back_rateinteger
    默认值: 0
    示例: 1
    actual_rateinteger
    默认值: 0
    示例: 1
    base_to_localinteger
    默认值: 0
    示例: 0
    local_to_baseinteger
    默认值: 0
    示例: 0
    adjustinteger
    默认值: 0
    示例: 0
    price_round_enabledboolean
    默认值: true
    示例: true
    market_countrystring
    示例: US
    refund object
    idstring
    示例: 394765711538398890
    order_idstring
    示例: 633130-SPZ00000020
    notestring
    示例:
    refund_pricestring
    示例: 21.10
    currencystring
    示例: USD
    created_atstring
    示例: 2024-06-24T08:18:00Z
    updated_atstring
    示例: 2024-06-24T08:18:00Z
    refund_line_items object[]
  • Array [
  • object
  • ]
  • refund_shippingstring
    示例: 11.00
    refund_shipping_taxstring
    示例: 0.00
    refund_methodstring
    示例: customize
    refund_statusstring
    示例: finished