Query Return Fulfillment

Requires read_returns access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20261201/return_package.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 .

Query return shipment order

Query Parameters

id string

Return invoice id

Example: RPP5873267430525507606
return_id string required

Return id

Example: 2605873267426331203599
reverse_fulfillment_seq string

Return item order id

Example: RFP5873267430307403795

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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

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

return_packagesobject[]

Return invoice
tracking_informationobject

Logistics information
tracking_company string

Logistics company name
Example: 5345345345
tracking_number string

Third party tracking number
Example: DHL Express (Piece ID)
tracking_url string

Logistics tracking URL
Example: http://www.dhl.com/
id string

Return invoice unique business id
Example: RPP5873267430525507605
return_id string

Associated return id
Example: 2605873267426331203599
reverse_delivery_line_itemsobject[]

Return invoice Product line information
id string

Return invoice Product line number
Example: 123
quantity integer

Return invoice Product quantity
Example: 1
return_reason string

The return reasons for the product line: COLOR(Incorrect color), DEFECTIVE(Product is damaged or defective), NOT_AS_DESCRIBED(Product does not match the description), OTHER(Other reasons), SIZE_TOO_LARGE(Size is too large), SIZE_TOO_SMALL(Size is too small), STYLE(Issues with the style), UNWANTED(Customer changed their mind), WRONG_ITEM(Received the wrong item)
Example: NOT_AS_DESCRIBED
return_reason_note string

Product line return reason detailed notes, maximum 128 characters supported
Example: Product does not match the description
reverse_fulfillment_order_line_itemobject

Return shipping list Product line information node associated with return invoice
line_itemobject

Fahuodan line information associated with invoice
variant_title string

Product attribute value , multiple divided by " / "
Example: L/Red2
taxable boolean

Product incl . : false、true
Example: true
fulfillable_quantity integer

Remaining Product number of required
Example: 1
grams double

Product weight ( grams )
Example: 1
quantity integer

Product quantity
Example: 1
product_id string

Spu serial number , Product unique identification number
Example: 16056898121352174690861487
price string

Product selling price , Product detail page sale price
Example: 100.0
attribute string

Product attribute information : name-attribute value , multiple attribute values are measured comma
Example: Color-red , size-x
title string

Gpu Product title
Example: It's good Product
requires_shipping boolean

Product need to be shipped : false、true
Example: true
variant_id string

Product SKU serial number
Example: 18056898121355865678441487
name string

SKU title, same as title
Example: It's good Product
image_url string

Product link url
Example: https://image.shopline.com/abc.jpg
gift_card boolean

Wei for gift cards or not : false、true
Example: true
fulfillment_service string

Logistics company name
Example: Sf international
vendor string

Product supplier
Example: product supplier
propertiesobject[]

Product customization information
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
name string

Custom information object
Example: Text
fulfillment_status string

Product delivery status : fulfilled- shipped ; partial- partially shipped ; null- not shipped
Example: fulfilled
tags string

Product tag , separated by ',' when there are multiple
Example: sales
id string

Product row id
Example: 405
sku string

Merchant custom number
Example: SKU1234
quantity integer

Associated return units approximately Product line quantity
Example: 2
reverse_fulfillment_seq string

Related return item order number
Example: RFP5873267430307403795

API Explorer

Debugger

Base URL

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

ParamOptions

return_id — query required

Authorization — header required

id — query

reverse_fulfillment_seq — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/return_package.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal