API · Agendamentos e reservas

Ligue a sua agenda ao SellViaApp.

Gira serviços, recursos, horários, indisponibilidades, vagas e reservas a partir do seu próprio software.

URL basehttps://api.sellviaapp.com/

Required headersX-API-Key + Bearer

Developer supportapi@sellviaapp.com

Início 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.

Pontos finais

Appointments & bookings

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

33 routes

GET /booking/config/get Chave + Carregador

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 Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

min_notice_minutes inteiro Optional

Minimum booking notice.

max_advance_days inteiro Optional

Maximum advance booking days.

cancellation_hours inteiro Optional

Customer cancellation deadline.

public_booking booleano Optional

Allow mobile booking.

reminders_enabled booleano Optional

Enable the reminder queue.

reminder_hours inteiro Optional

Hours before the booking.

customer_notes_enabled booleano 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 Chave + Carregador

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 Chave + Carregador

Create a main category or subcategory.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

name string Necessário

Category name.

parent_id inteiro 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 booleano Optional

Visible in the app.

sort_order inteiro 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 Chave + Carregador

Update a service category classification.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Category to update.

name string Necessário

Name.

parent_id inteiro Optional

0 for a main category.

photo_base64 string Optional

A new photo replaces the current photo.

remove_photo booleano 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 Chave + Carregador

Delete an unused category or archive it.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

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 Chave + Carregador

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 Chave + Carregador

Retrieve a service detailed description and photo gallery.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

service_id inteiro Necessário

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 Chave + Carregador

Create a service with duration, price and resources.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

name string Necessário

Service name.

category_id inteiro Optional

Main category.

subcategory_id inteiro 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 inteiro Optional

Actual booking duration, from 5 to 10080 minutes.

slot_interval_minutes inteiro Optional

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

capacity_required inteiro 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 booleano Optional

Require customer address.

resource_ids array Necessário

Eligible resource identifiers.

active booleano Optional

Visible service.

sort_order inteiro 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 Chave + Carregador

Add a photo to a service gallery.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

service_id inteiro Necessário

Service identifier.

photo_base64 string Necessário

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 Chave + Carregador

Delete a service photo.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

service_id inteiro Necessário

Service identifier.

photo_id inteiro Necessário

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 Chave + Carregador

Select the main photo shown in the mobile list.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

service_id inteiro Necessário

Service identifier.

photo_id inteiro Necessário

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 Chave + Carregador

Update a bookable service.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Service identifier.

name string Necessário

Service name.

duration_minutes inteiro Optional

Actual booking duration.

slot_interval_minutes inteiro Optional

Start-time frequency; 0 uses the service duration.

category_id inteiro Optional

Main category.

subcategory_id inteiro 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 Chave + Carregador

Delete an unused service or archive it.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

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 Chave + Carregador

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 Chave + Carregador

Create a bookable resource.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

name string Necessário

Resource name.

resource_type enum Optional

description string Optional

Resource description.

capacity inteiro Optional

Concurrent capacity.

location string Optional

Associated location.

color hex Optional

#RRGGBB

active booleano Optional

Active resource.

sort_order inteiro 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 Chave + Carregador

Update a resource.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Resource identifier.

name string Necessário

Name.

capacity inteiro 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 Chave + Carregador

Delete an unused resource or archive it.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

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 Chave + Carregador

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 Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

service_id inteiro Optional

Target service; omit or use 0 for all services.

resource_id inteiro Optional

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

weekday inteiro Necessário

1 Monday to 7 Sunday.

start_time time Necessário

HH:MM

end_time time Necessário

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 Chave + Carregador

Delete a schedule.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

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 Chave + Carregador

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 Chave + Carregador

Block a general or resource-specific period.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

resource_id inteiro Optional

Omit to block the entire business.

starts_at datetime Necessário

ISO 8601 with timezone recommended.

ends_at datetime Necessário

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 Chave + Carregador

Delete an unavailability.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

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 Chave + Carregador

List available slots and slots temporarily pending administrator confirmation.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

service_id inteiro Necessário

Bookable service.

resource_id inteiro Optional

Limit to one resource.

from_date data Optional

AAAA-MM-DD

days inteiro 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 Chave + Carregador

List authorised bookings.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

status enum Optional

limit inteiro 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 Chave + Carregador

Retrieve one booking and its history.

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

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 Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

service_id inteiro Necessário

Selected service.

resource_id inteiro Necessário

Selected resource.

starts_at datetime Necessário

Slot returned by booking/slot/list.

quantity inteiro Optional

Capacity used.

address string Optional

Required depending on the service.

customer_notes string Optional

Optional note.

customer_id inteiro Optional

Supplier token only.

customer_name string Optional

Required when no customer is linked.

customer_email e- mail 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 Chave + Carregador

Confirm a booking on the customer side.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

booking_id inteiro Necessário

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 Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

booking_id inteiro Necessário

Booking to review.

confirmation enum Necessário

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 Chave + Carregador

Reschedule or update a booking.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Booking to update.

service_id inteiro Necessário

Service.

resource_id inteiro Necessário

Resource.

starts_at datetime Necessário

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 Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

id inteiro Necessário

Booking.

status enum Necessário

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 Chave + Carregador

Cancel according to the configured deadline.

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

booking_id inteiro Necessário

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

Pontos finais

Customer payments

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

4 routes

GET /payment/config Chave + Carregador

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 Chave + Carregador

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

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

purpose_type enum Necessário

order | booking

purpose_id inteiro Necessário

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 Chave + Carregador

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

Input

Available parameters

Corpo JSON

NomeTipoRequirementDesignação das mercadorias

purpose_type enum Necessário

order | booking

purpose_id inteiro Necessário

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 Chave + Carregador

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

Input

Available parameters

URL query

NomeTipoRequirementDesignação das mercadorias

reference string Optional

SellViaApp payment reference. Otherwise provide purpose_type and purpose_id.

purpose_type enum Optional

order | booking

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

400Pedido inválido

401Autenticação necessária

403Acesso negado

404Recurso ou rota não encontrado

409Conflito de negócios

422A validação falhou

429Muitos pedidos

5xxIncidente técnico

Área de trabalho da API

Endpoint

GET

Parâmetros do URLUm parâmetro por linha: nome=valor Corpo JSONEdite os valores de exemplo antes do teste.

O código gerado contém as credenciais introduzidas. Guarde-as no servidor e nunca partilhe uma captura sem as ocultar.

Resposta da API