Query returns

Requires read_returns access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/return.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 the corresponding return order details based on the provided return order ID or order ID.
Query Parameters
  • id string
    Return order ID. You must provide the return order ID, the order ID, or both.
    Example: 2605860580357012238342
  • order_id string
    Order ID. You must provide the return order ID, the order ID, or both.
    Example: 21058605762597644309430942
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
  • returnsobject[]
    A list of return order information.
  • return_reason string
    The reason for the return of the product.
    Example: Reason
  • status string
    Return order status.
    • OPEN: returning
    • CLOSED: return and refund completed
    Example: OPEN
  • created_at string
    The date and time when the return order was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2021-08-31T02:20:26+08:00
  • id string
    The unique identifier for the return order.
    Example: 2605860580357012238342
  • order_id string
    The unique identifier for the order.
    Example: 21058605762597644309430942
  • return_line_itemsobject[]
    A list of details for refunded products.
  • fulfillment_id string
    The unique identifier for the shipment order associated with the return order.
    Example: RPP5873267430525507606
  • fulfillment_line_itemobject
    Shipping message for return list association.
  • line_itemobject
    Invoice product line information.
  • product_id string
    SPU serial number.
    Example: 16056898121352174690861487
  • propertiesobject[]
    Product customization information.
  • name string
    Product customization information name.
    Example: Text
  • type string
    Custom information type. Valid values are:
    • text: text
    • picture: picture
    • link: hyperlink
    Example: text
  • urls array
    Product customization information link.
    Example: ["https://image.shopline.com"]
  • value string
    Product customization information content.
    Example: Freedom
  • sku string
    Product SKU serial number.
    Example: SKU1234
  • tags string
    Product tag, separated by commas when there are multiple.
    Example: sales
  • tax_linesobject[]
    The returned product tax information.
  • price string
    The tax amount.
    Example: 18.00
  • price_setobject
    Tax amount measured in store currency and transaction currency.
  • presentment_moneyobject
    Buyer side currency amount information.
  • currency_code string
    The transaction currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • amount string
    Tax amount in the transaction currency.
    Example: 18.00
  • shop_moneyobject
    Store currency amount information.
  • amount string
    Tax amount in the shop currency.
    Example: 18.00
  • currency_code string
    The shop currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate, for display only.
    Example: 0.02
  • title string
    The tax description title, display only.
    Example: CNMP
  • attribute string
    Product attribute information: name-attribute value. When there are multiple attribute values, they are separated by commas. For example, Color-Red, Size-L.
    Example: Color-Red, Size-L
  • image_url string
    Link to the image of the returned product.
    Example: https://image.shopline.com/abc.jpg
  • price string
    Product selling price, product detail page sale price.
    Example: 100.0
  • quantity integer
    The quantity of products that need to be shipped.
    Example: 20
  • taxable boolean
    Indicates whether the product is taxable.
    • true：taxable
    • false：not taxable
    Example: true
  • title string
    The title of the product.
    Example: It's good Product
  • variant_id string
    The SKU of the product. The unique identifier for the product style.
    Example: 18056898121355865678441487
  • variant_title string
    Product attribute value, multiple divided by " / ".
    Example: L/Red
  • fulfillment_service string
    Logistics company name.
    Example: Sf international
  • gift_card boolean
    Indicates whether the product is a gift card item.
    • true：gift card item
    • false：not a gift card item
    Example: true
  • grams double
    Product weight in grams.
    Example: 1
  • location_id string
    Local delivery location number or standard delivery location number.
    Example: 5327026538935748524
  • vendor string
    Product supplier.
    Example: Product supplier
  • id string
    Product line ID.
    Example: 405
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true：Shipping is required.
    • false：Shipping is not required.
    Example: true
  • fulfillable_quantity integer
    Remaining fulfillable quantity at product line level.
    Example: 20
  • fulfillment_status string
    Product delivery status. Valid values are:
    • fulfilled: shipped
    • partia: partially shipped
    • null: not shipped
    Example: fulfilled
  • name string
    SKU title, same as title.
    Example: It's good Product
  • quantity integer
    The quantity of products corresponding to the fulfillment shipment.
    Example: 20
  • id string
    Return product line number.
    Example: RDP5860580372212396041
  • quantity integer
    The number of products in the return order.
    Example: 20
  • return_reason string
    The return reasons for the product line. Valid values are:
    • 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
    Detailed notes on the reason for the return of the product.
    Example: Product does not match the description
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/return.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Query by specified order ID.
Response
{
  "returns": [
    {
      "created_at": "2022-11-14T02:06:13-10:00",
      "id": "2605672367742487366663",
      "order_id": "21056723668607440019421941",
      "return_line_items": [
        {
          "fulfillment_id": "22056723668675555553461941",
          "fulfillment_line_item": {
            "line_item": {
              "fulfillable_quantity": 0,
              "id": "387",
              "location_id": null,
              "sku": "Test202009252002010",
              "title": "Goods that do not require transportation",
              "attribute": "Color -  YELLOW",
              "fulfillment_status": "null",
              "gift_card": false,
              "grams": 900,
              "properties": [],
              "quantity": 1,
              "requires_shipping": false,
              "taxable": true,
              "image_url": "https://d2n979dmt31clo.cloudfront.net/image/store/3300003215/219/c0df9e7387914f97a9739514269d29c4.jpeg?w=395&h=263,https://d2n979dmt31clo.cloudfront.net/image/store/3300003215/219/49bde8461ca648ab966be7505f6cf2f4.jpeg?w=500&h=375",
              "name": "Goods that do not require transportation",
              "product_id": "16056054853539919384943534",
              "tags": "",
              "tax_lines": [
                {
                  "price": "6.05",
                  "price_set": {
                    "shop_money": {
                      "amount": "6.05",
                      "currency_code": "USD"
                    },
                    "presentment_money": {
                      "amount": "6.05",
                      "currency_code": "USD"
                    }
                  },
                  "rate": 0.0466,
                  "title": "product_tax"
                }
              ],
              "variant_id": "18056054853543945916883534",
              "fulfillment_service": "",
              "price": "129.89",
              "variant_title": " YELLOW",
              "vendor": null
            },
            "quantity": null
          },
          "id": "RDP5672367743594666094",
          "quantity": 1,
          "return_reason": null,
          "return_reason_note": null
        }
      ],
      "return_reason": null,
      "status": "CLOSED"
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.