Query all refund orders for the id association

Requires read_orders access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/orders/:order_id/refunds.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 .
Path Parameters
  • order_id string required
    Order id
    Example: ”21057168152571061289431726“
Query Parameters
  • limit long
    Limited to return quantity up to 250 pieces
    Example: 250
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
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
  • refundsobject[]
    Refund order
  • id string
    Refund ID
    Example: SL201AS4571669738589065294
  • order_id string
    Order number
    Example: 21057168152571061289431726
  • total_duties_setobject
    Refund total duty
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • note string
    Refund Notes
    Example: Notes
  • order_adjustmentsobject[]
    Adjust the order information
  • tax_amount string
    Adjust the single tax amount
    Example: 100
  • kind string
    Adjust single type
    Example: shipping_refund
  • tax_amount_setobject
    Adjust the single tax amount
  • presentment_moneyobject
    Store adjustment single display tax amount
  • amount double
    Store adjustment single display tax amount
    Example: 9.9
  • currency_code string
    Store adjustment single display tax currency
    Example: CNY
  • shop_moneyobject
    Store adjusts the amount of single tax
  • currency_code string
    Store adjustment of single tax currency
    Example: CNY
  • amount double
    Store adjusts the amount of single tax
    Example: 9.9
  • amount_setobject
    Adjust the single amount
  • presentment_moneyobject
    Store adjustment of display
  • amount double
    Store adjustment of display
    Example: 100
  • currency_code string
    Store adjustment of display amount currency
    Example: CNY
  • shop_moneyobject
    Store adjustment amount
  • amount double
    Store adjustment amount
    Example: 100
  • currency_code string
    Store adjust the amount currency
    Example: CYN
  • id string
    Refund adjustment single id
    Example: 2309123221222208434
  • reason string
    Adjust the reason
    Example: reason msg
  • amount string
    Adjust the single amount
    Example: 100
  • refund_id string
    Refund single id
    Example: 27057168152571061289431726
  • order_id string
    Order number
    Example: 21057168152571061289431726
  • processed_at string
    Update time (see IOS8601 for the format)
    Example: 2022-10-03T12:44:45-04:00
  • refund_line_itemsobject[]
    Refund Details
  • line_item_id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 23312553324324
  • subtotal double
    Total refund amount, precision 2
    Example: 100
  • total_tax double
    Tax amount of refunded goods, precision 2
    Example: 100
  • quantity integer
    Quantity, quantity of goods
    Example: 1
  • restock_type string
    Inventory return type , no_restock- is not returned , cancel- is cancelled , return- is returned
    Example: no_restock
  • subtotal_setobject
    Total refund amount, multi-currency information, same on seller and buyer side
  • presentment_moneyobject
    Buy side currency
  • currency_code string
    Currency
    Example: CNY
  • amount string
    Amount
    Example: 100
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: CNY
  • total_tax_setobject
    Total tax amount, multi-currency information
  • shop_moneyobject
    Sell side currency
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: CNY
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: CNY
  • id string
    Refund order number
    Example: 27057168152571061289431726
  • line_itemobject
    Product rows
  • quantity integer
    Quantity of items in the order
    Example: 1
  • price_setobject
    Product selling price , multi-currency information
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side currency
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount
    Example: 8.00
  • product_id string
    SPU serial number
    Example: 18054488231146952151833534
  • variant_id string
    Product SKU serial number
    Example: 18054488231146952151833534
  • fulfillment_service string
    Logistics company name
    Example: Go square
  • price string
    Commodity price, precision 2
    Example: 100
  • taxable boolean
    Tax or not
    Example: true
  • fulfillable_quantity integer
    Available quantity
    Example: 1
  • tax_linesobject[]
    Tax information
  • price string
    Tax, precision 2
    Example: 100
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buy side currency
  • currency_code string
    Currency
    Example: CNY
  • amount string
    Amount, Precision 2
    Example: 100
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: CNY
  • rate double
    Tax rate
    Example: 1.2
  • title string
    Headline
    Example: Headline
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: partial
  • grams double
    Weight ( grams )
    Example: 1.2
  • name string
    SKU title, same as title
    Example: Sku title
  • requires_shipping boolean
    Shipping or not
    Example: true
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: 155 / red / large
  • attribute string
    Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
    Example: Size-x
  • vendor string
    Supplier
    Example: Supplier
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 2655436734527560
  • sku string
    Product code, barCode
    Example: 18054488231146952151833534
  • title string
    Product title
    Example: Product title
  • created_at string
    Refund form creation time (see IOS8601 for the format)
    Example: 2022-10-03T12:44:45-04:00
  • user_id string
    User ID
    Example: 16576456
  • transactionsobject[]
    Refund transaction information
  • kind string
    Transaction type (authorization, capture, sale, void, refund)
    Example: refund
  • currency string
    Currency
    Example: CNY
  • processed_at string
    Creation time
    Example: 2022-10-03T12:44:45-04:00
  • status string
    Handling status, pending, failure, success, and error
    Example: success
  • user_id string
    Buyer ID
    Example: 14323434
  • created_at string
    Creation time
    Example: 2022-10-03T12:44:45-04:00
  • order_id string
    Order number
    Example: 21056836827909126061559008
  • amount string
    Refund amount , accuracy 2
    Example: 100
  • id string
    Refund ID
    Example: 10100112220607455014540963840
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— header required
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders/order_id/refunds.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.