API ReferenceBookings

Retrieve booking configuration

Read availability and appointment settings for a booking variant.

Returns weekly availability, duration, capacity, notice windows, conflict scope, calendar connection references, meeting behavior, and reminders. Provider credentials are never returned.

GET
/v2/products/{product}/variants/{variant}/booking

Authorization

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

product*string

The booking product ID or slug.

variant*integer

The variant path parameter.

Header Parameters

X-STORE?string

Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/products/41/variants/73/booking" \  -H "X-STORE: launch-lab"
{
  "data": {
    "product_id": 41,
    "product_variant_id": 73,
    "mode": "native",
    "conflict_scope": "variant",
    "timezone": "Europe/London",
    "duration_minutes": 60,
    "capacity_per_slot": 1,
    "min_notice_minutes": 1440,
    "max_advance_days": 60,
    "buffer_before_minutes": 0,
    "buffer_after_minutes": 0,
    "availability": [
      {
        "day": 1,
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      {
        "day": 2,
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      {
        "day": 3,
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      {
        "day": 4,
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      {
        "day": 5,
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      {
        "day": 6,
        "enabled": false,
        "start": "09:00",
        "end": "17:00"
      },
      {
        "day": 7,
        "enabled": false,
        "start": "09:00",
        "end": "17:00"
      }
    ],
    "provider_connection_ids": [],
    "video_provider": "none",
    "video_provider_connection_id": null,
    "reminders_enabled": false,
    "reminder_offset_value": 1,
    "reminder_offset_unit": "hours",
    "meta": null
  }
}
{
  "type": "invalid_request_error",
  "code": "bad_request",
  "message": "The request could not be understood.",
  "status": 400,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#bad-request"
}
{
  "type": "authentication_error",
  "code": "unauthenticated",
  "message": "Unauthenticated.",
  "status": 401,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}
{
  "type": "authorization_error",
  "code": "forbidden",
  "message": "This action is unauthorized.",
  "status": 403,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#forbidden"
}
{
  "type": "not_found_error",
  "code": "resource_not_found",
  "message": "Not Found.",
  "status": 404,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}
{
  "type": "validation_error",
  "code": "validation_failed",
  "message": "The selected product variant id is invalid.",
  "status": 422,
  "param": "product_variant_id",
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#validation-failed",
  "errors": {
    "product_variant_id": [
      "The selected product variant id is invalid."
    ]
  }
}
{
  "type": "rate_limit_error",
  "code": "rate_limit_exceeded",
  "message": "Too Many Attempts.",
  "status": 429,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}
{
  "type": "api_error",
  "code": "api_error",
  "message": "Server Error",
  "status": 500,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#api-error"
}