Order refund

Requires write_orders access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/order/refund.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • processed_at string
    Refund order launch time
    Example: Format : 2023-04-12T22 : 59 : 52+08 : 00
  • refund_line_itemsobject[]
    Refund Product line information , can be associated with multiple Product lines
  • restock_type string
    Product inventory processing
    Example: return
  • type string required
    Dangyi shipping status is required when making a refund when in Product Unshipped : Product not shipped , Returned : the product has been returned
    Example: Unshipped
  • line_item_id long
    Product row id
    Example: 601
  • location_id string
    Product stock back place
    Example: 5409714787218633772
  • quantity long
    Trial refund Product quantity
    Example: 1
  • shippingobject
    Refund policy for shipping amount
  • amount string
    Specify refund amount
    Example: 1.23
  • full_refund boolean
    Return shipping fee or not
    Example: true
  • transactionsobject[] required
    Payment slip refund information
  • id string
    Payment slip number , start with 230
    Example: 23057520029306658561302511
  • kind string
    Payment slip type
    Example: refund
  • type boolean
    Refund type , ture : refund on the original road
    Example: true
  • amount string
    Refund amount, which the settlement currency amount corresponding to the payment order
    Example: 2.34
  • currency string
    the settlement currency of the payment, which is optional. If the input currency is null, the application will verify whether the currency is the store currency, If it is not the store currency, an error will be reported and promp like: "the input currency must be the settlement currency of the payment
    ”; If the input currency is passed, check whether the currency is the settlement currency of the payment. If not, an error will be reported and the prompt will be the same as above
  • gateway string
    Payment channels
    Example: Paypal
  • currency string
    settlement currency of the order, which is optional. If the input currency is null, the application will verify whether the order settlement currency is the store currency, If it is not the store currency, an error will be reported, prompting like: "currency must be X”; If the input currency is passed, check whether the currency is the settlement currency of the order. If not, an error will be reported and the prompt will be: "currency must be X"
  • note string
    Refund Notes
    Example: Refund
  • notify boolean
    Send message notifications ( logic with existing b-end refund message )
    Example: true
  • order_id string required
    Order number
    Example: 21057520029298437725452511
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • dataobject
    Data return body
  • note string
    Refund Notes
    Example: Remark
  • order_adjustmentsobject[]
    Adjust the order information
  • amount string
    Adjustment order amount
    Example: 2.34
  • kind string
    Adjustment order type: refund_discrepancy, shipping_refund
    Example: refund_discrepancy
  • order_id string
    Order number for this adjustment of the single link
    Example: 21057520029298437725452511
  • tax_amount_setobject
    Adjust the single tax amount according to the store currency and transaction currency
  • presentment_moneyobject
    Marketplace amount information
  • amount string
    Marketplace amount information
    Example: 2.34
  • currency_code string
    Market currency
    Example: USD
  • shop_moneyobject
    Store amount information
  • currency_code string
    Store currency
    Example: USD
  • amount string
    Store amount
    Example: 3.45
  • amount_setobject
    Adjust the single amount according to the store currency and transaction currency
  • shop_moneyobject
    Store amount information
  • amount string
    Store amount
    Example: 2.34
  • currency_code string
    Store currency
    Example: USD
  • presentment_moneyobject
    Marketplace amount information
  • amount string
    Marketplace amount
    Example: 2.34
  • currency_code string
    Market currency
    Example: USD
  • id string
    Adjust single size
  • reason string
    Reason for adjustment: Refund discrepancy, shipping_refund
    Example: refund_discrepancy
  • refund_id string
    Refund id , unique recognition
  • tax_amount string
    Adjust single tax amount
    Example: 978
  • order_id string
    Order number associated with this refund order
    Example: 21057520029298437725452511
  • refund_line_itemsobject[]
    Refund related Product line information
  • quantity long
    Refund Product quantity
    Example: 1
  • restock_type string
    Return- returns only not back
    Example: return
  • subtotal string
    Refund Product row total amount , accuracy 2
    Example: 3.45
  • subtotal_setobject
    Total amount of refund Product bank by store currency and transaction currency
  • presentment_moneyobject
    Marketplace amount information
  • amount string
    Marketplace amount
    Example: 1.23
  • currency_code string
    Market currency
    Example: USD
  • shop_moneyobject
    Store currency amount information
  • amount string
    Store amount
    Example: 2.36
  • currency_code string
    Store currency
    Example: USD
  • total_tax string
    Refund Product row tax total amount , accuracy 2
    Example: 4.56
  • total_tax_setobject
    Total amount of refund Product bank tax , sold in store currency and transaction currency
  • shop_moneyobject
    Store currency amount information
  • currency_code string
    Store currency
    Example: USD
  • amount string
    Store amount
    Example: 6.14
  • presentment_moneyobject
    Marketplace amount information
  • amount string
    Store amount
    Example: 3.24
  • currency_code string
    Store currency
    Example: USD
  • id long
    Product row id
  • line_item_id long
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 601
  • total_duties_setobject
    Refund total duty
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • transactionsobject[]
    Refund payment slip information
  • amount long
    The refund amount corresponding to the settlement currency of the refund payment order, precision 2
  • create_at string
    Creation time
    Example: 1673404700862
  • currency string
    Payment currency , payment slip corresponding settlement currency
    Example: USD
  • id string
    Payment slip number
    Example: 23057520029306658561302511
  • kind string
    Payment slip type , here is only refund
    Example: refund
  • order_id string
    Order number for this adjustment of the single link
    Example: 21057520029298437725452511
  • processed_at string
    Refund form update time
    Example: 1673404700862
  • status string
    Handling status, pending, failure, success, and error
    Example: pending
  • create_at string
    Refund single creation time
    Example: 1673404700862
  • id string
    Refund id , unique recognition
    Example: 2605755870074105241861
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "shipping": {
    "amount": "1.23",
    "full_refund": true
  },
  "transactions": [
    {
      "type": true,
      "amount": "2.34",
      "currency": "",
      "gateway": "Paypal",
      "id": "23057520029306658561302511",
      "kind": "refund"
    }
  ],
  "currency": "",
  "note": "Refund",
  "notify": true,
  "order_id": "21057520029298437725452511",
  "processed_at": "Format : 2023-04-12T22 : 59 : 52+08 : 00",
  "refund_line_items": [
    {
      "restock_type": "return",
      "type": "Unshipped",
      "line_item_id": 601,
      "location_id": "5409714787218633772",
      "quantity": 1
    }
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/order/refund.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.