When listening to yayloh events, you can receive events when
customer registers a return request
customer support processes a refund or store-credit
a return is marked as inspected in yayloh via wms
Event: return_request
{
"data": {
"retailer_id": 123,
"order_id": 1000000,
"order_number": "ORDER123456",
"return_details": [
{
"id": 10000001,
"productSku": "SKU123",
"sizeColorSku": null,
"imageUrl": "https://fakecdn.example.com/images/product-1.jpg",
"name": "Product Name A",
"quantity": 1,
"size": "M-L",
"color": null,
"sellingPrice": 52.0,
"currencyCode": "EUR",
"returnType": "return",
"reasonText": "Other",
"requestedRefundMethod": "STORE_CREDIT",
"isInStoreReturn": false,
},
{
"id": 10000002,
"productSku": "SKU124",
"sizeColorSku": null,
"imageUrl": "https://fakecdn.example.com/images/product-2.jpg",
"name": "Product Name B",
"quantity": 1,
"size": "M",
"color": null,
"sellingPrice": 27.0,
"currencyCode": "EUR",
"returnType": "claim",
"reasonText": "Other",
"requestedRefundMethod": "REFUND",
"isInStoreReturn": false,
}
],
"customer_email": "masked@example.com",
"label_url": "https://fake-storage.example.com/return_labels/label123.pdf",
"commercial_invoice_url": "https://fake-storage.example.com/invoice/Invoice123.pdf",
"tracking_url": null,
"tracking_number": "TRACK123456789",
"shipping_company": "UPS",
"oms_internal_order_id": "OMS123456789",
},
"direct_bus": true,
"event_type": "return_request",
}
When tracking status of a return parcel changes, we create a tracking event with statuses created, dropoff, transit and received.
Event: tracking
{
"data": {
"retailer_id": 123,
"order_id": 1000001,
"order_number": "ORDER654321",
"customer_email": "masked@example.com",
"tracking_url": "https://fake-shipping.example.com/tracking?code=TRACK123456789",
"tracking_number": "TRACK123456789",
"shipping_company": "UPS",
"oms_internal_order_id": "OMS987654321",
"current_status": "dropoff"
},
"direct_bus": true,
"event_type": "tracking"
}
When yayloh triggers a store credit, it creates a store_credit event.
Event: store_credit
{
"data": {
"retailer_id": 123,
"store_credit_amount": "100.00",
"discount_code": "DISCOUNT123ABC",
"customer_email": "masked@example.com",
"currency_code": "XXX"
},
"direct_bus": true,
"event_type": "store_credit"
}