Create a Return Fulfillment

Requires write_return access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/return/package/create.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 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

Request Body

notify_customer boolean
[]
Inform consumer true if the false is not notified or not
[]
Example: true
reverse_delivery_line_itemsobject[]
[]
Return invoice Product line information
id string
[]
Return order Product line number
[]
Example: RFIP5879597673402123274
total_quantity integer
[]
Product return quantity
[]
Example: 1
reverse_fulfillment_order_id string
[]
Return item order id
[]
Example: RFP5864594983873946674
tracking_infoobject
[]
Logistics tracking information
tracking_company string
[]
Logistics company name
[]
Example: Sf international
tracking_number string
[]
Third party tracking number
[]
Example: SF21232311
tracking_url string
[]
Logistics tracking URL
[]
Example: https://www.sf-express.com/chn/sc

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

return_packageobject
[]
Return invoice information
id string
[]
Return invoice unique business id
[]
Example: RPP5860827056427246608
return_id string
[]
Return invoice number
[]
Example: 2605864536661019862039
reverse_delivery_line_itemsobject[]
[]
Return invoice Product line list
id string
[]
Return invoice Product line number
[]
Example: RPIP5864612075310421029
quantity integer
[]
Return invoice Product quantity
[]
Example: 1
reverse_fulfillment_order_line_itemobject
[]
Return shipping list Product line information node associated with return invoice
id string
[]
Return order Product line number
[]
Example: RFIP5864536664442414108
line_itemobject
[]
Invoice Product line information
attribute string
[]
Product attribute information : name-attribute value , multiple attribute values are measured comma
[]
Example: Color-red , size-x
fulfillable_quantity integer
[]
Remaining Product number of required
[]
Example: 1
fulfillment_service string
[]
Logistics company name
[]
Example: Sf international
fulfillment_status string
[]
Product delivery status : fulfilled- shipped ; partial- partially shipped ; null- not shipped
[]
Example: fulfilled
gift_card boolean
[]
Wei for gift cards or not : false、true
[]
Example: true
grams double
[]
Product weight ( grams )
[]
Example: 1
id string
[]
Product row id
[]
Example: 405
image_url string
[]
Product link url
[]
Example: https://image.shopline.com/abc.jpg
location_id string
[]
1 ) pick up location unique no .2 ) non-local Product location information
[]
Example: 5327026538935748524
name string
[]
SKU title, same as title
[]
Example: It's good Product
price string
[]
Product selling price , Product detail page sale price
[]
Example: 100.0
product_id string
[]
Spu serial number , Product unique identification number
[]
Example: 16056898121352174690861487
propertiesobject[]
[]
Product customization information
name string
[]
Custom information object
[]
Example: Text
type string
[]
Custom information type : text、picture、link 1 ) when type is text , take name and value ;2 ) when type is picture , the display type is name , and the details of the thumb of urls to obtain Product 3 ) when type is link , support click urls to use the picture .
[]
Example: text
urls array
[]
Address link information
[]
Example: https://image.shopline.com
value string
[]
Customized information content
[]
Example: Freedom
quantity integer
[]
Product quantity
[]
Example: 1
requires_shipping boolean
[]
Product need to be shipped : false、true
[]
Example: true
sku string
[]
Merchant custom number
[]
Example: SKU1234
tags string
[]
Product tag , separated by ',' when there are multiple
[]
Example: sales
tax_linesobject[]
[]
Product tax details
price string
[]
Tax amount
[]
Example: 18.00
price_setobject
[]
Tax amount measured in store currency and transaction currency
presentment_moneyobject
[]
Transaction currency
amount string
[]
Tax amount
[]
Example: 18.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store currency
amount string
[]
Tax amount
[]
Example: 18.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 10
title string
[]
Tax name
[]
Example: CNMP
taxable boolean
[]
Product incl . : false、true
[]
Example: true
title string
[]
Gpu Product title
[]
Example: It's good Product
variant_id string
[]
Product SKU serial number
[]
Example: 18056898121355865678441487
variant_title string
[]
Product attribute value , multiple divided by " / "
[]
Example: L/Red
vendor string
[]
Product supplier
quantity integer
[]
Return order Product line quantity
[]
Example: 1
reverse_fulfillment_order_id string
[]
Related return item order number
[]
Example: RFP5864594983873946674
tracking_informationobject
[]
Logistics tracking information
tracking_company string
[]
Logistics company name
[]
Example: Sf international
tracking_number string
[]
Third party tracking number
[]
Example: SF222111011
tracking_url string
[]
Logistics tracking URL
[]
Example: https://www.sf-express.com/chn/sc

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "notify_customer": true,
  "reverse_delivery_line_items": [
    {
      "id": "RFIP5879597673402123274",
      "total_quantity": 1
    }
  ],
  "reverse_fulfillment_order_id": "RFP5864594983873946674",
  "tracking_info": {
    "tracking_company": "Sf international",
    "tracking_number": "SF21232311",
    "tracking_url": "https://www.sf-express.com/chn/sc"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/return/package/create.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