API · Citas y reservas

Conecta tu agenda con SellViaApp.

Gestiona servicios, recursos, horarios, indisponibilidades, franjas y reservas desde tu propio software.

Base URLhttps://api.sellviaapp.com/

Required headersX-API-Key + Bearer

Developer supportapi@sellviaapp.com

Inicio rápido

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.

Puntos finales

Appointments & bookings

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

33 routes

GET /booking/config/get Llav + portador

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 Llav + portador

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

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

min_notice_minutes entero Optional

Minimum booking notice.

max_advance_days entero Optional

Maximum advance booking days.

cancellation_hours entero Optional

Customer cancellation deadline.

public_booking boolean Optional

Allow mobile booking.

reminders_enabled boolean Optional

Enable the reminder queue.

reminder_hours entero Optional

Hours before the booking.

customer_notes_enabled boolean 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 Llav + portador

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 Llav + portador

Create a main category or subcategory.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

name cuerda Necesidad

Category name.

parent_id entero Optional

Main category identifier when creating a subcategory.

description cuerda Optional

Optional description.

color hex Optional

#RRGGBB

photo_base64 cuerda Optional

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

photo_file_name cuerda Optional

Optional file name.

photo_mime_type cuerda Optional

image/jpeg | image/png | image/webp

active boolean Optional

Visible in the app.

sort_order entero 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 Llav + portador

Update a service category classification.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Category to update.

name cuerda Necesidad

Name.

parent_id entero Optional

0 for a main category.

photo_base64 cuerda Optional

A new photo replaces the current photo.

remove_photo boolean 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 Llav + portador

Delete an unused category or archive it.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

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 Llav + portador

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 Llav + portador

Retrieve a service detailed description and photo gallery.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

service_id entero Necesidad

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 Llav + portador

Create a service with duration, price and resources.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

name cuerda Necesidad

Service name.

category_id entero Optional

Main category.

subcategory_id entero Optional

Subcategory belonging to category_id.

short_description cuerda Optional

Short text shown below the title in the mobile list.

long_description cuerda Optional

Detailed presentation shown on the service page.

booking_mode enum Optional

appointment | duration | period | capacity

duration_minutes entero Optional

Actual booking duration, from 5 to 10080 minutes.

slot_interval_minutes entero Optional

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

capacity_required entero Optional

Capacity consumed by one booking.

price_type enum Optional

free | fixed | hourly | daily

price decimal Optional

Price in the app currency.

deposit_type enum Optional

none | fixed | percent

deposit_value decimal Optional

Amount or percentage.

location_mode enum Optional

business | customer | online | custom

address_required boolean Optional

Require customer address.

resource_ids array Necesidad

Eligible resource identifiers.

active boolean Optional

Visible service.

sort_order entero 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 Llav + portador

Add a photo to a service gallery.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

service_id entero Necesidad

Service identifier.

photo_base64 cuerda Necesidad

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

file_name cuerda Optional

File name.

mime_type cuerda 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 Llav + portador

Delete a service photo.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

service_id entero Necesidad

Service identifier.

photo_id entero Necesidad

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 Llav + portador

Select the main photo shown in the mobile list.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

service_id entero Necesidad

Service identifier.

photo_id entero Necesidad

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 Llav + portador

Update a bookable service.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Service identifier.

name cuerda Necesidad

Service name.

duration_minutes entero Optional

Actual booking duration.

slot_interval_minutes entero Optional

Start-time frequency; 0 uses the service duration.

category_id entero Optional

Main category.

subcategory_id entero 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 Llav + portador

Delete an unused service or archive it.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

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 Llav + portador

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 Llav + portador

Create a bookable resource.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

name cuerda Necesidad

Resource name.

resource_type enum Optional

description cuerda Optional

Resource description.

capacity entero Optional

Concurrent capacity.

location cuerda Optional

Associated location.

color hex Optional

#RRGGBB

active boolean Optional

Active resource.

sort_order entero 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 Llav + portador

Update a resource.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Resource identifier.

name cuerda Necesidad

Name.

capacity entero 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 Llav + portador

Delete an unused resource or archive it.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

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 Llav + portador

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 Llav + portador

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

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

service_id entero Optional

Target service; omit or use 0 for all services.

resource_id entero Optional

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

weekday entero Necesidad

1 Monday to 7 Sunday.

start_time time Necesidad

HH:MM

end_time time Necesidad

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 Llav + portador

Delete a schedule.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

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 Llav + portador

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 Llav + portador

Block a general or resource-specific period.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

resource_id entero Optional

Omit to block the entire business.

starts_at datetime Necesidad

ISO 8601 with timezone recommended.

ends_at datetime Necesidad

After starts_at.

reason cuerda 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 Llav + portador

Delete an unavailability.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

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 Llav + portador

List available slots and slots temporarily pending administrator confirmation.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

service_id entero Necesidad

Bookable service.

resource_id entero Optional

Limit to one resource.

from_date Fecha Optional

YYYY-MM-DD

days entero 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 Llav + portador

List authorised bookings.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

status enum Optional

limit entero 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 Llav + portador

Retrieve one booking and its history.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

id entero Necesidad

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 Llav + portador

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

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

service_id entero Necesidad

Selected service.

resource_id entero Necesidad

Selected resource.

starts_at datetime Necesidad

Slot returned by booking/slot/list.

quantity entero Optional

Capacity used.

address cuerda Optional

Required depending on the service.

customer_notes cuerda Optional

Optional note.

customer_id entero Optional

Supplier token only.

customer_name cuerda Optional

Required when no customer is linked.

customer_email email Optional

Contact address.

customer_phone cuerda 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 Llav + portador

Confirm a booking on the customer side.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

booking_id entero Necesidad

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 Llav + portador

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

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

booking_id entero Necesidad

Booking to review.

confirmation enum Necesidad

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 Llav + portador

Reschedule or update a booking.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Booking to update.

service_id entero Necesidad

Service.

resource_id entero Necesidad

Resource.

starts_at datetime Necesidad

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 Llav + portador

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

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Booking.

status enum Necesidad

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 Llav + portador

Cancel according to the configured deadline.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

booking_id entero Necesidad

Authorised booking.

reason cuerda 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"
        }
    }
}

Puntos finales

Customer payments

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

4 routes

GET /payment/config Llav + portador

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 Llav + portador

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

Cuerpo JSON

NombreTipoRequirementDescripción

purpose_type enum Necesidad

order | booking

purpose_id entero Necesidad

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 Llav + portador

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

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

purpose_type enum Necesidad

order | booking

purpose_id entero Necesidad

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 Llav + portador

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

Input

Available parameters

URL query

NombreTipoRequirementDescripción

reference cuerda Optional

SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.

purpose_type enum Optional

order | booking

purpose_id entero 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.

400Solicitud de invalidez

401Autenticación necesaria

403Acceso denegado

404Recursos o ruta no encontrada

409Conflicto comercial

422Falló la validación

429Demasiadas solicitudes

5xxIncidencia técnica

Entorno de trabajo API

Endpoint

GET

Parámetros de URLUn parámetro por línea: nombre=valor Cuerpo JSONModifica los valores de ejemplo antes de probar.

El código generado contiene las credenciales introducidas. Guárdalas en el servidor y nunca compartas una captura sin ocultarlas.

Respuesta de la API