Refund created

Event GroupEvent Identification
refundsrefunds/create
Occurs whenever a refund is created, not related to 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
  • created_at string
    Refund form creation time (see IOS8601 for the format)
    Example: 2022-10-03T12:44:45-04:00
  • id string
    Refund ID
    Example: SL201AS4571669738589065294
  • note string
    Refund Notes
    Example: Notes
  • order_adjustmentsobject[]
    Adjust the order information
  • amount string
    Adjust the single amount
    Example: 100
  • amount_setobject
    Adjust the single amount
  • presentment_moneyobject
    Display amount
  • amount double
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Shop amount
  • amount double
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • id string
    Refund adjustment single id
    Example: 2309123221222208434
  • kind string
    Adjust single type
    Example: shipping_refund
  • order_id string
    Order number
    Example: 21057168152571061289431726
  • reason string
    Adjust the reason
    Example: reason msg
  • refund_id string
    Refund single id
    Example: 27057168152571061289431726
  • tax_amount string
    Adjust the single tax amount
    Example: 100
  • tax_amount_setobject
    Adjust the single tax amount
  • presentment_moneyobject
    Display amount
  • amount double
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Shop amount
  • amount double
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • order_id string
    Order number
    Example: 21057168152571061289431726
  • processed_at string
    Update time (see IOS8601 for the format)
    Example: 2022-10-03T12:44:45-04:00
  • refund_line_itemsobject[]
    Refund items Details.
  • id string
    Refund order number
    Example: 27057168152571061289431726
  • line_itemobject
    Product rows
  • attribute string
    Product attributes: name - attribute value. Multiple separated by comma ", ". For example: color - red, size - X
    Example: Size-x
  • fulfillable_quantity integer
    Available quantity
    Example: 1
  • fulfillment_quantity integer
    The quantity of products that are actually shipped.
    Example: 1
  • fulfillment_service string
    Logistics company name
    Example: Go square
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: partial
  • grams double
    Weight ( grams )
    Example: 1.2
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 2655436734527560
  • price string
    Commodity price, precision 2
    Example: 100
  • price_setobject
    Multi-currency selling price
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount
  • currency_code string
    Currency
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
  • currency_code string
    Currency
  • product_id string
    SPU serial number
    Example: 18054488231146952151833534
  • quantity integer
    Product quantity
    Example: 1
  • requires_shipping boolean
    Shipping or not
    Example: true
  • sku string
    Product code, barCode
    Example: SKU1234
  • tax_linesobject[]
    Tax information
  • price string
    Tax, precision 2
    Example: 100
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
    Example: 1.2
  • title string
    Headline
    Example: Headline
  • type string
    Tax type , product_tax : product tax ; shipping_tax : shipping tax
    Example: product_tax
  • taxable boolean
    Tax or not？
    Example: true
  • title string
    Product title
    Example: T-short
  • variant_id string
    Product SKU serial number
    Example: 18054488231146952151833534
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: 155 / red / large
  • vendor string
    Supplier
    Example: Supplier
  • line_item_id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 23312553324324
  • quantity integer
    Quantity, quantity of goods
    Example: 1
  • restock_type string
    Inventory return type, no_restock-not returned, cancel-cancelled, return-returned only not returned
    Example: no_restock
  • subtotal double
    Total refund amount, precision 2
    Example: 100
  • subtotal_setobject
    Total refund amount, multi-currency information, same on seller and buyer side
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • total_tax double
    Tax amount of refunded goods, precision 2
    Example: 100
  • total_tax_setobject
    Total tax amount, multi-currency information
  • presentment_moneyobject
    Sell side currency
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Buy side currency
  • amount string
    Amount
    Example: 100
  • currency_code string
    Currency
    Example: USD
  • transactionsobject[]
    Refund transaction information
  • amount string
    Refund amount , accuracy 2
    Example: 100
  • created_at string
    Creation time
    Example: 2022-10-03T12:44:45-04:00
  • currency string
    Currency
    Example: USD
  • id string
    Refund ID
    Example: 10100112220607455014540963840
  • kind string
    Transaction type (authorization, capture, sale, void, refund)
    Example: refund
  • order_id string
    Order number
    Example: 21056836827909126061559008
  • processed_at string
    Creation time
    Example: 2022-10-03T12:44:45-04:00
  • status string
    Handling status, pending, failure, success, and error
    Example: success
  • user_id string
    Buyer ID
    Example: 4323434
  • transactions_v2object[]
    A list of refund transactions.
  • amount string
    Transaction amount.The value is rounded to two decimal places.
    Example: 8.00
  • create_at string
    The date and time when the transaction was canceled. Format: ISO 8601.
    Example: 2021-08-16T08:27:57+00:00
  • currency string
    Transaction currency. A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • error_code string
    Payment failure reason code returned by the channel.
    Example: RISK_PENDING
  • error_msg string
    Payment failure message returned by the channel.
    Example: PENDING_REVIEW
  • gateway string
    Payment channel.
    Example: Mypay
  • id string
    Transaction ID.
    Example: 3201270375342377769857557605
  • kind string
    Transaction kind：
    • sale: Automatically captured transaction
    • authorization: Authorized transaction
    • capture: Manually captured transaction
    • void: Voided transaction
    • refund: Refunded transaction
  • payment_detailsobject
    Payment details.
  • credit_cardobject
    Card details for credit card payments.
  • credit_card_bin string
    Credit card bin.
    Example: 471110
  • credit_card_brand string
    Credit card brand.
    Example: visa
  • credit_card_expire_month string
    Credit card expiration month.
    Example: 12
  • credit_card_expire_year string
    Credit card expiration year.
    Example: 30
  • credit_card_number string
    Masked credit card number.
    Example: 471110******0000
  • pay_channel_deal_id string
    Payment serial number from the external channel.
    Example: pi_3MI897Hezv8FxjBO1uGxMPhX
  • receipt_json string
    Transaction receipt returned by the payment gateway. Note that receipt formats may vary across different payment providers. Currently, only gift card payment method information is supported in the returned data.
    Example: \"gift_card_id\":30170521219516412793210045
  • payment_method string
    Payment method.
    Example: Mypay
  • status string
    Transaction status：
    • created：Transaction has been created
    • pending：Processing by the gateway.
    • success：Transaction succeeded
    • fail：Transaction failed
  • user_id string
    User ID
    Example: 16576456
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.