Return Create

Event GroupEvent Identification
returnreturn/create
New returns will occur when the order is created , not associated with the flow of funds
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
  • after_sale_order_seq string
    Return id
    Example: 2606576826460396889110
  • created_at string
    Order update time , ( format see IOS8601 )
    Example: 2024-07-30T19:05:13.968+0800
  • order_seq string
    Order id
    Example: 21064997045395244145024325
  • return_line_itemsobject[]
    Return listing
  • fulfillment_line_itemobject
    Forward invoice Product
  • line_itemobject
    Product
  • attribute string
    Product attributes : name-attribute value
    Example: Color - RED
  • final_price string
    Product transaction price
    Example: 20
  • fulfillable_quantity integer
    Available quantity
  • fulfillment_service string
    Logistics company name
    Example: Yuan Tong Delivery
  • fulfillment_status string
    Product shipping status
    Example: fulfilled
  • gift_card boolean
    Gift card or not
  • grams double
    Weight ( grams ) , involving unit conversion
    Example: 28350
  • group_id string
    Item group id
    Example: 0
  • id string
    Product id for snapshot charts
    Example: 7889
  • image_url string
    Picture url
    Example: https://www.asdlj22lljsf.com/gima.image
  • location_seq string
    Unique code of pickup location
    Example: 12123898712312
  • name string
    SKU title, same as title
    Example: mock product title
  • price string
    Product selling price
    Example: 200.00
  • product_id string
    SPU serial number
    Example: 16065603540221212797880910
  • product_tax_linesobject[]
    Product tax information
  • name string
    Tax name
    Example: VAT
  • price string
    Tax
    Example: 1.39
  • price_setobject
    Tax amount details
  • presentment_moneyobject
    Market currency amount breakdown
  • amount string
    Amount
    Example: 20
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Store currency amount breakdown
  • amount string
    Amount
    Example: 20
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
    Example: 0.0012
  • rate_percentage double
    Tax %
  • tax_no string
    Tax code
    Example: 123343
  • title string
    Tax name
    Example: VAT
  • type string
    Tax type
    Example: product_tax
  • propertiesobject[]
    Product able custom information
  • additional string
    Additional information
  • ext_info string
    Expand information
  • name string
    Custom attribute name
    Example: Color
  • show boolean
    To be displayed on the front end or not
    Example: true
  • type string
    Attribute type
    Example: Color
  • urls array
    Url list
    Example: ["https://www.asdlj22lljsf.com/mock_title"]
  • value string
    Custom attribute values
    Example: Red
  • quantity integer
    Quantity of items in the order
    Example: 3
  • requires_shipping boolean
    Shipping or not
    Example: true
  • sku string
    Product yards
    Example: T20200925200122
  • tags string
    Product tag , separated by ','
    Example: BWP,CUSTOM
  • taxable boolean
    Tax or not？
  • title string
    Product title
    Example: mock product title
  • variant_id string
    Product SKU serial number
    Example: 18065603540226245962750910
  • variant_title string
    Product attribute value
    Example: RED
  • vendor string
    Supplier
    Example: mock product vendor
  • version string
    Product version
    Example: 0
  • quantity integer
    Return order return quantity
    Example: 1
  • order_package_seq string
    Invoice number associated with return order
    Example: 22065768243292542110023140
  • quantity integer
    Return order return quantity
    Example: 1
  • refund_detail_seq string
    Return order Product line number
    Example: RDP6576826460816319513
  • return_reason string
    Product line return reason : COLOR issue DEFECTIVE Product damaged or defective NOT_AS_DESCRIBED Product does not match description OTHER reason SIZE_TOO_LARGE size is too large size_TOO_SMALL size is too small STYLE issue UNWANTED customer changed idea WRONG_ITEM received wrong Product
    Example: this is a mock return reason
  • return_reason_note string
    Product line return reason details notes , maximum support 128 characters
    Example: this is a mock return reason note
  • return_reason string
    Return reason
    Example: this is a test return reason
  • status string
    Return status : REQUESTED 、CLOSED ( return is completed and refunded is completed ) 、OPEN ( in return ) 、DECLINED ( reject return ) 、CANCELED ( cancel return )
    Example: OPEN
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?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.