Event GroupEvent Identification
return_packagereturn_package/update
When the return information (tracking number, logistics service provider) on a return shipment order is updated, you will receive a notification.
Request Headers
  • X-Shopline-Topic string required
    The unique identifier for the event.
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    The store domain.
    Example: example.myshopline.com
  • X-Shopline-Shop-Id string required
    The store ID.
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    The merchant ID.
    Example: 2000001234
  • X-Shopline-API-Version string required
    The API version.
    Example: v20250601
  • X-Shopline-Webhook-Id string required
    The ID of this Webhook event.
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • return_id string
    Return order id associated with return invoice.
    Example: 2606638933449574496270
  • reverse_delivery_id string
    Return invoice id.
    Example: RPP6638942961232558100
  • tracking_informationobject
    Return invoice tracking information.
  • tracking_company string
    For logistics companies, see the document for enumeration: https://shopline.yuque.com/docs/share/cfb1e1ca-aede-43e9-b1e6-59ab47fd7d0f?#.
    Example: SF International
  • tracking_number string
    Return shipping no .1.
    Example: SF2212334441
  • tracking_url string
    Logistics tracking URL.
    Example: https://www.sf-international.com/
  • update_at string
    Return invoice update time ( format see ISO 8601 ).
    Example: 2021-08-18T23:59:59+08:00
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?