Query order specify of your money back order

Requires read_orders access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/orders/:order_id/refunds/:refund_id.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
refund_id string required
[]
Refund single id
[]
Example: 22057168152571061289431726

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

refundobject
[]
Refund order
created_at string
[]
Refund form creation time (see IOS8601 for the format)
[]
Example: 2022-10-03T12:44:45-04:00
id string
[]
Refund ID
[]
Example: SL201AS4571669738589065294
note string
[]
Refund Notes
[]
Example: Notes
order_adjustmentsobject[]
[]
Adjust the order information
amount string
[]
Adjust the single amount
[]
Example: 100
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
kind string
[]
Adjust single type
[]
Example: shipping_refund
order_id string
[]
Order number
[]
Example: 21057168152571061289431726
reason string
[]
Adjust the reason
[]
Example: reason msg
refund_id string
[]
Refund single id
[]
Example: 27057168152571061289431726
tax_amount string
[]
Adjust the single tax amount
[]
Example: 100
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
amount double
[]
Store adjusts the amount of single tax
[]
Example: 9.9
currency_code string
[]
Store adjustment of single tax currency
[]
Example: CNY
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
id string
[]
Refund order number
[]
Example: 27057168152571061289431726
line_itemobject
[]
Product rows
attribute string
[]
Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
[]
Example: Size-x
fulfillable_quantity integer
[]
Available quantity
[]
Example: 1
fulfillment_service string
[]
Logistics company name
[]
Example: Go square
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
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 2655436734527560
name string
[]
SKU title, same as title
[]
Example: Sku title
price string
[]
Commodity price, precision 2
[]
Example: 100
price_setobject
[]
Product selling price , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
currency_code string
[]
Currency
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
currency_code string
[]
Currency
product_id string
[]
SPU serial number
[]
Example: 18054488231146952151833534
quantity integer
[]
Quantity of items in the order
[]
Example: 1
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product code, barCode
[]
Example: 18054488231146952151833534
tax_linesobject[]
[]
Tax information
price string
[]
Tax, precision 2
[]
Example: 100
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount, Precision 2
[]
Example: 100
currency_code string
[]
Currency
[]
Example: CNY
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
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: Product title
variant_id string
[]
Product SKU serial number
[]
Example: 18054488231146952151833534
variant_title string
[]
Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
[]
Example: 155 / red / large
vendor string
[]
Supplier
[]
Example: Supplier
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
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 double
[]
Total refund amount, precision 2
[]
Example: 100
subtotal_setobject
[]
Total refund amount, multi-currency information, same on seller and buyer side
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 100
currency_code string
[]
Currency
[]
Example: CNY
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 100
currency_code string
[]
Currency
[]
Example: CNY
total_tax double
[]
Tax amount of refunded goods, precision 2
[]
Example: 100
total_tax_setobject
[]
Total tax amount, multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 100
currency_code string
[]
Currency
[]
Example: CNY
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 100
currency_code string
[]
Currency
[]
Example: CNY
total_duties_setobject
[]
Refund total duty
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
currency_code string
[]
Currency
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
currency_code string
[]
Currency
transactionsobject[]
[]
Refund transaction information
amount string
[]
Refund amount , accuracy 2
[]
Example: 100
created_at string
[]
Creation time
[]
Example: 2022-10-03T12:44:45-04:00
currency string
[]
Currency
[]
Example: CNY
id string
[]
Refund ID
[]
Example: 10100112220607455014540963840
kind string
[]
Transaction type (authorization, capture, sale, void, refund)
[]
Example: refund
order_id string
[]
Order number
[]
Example: 21056836827909126061559008
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: "4323434
user_id string
[]
User ID
[]
Example: 16576456

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

order_id — path required

refund_id — path required

Authorization — header required

Language

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

Legal