API · Termine und Buchungen

Verbinden Sie Ihren Kalender mit SellViaApp.

Verwalten Sie Leistungen, Ressourcen, Zeitpläne, Sperrzeiten und Buchungen direkt aus Ihrer Software.

Basis-URLhttps://api.sellviaapp.com/

Required headersX-API-Key + Bearer

Developer supportapi@sellviaapp.com

Schnellstart

Authenticate, choose a route, test.

Get the X-API-Key and generate the Bearer in Dashboard → API. Enter them below, then use “Test · Generate” on an endpoint to obtain the response and cURL, PHP 8 or JavaScript code.

X-API-Key

Bearer token

Credentials incompleteEnter the X-API-Key and Bearer token to prepare a test.

Credentials remain in memory for this page only. For a customer-related operation, add customer_id.

Keep in mindHTTPS + JSON · keep both credentials server-side · never send tokens to support.

Endpunkte

Appointments & bookings

Configure services, resources, schedules and bookings from the mobile app, an ERP or business software.

33 routes

GET /booking/config/get Schlüssel + Träger

Read booking rules and the app currency.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /booking/config/update Schlüssel + Träger

Update notice, cancellation and reminder rules. Two-step confirmation always remains active.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

min_notice_minutes Ganzzahl Optional

Minimum booking notice.

max_advance_days Ganzzahl Optional

Maximum advance booking days.

cancellation_hours Ganzzahl Optional

Customer cancellation deadline.

public_booking Boolestan Optional

Allow mobile booking.

reminders_enabled Boolestan Optional

Enable the reminder queue.

reminder_hours Ganzzahl Optional

Hours before the booking.

customer_notes_enabled Boolestan Optional

Allow customer notes.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/service-category/list Schlüssel + Träger

List service categories and subcategories.

Input

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/service-category/add Schlüssel + Träger

Create a main category or subcategory.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

name String Erforderlich

Category name.

parent_id Ganzzahl Optional

Main category identifier when creating a subcategory.

description String Optional

Optional description.

color hex Optional

#RRGGBB

photo_base64 String Optional

Single JPG, PNG or WebP photo as base64 or data URI.

photo_file_name String Optional

Optional file name.

photo_mime_type String Optional

image/jpeg | image/png | image/webp

active Boolestan Optional

Visible in the app.

sort_order Ganzzahl Optional

Display order.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /booking/service-category/update Schlüssel + Träger

Update a service category classification.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Category to update.

name String Erforderlich

Name.

parent_id Ganzzahl Optional

0 for a main category.

photo_base64 String Optional

A new photo replaces the current photo.

remove_photo Boolestan Optional

Remove the current photo.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /booking/service-category/delete Schlüssel + Träger

Delete an unused category or archive it.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

A used category will be archived.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/service/list Schlüssel + Träger

List bookable services and eligible resources.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/service/detail Schlüssel + Träger

Retrieve a service detailed description and photo gallery.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

service_id Ganzzahl Erforderlich

Service identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/service/add Schlüssel + Träger

Create a service with duration, price and resources.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

name String Erforderlich

Service name.

category_id Ganzzahl Optional

Main category.

subcategory_id Ganzzahl Optional

Subcategory belonging to category_id.

short_description String Optional

Short text shown below the title in the mobile list.

long_description String Optional

Detailed presentation shown on the service page.

booking_mode enum Optional

appointment | duration | period | capacity

duration_minutes Ganzzahl Optional

Actual booking duration, from 5 to 10080 minutes.

slot_interval_minutes Ganzzahl Optional

Start-time frequency. 0 or omitted = same as duration_minutes.

capacity_required Ganzzahl Optional

Capacity consumed by one booking.

price_type enum Optional

free | fixed | hourly | daily

price Dezimalzahl Optional

Price in the app currency.

deposit_type enum Optional

none | fixed | percent

deposit_value Dezimalzahl Optional

Amount or percentage.

location_mode enum Optional

business | customer | online | custom

address_required Boolestan Optional

Require customer address.

resource_ids array Erforderlich

Eligible resource identifiers.

active Boolestan Optional

Visible service.

sort_order Ganzzahl Optional

Display order.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/service/photo/add Schlüssel + Träger

Add a photo to a service gallery.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

service_id Ganzzahl Erforderlich

Service identifier.

photo_base64 String Erforderlich

JPG, PNG or WebP image as base64 or data URI.

file_name String Optional

File name.

mime_type String Optional

image/jpeg | image/png | image/webp

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /booking/service/photo/delete Schlüssel + Träger

Delete a service photo.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

service_id Ganzzahl Erforderlich

Service identifier.

photo_id Ganzzahl Erforderlich

Photo to delete.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /booking/service/photo/primary Schlüssel + Träger

Select the main photo shown in the mobile list.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

service_id Ganzzahl Erforderlich

Service identifier.

photo_id Ganzzahl Erforderlich

Photo used in the mobile list.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /booking/service/update Schlüssel + Träger

Update a bookable service.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Service identifier.

name String Erforderlich

Service name.

duration_minutes Ganzzahl Optional

Actual booking duration.

slot_interval_minutes Ganzzahl Optional

Start-time frequency; 0 uses the service duration.

category_id Ganzzahl Optional

Main category.

subcategory_id Ganzzahl Optional

Subcategory.

resource_ids array Optional

Complete eligible-resource list.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /booking/service/delete Schlüssel + Träger

Delete an unused service or archive it.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

A used service will be archived.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/resource/list Schlüssel + Träger

List people, rooms, vehicles, equipment and capacity resources.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/resource/add Schlüssel + Träger

Create a bookable resource.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

name String Erforderlich

Resource name.

resource_type enum Optional

description String Optional

Resource description.

capacity Ganzzahl Optional

Concurrent capacity.

location String Optional

Associated location.

color hex Optional

#RRGGBB

active Boolestan Optional

Active resource.

sort_order Ganzzahl Optional

Order.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /booking/resource/update Schlüssel + Träger

Update a resource.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Resource identifier.

name String Erforderlich

Name.

capacity Ganzzahl Optional

Concurrent capacity.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /booking/resource/delete Schlüssel + Träger

Delete an unused resource or archive it.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

A used resource will be archived.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/availability/list Schlüssel + Träger

List weekly schedules.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/availability/add Schlüssel + Träger

Add a general, service-specific or resource-specific schedule.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

service_id Ganzzahl Optional

Target service; omit or use 0 for all services.

resource_id Ganzzahl Optional

Target resource; omit or use 0 for all eligible resources.

weekday Ganzzahl Erforderlich

1 Monday to 7 Sunday.

start_time time Erforderlich

HH:MM

end_time time Erforderlich

HH:MM

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /booking/availability/delete Schlüssel + Träger

Delete a schedule.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Schedule identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/unavailability/list Schlüssel + Träger

List holidays, closures and blocked periods.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/unavailability/add Schlüssel + Träger

Block a general or resource-specific period.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

resource_id Ganzzahl Optional

Omit to block the entire business.

starts_at datetime Erforderlich

ISO 8601 with timezone recommended.

ends_at datetime Erforderlich

After starts_at.

reason String Optional

Optional reason.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /booking/unavailability/delete Schlüssel + Träger

Delete an unavailability.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Period identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/slot/list Schlüssel + Träger

List available slots and slots temporarily pending administrator confirmation.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

service_id Ganzzahl Erforderlich

Bookable service.

resource_id Ganzzahl Optional

Limit to one resource.

from_date Datum Optional

JJJJ-MM-TT

days Ganzzahl Optional

1 - 31

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/list Schlüssel + Träger

List authorised bookings.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

status enum Optional

limit Ganzzahl Optional

1 - 200

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /booking/detail Schlüssel + Träger

Retrieve one booking and its history.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Booking identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/create Schlüssel + Träger

Create and confirm the customer request; administrator approval is then still required.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

service_id Ganzzahl Erforderlich

Selected service.

resource_id Ganzzahl Erforderlich

Selected resource.

starts_at datetime Erforderlich

Slot returned by booking/slot/list.

quantity Ganzzahl Optional

Capacity used.

address String Optional

Required depending on the service.

customer_notes String Optional

Optional note.

customer_id Ganzzahl Optional

Supplier token only.

customer_name String Optional

Required when no customer is linked.

customer_email E-Mail-E-Mail-Adresse Optional

Contact address.

customer_phone String Optional

Contact phone.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/customer-confirm Schlüssel + Träger

Confirm a booking on the customer side.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

booking_id Ganzzahl Erforderlich

Booking belonging to the signed-in customer.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/admin-confirm Schlüssel + Träger

Confirm, return to pending or reject the booking on the administrator side.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

booking_id Ganzzahl Erforderlich

Booking to review.

confirmation enum Erforderlich

pending | confirmed | rejected

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /booking/update Schlüssel + Träger

Reschedule or update a booking.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Booking to update.

service_id Ganzzahl Erforderlich

Service.

resource_id Ganzzahl Erforderlich

Resource.

starts_at datetime Erforderlich

New start.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /booking/status/update Schlüssel + Träger

Advance a booking that has already been confirmed by both sides.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Booking.

status enum Erforderlich

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /booking/cancel Schlüssel + Träger

Cancel according to the configured deadline.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

booking_id Ganzzahl Erforderlich

Authorised booking.

reason String Optional

Optional reason.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Customer payments

Choose pay on delivery or open a secure Stripe payment, then retrieve its server-verified status.

4 routes

GET /payment/config Schlüssel + Träger

Retrieve the enabled Stripe payment methods and the Stripe account provider selected for the app.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /payment/checkout/create Schlüssel + Träger

Create or resume a Stripe Checkout page for an unpaid order or booking owned by the signed-in customer. A still-changeable pay-on-delivery choice is safely replaced.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

purpose_type enum Erforderlich

order | booking

purpose_id Ganzzahl Erforderlich

Identifier of the confirmed order or customer-confirmed booking.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /payment/pay-later Schlüssel + Träger

Record pay on delivery or replace a still-open Stripe payment after its session is securely checked and expired.

Input

Available parameters

JSON-Body

NameArt der ArtRequirementBeschreibung

purpose_type enum Erforderlich

order | booking

purpose_id Ganzzahl Erforderlich

Authorised order or booking identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /payment/status Schlüssel + Träger

Retrieve a payment status; only the signed Stripe webhook can confirm it as paid.

Input

Available parameters

URL query

NameArt der ArtRequirementBeschreibung

reference String Optional

SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.

purpose_type enum Optional

order | booking

purpose_id Ganzzahl Optional

Paid object identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Reference

Responses and errors

Each row has a “Parameters and responses” button showing required or optional fields, possible statuses and JSON examples. An empty list means the resource is not populated yet, not that the endpoint is down.

400Antrag auf Ungültigkeit

401Authentifizierung erforderlich

403Zugang verweigert

404Ressource oder Route nicht gefunden

409Geschäftskonflikt

422Validierung fehlgeschlagen

429Zu viele Anfragen

5xxTechnische Störung

API-Arbeitsbereich

Endpoint

GET

URL-ParameterEin Parameter pro Zeile: name=wert JSON-BodyBearbeiten Sie die Beispielwerte vor dem Test.

Der erzeugte Code enthält die eingegebenen Zugangsdaten. Bewahren Sie sie serverseitig auf und teilen Sie niemals einen ungeschwärzten Screenshot.

API-Antwort