API referenceWebhook events
order.returned
A booking was marked returned. Lockii POSTs this body to every webhook URL registered for the company whose stored event types include order.returned, or whose stored value is *. Respond with any 2xx.
Body
application/json
companyIdstringrequiredCompany that owns the record.
eventTypeenum<string>requiredOne of:order.returnedpayloadobjectrequiredBooking fields formatted the same way as customer message variables. Dates and the total are display strings in the company timezone and currency.
Example payload
{
"companyId": "string",
"eventType": "order.returned",
"payload": {
"company": {
"color": "string",
"contact_address": "string",
"contact_email": "string",
"contact_phone": "string",
"link_color": "string",
"name": "string"
},
"customer": {
"email": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"verification_link": "string",
"verified": "string"
},
"location": {
"address": "string",
"address_multiline": "string",
"apple_maps_link": "string",
"google_maps_link": "string",
"id": "string",
"name": "string",
"review_link": "string"
},
"order": {
"addon_ids": "string",
"auto_extended_till": "string",
"edit_link": "string",
"end_hire": "string",
"end_hire_date": "string",
"end_hire_time": "string",
"extend_link": "string",
"location_id": "string",
"number": 0,
"order_link": "string",
"positive_experience": "string",
"product_ids": "string",
"return_link": "string",
"start_hire": "string",
"start_hire_date": "string",
"start_hire_time": "string",
"stock_ids": "string",
"total": "string"
},
"product": {
"access_code_list": "string",
"product_list": "string",
"stock_identifier": "string"
},
"happyReturn": true
}
}Your response
200
Any 2xx acknowledges the delivery. Any other response is treated as a failure.