Order refund trial

Requires write_orders access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/orders/:order_id/refunds/calculate.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

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

shippingobject

Shipping rates
amount string

Shipping amount to be returned , double type string , accuracy 2
Example: "10.00"
full_refund boolean

Return shipping fee or not
Example: true
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"
Example: USD
refund_line_itemsobject[]

Trial Product
quantity long

Trial refund Product quantity
Example: 1
type string required

The Product to calculate belongs to , Unshipped : Product not shipped , Returned : the product has been returned
line_item_id string

Trial refund Product row id
Example: "12343423111"

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

refundobject

Trial results
total_duties_setobject

Refund total duty
presentment_moneyobject

Buyer side amount information
currency_code string

Currency
Example: "USD"
amount string

Amount
Example: 8.88
shop_moneyobject

Sell side amount information
amount string

Amount
Example: 8.88
currency_code string

Currency
Example: USD
transactonsobject[]

When the trial amount is greater than 0 , the original return system automatically returns the payment slip and amount according to the rules
amount string

payment amount, which the corresponding amount in the settlement currency of the payment order
Example: "41.89"
currency string

the currency, which the settlement currency corresponding of the payment
Example: USD
gateway string

Payment channels
Example: bogus
kind string

suggested_refund
Example: suggested_refund
maximum_refundable string

Current payment slip when the largest amount is returned
Example: "41.89"
order_id string

Order number
Example: "21056836827909126061559008"
parent_id string

Payment slip number
Example: "26056836827909126061559008"
currency string

the currency, which the settlement currency corresponding to the refund
Example: USD
refund_line_itemsobject[]

When Product should return the amount to the request for trial , return
total_tax string

Product the tax refund amount should be available
Example: "195.67"
type string

The Product to calculate belongs to , Unshipped : Product not shipped , Shipped : Product has been shipped , Returned : the product has been returned
discount_total_amount string

Product total discount amount
Example: "199.00"
line_item_id string

Product line ( Product line in ginseng )
Example: "33121216544"
price string

Product selling price
Example: "199.00"
quantity integer

Quantity ( actual can be returned )
Example: 1
subtotal string

Product should be refunded
Example: "195.67"
shippingobject

When shipping charges are required return
amount string

Order shipping
Example: "5.00"
maximum_refundable string

Maximum return shipping
Example: "10.00"
tax string

Order shipping tax
Example: "1.00"

API Explorer

Debugger

Base URL

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

ParamOptions

order_id — path required

Authorization — header required

Body

Body required

{
  "shipping": {
    "full_refund": true,
    "amount": "\"10.00\""
  },
  "currency": "USD",
  "refund_line_items": [
    {
      "type": "",
      "line_item_id": "\"12343423111\"",
      "quantity": 1
    }
  ]
}

Language

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