Create Change Request
Create and apply a booking change request after tool approval. This evaluates policy, pricing, and availability. For paid changes, approval attempts to charge the customer's saved card first and falls back to emailing a payment link; use approval_mode apply_now only when the customer has explicitly agreed to apply the change without payment. App connections need the booking:write scope.
curl -X POST "https://dash.lockii.app/api/v1/booking/change-request" \
-H "x-api-key: $LOCKII_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"order_id": "string",
"data": {
"startHireDate": 0,
"endHireDate": 0,
"locationID": "string",
"status": "cancelled",
"lineItems": [
{
"productID": "string",
"quantity": 0
}
]
}
}'Authorization
x-api-keystringheaderAPI key from Settings → Integrations → API.
AuthorizationstringheaderThe same API key, or an OAuth access token, sent as Authorization: Bearer.
api_keystringqueryAPI key query parameter.
Body
order_idstringrequiredInternal booking/order ID. Must be an order in this company.
dataobjectrequiredRequested booking changes
approval_modeenum<string>How to apply an approved change. Defaults to charge_and_apply for paid changes, which attempts the customer's saved card first and falls back to emailing a payment link if charging fails or no saved card exists. Use apply_now only to apply without collecting payment, and only when the customer has explicitly agreed to waive the charge.
One of:send_to_customercharge_and_applyapply_nowcancellation_refund_percentnumberFor cancellation change requests, the percentage of paid order payments to refund. Defaults to 100.
Response
JSON result for this operation.
{}