Partner API Documentation Help

Get free master slots

Authentication

This method does not require authentication.

Summary

Get info about free master's slots to work on tasks.

Description

This method retrieves a list of objects that represent information about master's free work slots.

You need to pass store_id query parameter to get the info.

As response you will get an object where each key represent a day of month (from today to 30 days in future). In its turn, the value of each key is an object with information by the time slot (key is a timeslot, value is boolean sign).

Date represents as string in the follow format: "YYYY-MM-DD".

Timeslot is just a 4-digit string where pairs of digits mean time of start and end of the slot.

For example, let's imagine we have the follow part of response:

{ // ..., "2024-02-14": { "1217": false, "1721": false, "0712": true }, "2024-02-15": { "1217": true, "1721": false, "0712": true }, "2024-02-16": { "1217": false, "1721": false, "0712": false }, // ..., }

It means, we have at least one free master on the each of these slots:

  1. 2024-02-14 from 7:00 to 12:00

  2. 2024-02-15 from 7:00 to 12:00

  3. 2024-02-15 from 12:00 to 17:00

And we don't have free masters on 2024-02-16.

This way you can give your clients opportunity to choose date of work on their orders.

Query Parameters

store_id: string

Id of store where you want to create an order

Response

The response data is an object of objects of this structure:

"YYYY-MM-DD": string

Object representing data of free master slots for date YYYY-MM-DD. It contains:

  • "0712": boolean. True means there is at least one free master for this date from 7:00 to 12:00.

  • "1217": boolean. True means there is at least one free master for this date from 12:00 to 17:00.

  • "1721": boolean. True means there is at least one free master for this date from 17:00 to 21:00.

Good Response example

{ "status": "ok", "statusCode": 200, "data": { // ..., "2024-02-14": { "1217": false, "1721": false, "0712": true }, "2024-02-15": { "1217": true, "1721": false, "0712": true }, "2024-02-16": { "1217": false, "1721": false, "0712": false }, // ..., } }

Bad Response Examples

http code

response example

422

see 422 ValidationError

Last modified: 09 February 2024