查询退货单

需要 read_returns 权限点。
更多权限点使用信息，请参考：
访问权限。
GET https://{handle}.myshopline.com/admin/openapi/v20261201/return.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
根据提供的退货单号或订单号查询相应的退货单详情。
查询参数
  • id string
    退货单 ID，用于指定要查询的退货单的唯一标识符 ID（退货单 ID 与订单 ID 两者必须提供一个，或者两个都提供）。
    例子: 2605860580357012238342
  • order_id string
    订单 ID，用于指定要查询的订单的唯一标识符 ID（退货单 ID 与订单 ID 两者必须填写一个，或者两个都提供）。
    例子: 21058605762597644309430942
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • returnsobject[]
    退货单的详细信息。
  • id string
    退货单的唯一标识符 ID。
    例子: 2605860580357012238342
  • order_id string
    订单的唯一标识符 ID。
    例子: 21058605762597644309430942
  • return_line_itemsobject[]
    退货商品列表。
  • return_reason string
    商品行的退货原因。有效枚举值包含：
    • COLOR：颜色问题
    • DEFECTIVE：商品损坏或有缺陷
    • NOT_AS_DESCRIBED：商品与描述不符
    • OTHER：其他原因
    • SIZE_TOO_LARGE：尺寸太大
    • SIZE_TOO_SMALL：尺寸太小
    • STYLE：款式问题
    • UNWANTED：客户改变了主意
    • WRONG_ITEM：收到了错误的商品
    例子: NOT_AS_DESCRIBED
  • return_reason_note string
    商品行退货原因详细信息备注。
    例子: Product does not match the description
  • fulfillment_id string
    由退货单关联的发货单的唯一标识符 ID。
    例子: RPP5873267430525507606
  • fulfillment_line_itemobject
    退货单关联的发货单信息。
  • line_itemobject
    发货单商品行信息。
  • requires_shipping boolean
    商品是否需要发货。
    • true：需要发货
    • false：不需要发货
    例子: true
  • variant_title string
    商品属性值，多个以 " / " 分割。
    例子: L/Red
  • fulfillment_service string
    物流商名称。
    例子: Sf international
  • id string
    商品行 ID。
    例子: 405
  • title string
    该商品的标题。
    例子: It's good Product
  • tax_linesobject[]
    该商品税费信息。
  • price string
    税费金额。
    例子: 18.00
  • price_setobject
    按照店铺币种和交易币种计价的税费金额。
  • presentment_moneyobject
    买家侧币种金额信息。
  • amount string
    交易币种税费金额。
    例子: 18.00
  • currency_code string
    交易币种。该字段值为三位币种码，遵循 ISO 4217 标准。
    例子: USD
  • shop_moneyobject
    店铺币种金额信息。
  • currency_code string
    交易币种。该字段值为三位币种码，遵循 ISO 4217 标准。
    例子: USD
  • amount string
    店铺币种税费金额。
    例子: 18.00
  • rate double
    税率。该信息只做展示作用。
    例子: 0.02
  • title string
    税费说明标题。该信息只做展示作用。
    例子: CNMP
  • name string
    SKU 标题，该字段值和 title 一致。
    例子: It's good Product
  • propertiesobject[]
    商品定制信息。
  • name string
    商品定制信息名称。
    例子: Text
  • type string
    定制信息类型。有效枚举值包含:
    • text：字符类型
    • picture：图片类型
    • link：链接类型
    例子: text
  • urls array
    商品定制信息链接。
    例子: ["https://image.shopline.com"]
  • value string
    商品定制信息内容。
    例子: Freedom
  • quantity integer
    需发货的商品数量。
    例子: 20
  • fulfillment_status string
    商品行发货状态。
    • fulfilled: 已发货
    • partial: 部分发货
    • null: 未发货
    例子: fulfilled
  • grams double
    商品重量（克）。
    例子: 1
  • tags string
    商品标签，当存在多个时用逗号分隔。
    例子: sales
  • gift_card boolean
    该商品是否为礼品卡商品。
    • true：是礼品卡商品
    • false：不是礼品卡商品
    例子: true
  • variant_id string
    商品的 SKU 序列号，商品款式的唯一标识 ID。
    例子: 18056898121355865678441487
  • image_url string
    退货商品的图片链接。
    例子: https://image.shopline.com/abc.jpg
  • price string
    商品售价，商品详情页销售价格。
    例子: 100.0
  • taxable boolean
    该商品是否含税。
    • true：含税
    • fasle：不含税
    例子: true
  • attribute string
    商品属性信息：名称 - 属性值。当有多个属性值时，以逗号分隔。例如：Color-Red, Size-L。
    例子: Color-Red, Size-L
  • vendor string
    商品供应商。
    例子: Product supplier
  • sku string
    商品 SKU 序列号。
    例子: SKU1234
  • product_id string
    SPU 序列号。
    例子: 16056898121352174690861487
  • fulfillable_quantity integer
    商品行维度剩余可履约的商品数量。
    例子: 20
  • location_id string
    本地配送地点编号或普通配送地点编号。
    例子: 5327026538935748524
  • quantity integer
    发货单对应的发货数量。
    例子: 20
  • id string
    退货商品行号。
    例子: RDP5860580372212396041
  • quantity integer
    退货单对应的商品退货数量。
    例子: 20
  • return_reason string
    商品退货原因。
    例子: Reason
  • status string
    退货单状态。
    • OPEN：退货中
    • CLOSED：退货完成且已退款完成
    例子: OPEN
  • created_at string
    退货单创建时间。格式：ISO 8601。
    例子: 2024-08-31T02:20:26+08:00
    例子: 2021-08-31T02:20:26+08:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

— header required
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/return.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
根据指定的订单 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": {
              "variant_title": " YELLOW",
              "tags": "",
              "variant_id": "18056054853543945916883534",
              "grams": 900,
              "name": "Goods that do not require transportation",
              "properties": [],
              "fulfillment_service": "",
              "id": "387",
              "product_id": "16056054853539919384943534",
              "quantity": 1,
              "location_id": null,
              "gift_card": false,
              "requires_shipping": false,
              "vendor": null,
              "attribute": "Color -  YELLOW",
              "fulfillable_quantity": 0,
              "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",
              "sku": "Test202009252002010",
              "title": "Goods that do not require transportation",
              "fulfillment_status": "null",
              "price": "129.89",
              "tax_lines": [
                {
                  "price_set": {
                    "presentment_money": {
                      "amount": "6.05",
                      "currency_code": "USD"
                    },
                    "shop_money": {
                      "amount": "6.05",
                      "currency_code": "USD"
                    }
                  },
                  "rate": 0.0466,
                  "title": "product_tax",
                  "price": "6.05"
                }
              ],
              "taxable": true
            },
            "quantity": null
          },
          "id": "RDP5672367743594666094",
          "quantity": 1,
          "return_reason": null,
          "return_reason_note": null
        }
      ],
      "return_reason": null,
      "status": "CLOSED"
    }
  ]
}
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.