Body
The webhook type.
"return"
The event that triggered the webhook.
"return.created"
"return.updated"
"return.closed"
The ID of the shop that created the webhook.
12345
The Loop return ID.
"1673"
The state of the return.
Possible values:
-
open
: Requests have yet to be processed (Loop has not fully processed all the outcomes). -
cancelled
: Refers to any return requests that have been cancelled in the Loop admin. -
closed
: Typically refers to any return request/outcome that has been processed or closed manually. No further action is required for these returns. -
review
: Refers to a return that has been flagged for review.
"open"
"cancelled"
"closed"
"review"
The date and time (ISO 8601 format) when the return was created in Loop.
"2023-05-01T12:00:00Z"
Date and time (ISO 8601 format) when the return was last edited inside Loop. null
when the return has not been edited.
"2023-05-02T15:00:00Z"
null
The total cost of the return.
"48.81"
The Loop order ID.
2871
The Shopify order name.
"#47727779"
The Shopify order ID.
"58997314"
The Shopify order number.
"7078"
The Shopify number.
8078
The external Shopify order ID.
12354567890
The name of the sales channel that the order was created in.
"Example Online Store"
The email address of the Shopify customer.
"me@myself.com"
The Shopify customer's email, first name, middle name, and last name.
The original customer's shipping address or the address that the customer inputs in the case of a gift return.
The currency of the store at the time of the order.
"USD"
The value of returned line items, excluding order discounts and taxes.
"50.00"
The sum of all discounts on returned items.
"5.00"
The value of order taxes on returned line items.
"2.50"
The return total after taxes and discounts.
"47.50"
The value of total return credit (product + honored discount + tax).
"47.50"
The link to the return status page.
"https://example.loopreturns.com/#/return/b3e4764e-7adf-4b8c-802a-553305b6db49"
The value of exchange items before discounts and taxes.
"60.00"
The discount on exchange items.
"10.00"
The tax on exchange items.
"3.00"
The exchange total after taxes and discounts.
"53.00"
The total exchange items value after discounts and taxes, which is used by the customer.
"53.00"
The amount of store credit to be issued to the customer on a gift card.
"25.00"
The handling fee amount set in Loop admin.
"5.00"
The total refund value of the return.
"20.00"
The additional amount paid by customer when exchange credit total is greater than return credit total.
"10.00"
Whether or not the return is a gift return.
true
false
The breakdown of refunds across payment gateways.
Details on each label associated with the return.
Details on items being sent to Loop as part of the return.
Details about the product(s) being sent to the customer. This can be a result of an even exchange, replacements for returned items, or new purchases made through the app.
The Happy Returns shipment ID.
"SHIP-001"
The name of the carrier or N/A if the carrier has not yet been assigned.
"USPS"
"N/A"
The tracking number provided by the carrier or N/A if the carrier has not yet been assigned.
"28735625627856237856287"
"N/A"
Status of the shipment according to EasyPost:
- no shipment status
- pre_transit
- in_transit
- out_for_delivery
- delivered
- error
- failure
N/A if no label status has been provided yet.
"pre_transit"
"delivered"
The date and time (ISO 8601 format) when the last status update occurred.
N/A: label not yet updated.
"2023-05-03T16:00:00Z"
"N/A"
The Loop destination ID.
"2232"
If the return is not being sent back through boxing and shipping, this field describes the way in which the item is being returned. These are usually pick-up or drop-off options.
The value that identifies the physical package that the return is in regardless if it was returned via box & ship or a different return method.
"PKG-12345"
The return type.
"standard"
"warranty"
Response
Return a 200 status to indicate that the data was received successfully