From SimplyBook.me
Enter a message name below to show all available translations.
Found one translation.
| Name | Current message text |
|---|---|
| h English (en) | Creates new booking record. Returns an object with appointment information or throw exception if booking time not available or any of required parameters missed. If appointment requires confirmation, in result object will be <code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see <code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters should be calculated according to service duration. However you can specify different values to make appointment longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code> |
