事件分组事件标识
returnreturn/create
当订单上创建新退货时就会发生,与资金流动无关
请求头
  • X-Shopline-Topic string required
    事件操作标识
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    签名
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    店铺域名
    Example: shophub.myshopline.com
  • X-Shopline-Shop-Id string required
    店铺id
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    商户ID
    Example: 2000001234
  • X-Shopline-API-Version string required
    版本号
    Example: v20210901
  • X-Shopline-Webhook-Id string required
    消息ID
    Example: b54557e48a5fbf7d70bcd043
请求体
  • after_sale_order_seq string
    退货单ID
    Example: 2606576826460396889110
  • created_at string
    订单更新时间,(格式见IOS8601)
    Example: 2024-07-30T19:05:13.968+0800
  • order_seq string
    订单ID
    Example: 21064997045395244145024325
  • return_line_itemsobject[]
    退货商品信息
  • fulfillment_line_itemobject
    正向发货单商品
  • line_itemobject
    商品
  • attribute string
    商品属性:名称 - 属性值
    Example: Color - RED
  • final_price string
    商品成交价
    Example: 20
  • fulfillable_quantity integer
    可发货数量
  • fulfillment_service string
    物流商名称
    Example: Yuan Tong Delivery
  • fulfillment_status string
    商品的发货状态
    Example: fulfilled
  • gift_card boolean
    是否礼品卡
  • grams double
    重量(克),涉及单位换算
    Example: 28350
  • group_id string
    商品组id
    Example: 0
  • id string
    商品快照表的id
    Example: 7889
  • image_url string
    图片url
    Example: https://www.asdlj22lljsf.com/gima.image
  • location_seq string
    取货地点唯一编号
    Example: 12123898712312
  • name string
    sku标题,同title
    Example: mock product title
  • price string
    商品售价
    Example: 200.00
  • product_id string
    spu序列号
    Example: 16065603540221212797880910
  • product_tax_linesobject[]
    商品税费信息
  • name string
    税费名称
    Example: VAT
  • price string
    税金
    Example: 1.39
  • price_setobject
    税费金额明细
  • presentment_moneyobject
    市场币种金额明细
  • amount string
    金额
    Example: 20
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    店铺币种金额明细
  • amount string
    金额
    Example: 20
  • currency_code string
    币种
    Example: USD
  • rate double
    税率
    Example: 0.0012
  • rate_percentage double
    税率百分比
  • tax_no string
    税码
    Example: 123343
  • title string
    税费名称
    Example: VAT
  • type string
    税费类型
    Example: product_tax
  • propertiesobject[]
    商品的自定义信息
  • additional string
    附加信息
  • ext_info string
    拓展信息
  • name string
    自定义属性名称
    Example: Color
  • show boolean
    是否要在前端展示
    Example: true
  • type string
    属性类型
    Example: Color
  • urls array
    url列表
    Example: https://www.asdlj22lljsf.com/mock_title
  • value string
    自定义属性值
    Example: Red
  • quantity integer
    订单中的商品数量
    Example: 3
  • requires_shipping boolean
    是否需要发货
    Example: true
  • sku string
    商品码
    Example: T20200925200122
  • tags string
    商品标签,逗号分隔
    Example: BWP,CUSTOM
  • taxable boolean
    是否收税
  • title string
    商品标题
    Example: mock product title
  • variant_id string
    商品sku序列号
    Example: 18065603540226245962750910
  • variant_title string
    商品属性值
    Example: RED
  • vendor string
    供应商
    Example: mock product vendor
  • version string
    商品版本
    Example: 0
  • quantity integer
    退货单退货数量
    Example: 1
  • order_package_seq string
    退货单关联的发货单号
    Example: 22065768243292542110023140
  • quantity integer
    退货单退货数量
    Example: 1
  • refund_detail_seq string
    退货单商品行号
    Example: RDP6576826460816319513
  • return_reason string
    商品行的退货原因: COLOR 颜色问题 DEFECTIVE 商品损坏或有缺陷 NOT_AS_DESCRIBED 商品与描述不符 OTHER 其他原因 SIZE_TOO_LARGE 尺寸太大 SIZE_TOO_SMALL 尺寸太小 STYLE 款式问题 UNWANTED 客户改变了主意 WRONG_ITEM 收到了错误的商品
    Example: this is a mock return reason
  • return_reason_note string
    商品行退货原因详细信息备注,最大支持128字符
    Example: this is a mock return reason note
  • return_reason string
    退货原因
    Example: this is a test return reason
  • status string
    退货状态:REQUESTED(请求退货)、CLOSED(退货完成且已退款完成)、OPEN(退货中)、DECLINED(拒绝退货)、CANCELED(取消退货)
    Example: OPEN
响应
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述
这篇文章对你有帮助吗?