DeMark API reference

Basics

Authentication

Create keys in Settings > Developers and send them in the Authorization header. A revoked key stops working at once.

dmk_live_... Secret key: only from your server. It is refused when a browser sends it.
dmk_pk_... Public key: safe in your HTML. It reads services, availability, products and events and creates bookings, requests, carts, registrations and chat turns, only from the domains you allowed.

Authorization: Bearer dmk_live_...

Errors

Every error has the same body: a generic code (unauthorized, forbidden, not_found, conflict, validation, rate_limited) and a reason in message. Validation errors list the fields.

{
  "error": {
    "code": "validation",
    "message": "invalid_fields",
    "fields": {
      "email": "invalid_email"
    }
  }
}

Pagination

Lists return data and next_cursor. Send next_cursor back as ?cursor= to get the next page; limit goes from 1 to 100 (25 by default). A null next_cursor means you reached the end.

{
  "data": [
    "..."
  ],
  "next_cursor": "MTAx"
}

Dates and times

Times are ISO 8601 with the offset of the business time zone. You can send any ISO 8601 time with an offset or Z; without one it is read in the business time zone.

Rate limits

600 requests per minute per key. Every answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; past the limit you get 429 with Retry-After.

Account

Which business and which key you are using.

GET `/api/v1/me`

The business and the key of the request

Works with a public key

Responses

200 Successful Response
401 Missing, invalid or revoked API key
403 Forbidden: key type, permission, origin or plan
429 Rate limited

Example response (200)

{
  "business": {
    "id": 12,
    "slug": "salon-ana",
    "name": "Salon Ana",
    "languages": [
      "en",
      "fr"
    ],
    "timezone": "America/Moncton",
    "currency": "CAD",
    "booking_url": "https://demarkstudio.ca/salon-ana/book",
    "site_url": "https://www.salonana.ca"
  },
  "key": {
    "name": "Website",
    "prefix": "dmk_pk_ab12c",
    "type": "public",
    "permissions": [
      "reservas",
      "solicitudes"
    ],
    "scopes": [
      "bookings:create",
      "requests:create",
      "services:read"
    ]
  }
}

Try it with curl

curl -X GET "https://demarkstudio.ca/api/v1/me" \
  -H "Authorization: Bearer dmk_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Name	In	Type	Required	Description
`lang`	query	`string \| null`	No	en or fr; without it, Accept-Language.
`cursor`	query	`string \| null`	No
`limit`	query	`integer`	No	Defaults to the maximum: most businesses fit in one page.

Name	In	Type	Required	Description
`service`	query	`integer`	Yes	Service id.
`date`	query	`string`	Yes	Local day, YYYY-MM-DD.
`staff`	query	`integer \| null`	No	Staff id; omit for anyone.
`location`	query	`string \| null`	No	Location id or slug (GET /locations); omit for the primary location.

Name	In	Type	Required	Description
`from`	query	`string \| null`	No	Start day or datetime (ISO).
`to`	query	`string \| null`	No	End day (exclusive) or datetime (ISO).
`status`	query	`string \| null`	No	pending, confirmed, cancelled, completed or no_show.
`location`	query	`integer \| null`	No	Only this location's bookings (GET /locations).
`cursor`	query	`string \| null`	No
`limit`	query	`integer`	No

Name	In	Type	Required	Description
`booking_id`	path	`integer`	Yes
`token`	query	`string \| null`	No	Management token. Required with a public key or without a key.

Name	Type	Required	Description
`start`	`string \| null`	No	New start (ISO 8601), from GET /availability/slots. Reschedules the booking: this id is cancelled and a new one is created (see the returned id). Omit to only update notes.
`notes`	`string \| null`	No
`location`	`integer \| null`	No	Move the booking to this location (GET /locations). Works like a reschedule: with start, at that time; without it, at the same time. The staff member must work there, the service's room must be one of that location's, and the time must be free there (a staff member's bookings at every location count).

Name	In	Type	Required	Description
`service_id`	query	`integer`	Yes
`from`	query	`string`	Yes	First local day, YYYY-MM-DD.
`to`	query	`string`	Yes	Last local day, YYYY-MM-DD (inclusive).
`staff_id`	query	`integer \| null`	No
`location`	query	`string \| null`	No	Location id or slug (GET /locations); omit for the primary location.

Name	Type	Required	Description
`from_booking`	`integer \| null`	No	Cancel this booking and the following ones. Omit to cancel every booking of the series that has not started yet.
`notify`	`boolean`	No	Email the customer one message with the cancelled dates.

Name	Type	Required
`name_en`	`string`	Yes
`name_fr`	`string`	No
`description_en`	`string`	No
`description_fr`	`string`	No
`duration_min`	`integer`	No
`price`	`number`	No

Name	Type	Required	Description
`type`	`string`	No	quote, contact or support.
`name`	`string`	Yes
`email`	`string`	Yes
`phone`	`string \| null`	No
`subject`	`string \| null`	No
`message`	`string`	Yes
`attachment`	`Adjunto \| null`	No
`attachments`	`array[Adjunto] \| null`	No	Up to 3 files (together with attachment).
`lang`	`string \| null`	No
`page_url`	`string \| null`	No

Name	Type	Required	Description
`items`	`array[LineaCompra]`	Yes
`customer`	`ClientePedido`	Yes
`delivery`	`string \| null`	No	pickup, shipping or digital.
`shipping_address`	`string \| null`	No
`notes`	`string \| null`	No
`lang`	`string \| null`	No

Name	In	Type	Required	Description
`product_id`	path	`integer`	Yes	Product id.
`Idempotency-Key`	header	`string`	No	Retry safely: the first 2xx response is kept 24 hours and replayed with Idempotent-Replayed: true. Same key with a different body: 422 idempotency_key_reused.

Name	Type	Required	Description
`id`	`string \| null`	No	Group id (slug). Omit it to derive it from name_en.
`name_en`	`string`	Yes
`name_fr`	`string \| null`	No	Defaults to name_en.
`mode`	`string`	No	surcharge adds amount_cents; price sets the price. At most one price group per product.
`options`	`array[OptionInput]`	Yes

Name	Type	Required	Description
`options`	`object`	Yes	One option per group: {group id: option id}.
`sku`	`string \| null`	No
`price_cents`	`integer \| null`	No	Fixed price; null = calculated from the product price and the option amounts.
`stock`	`integer \| null`	No	Own stock; null = shares the product stock.
`active`	`boolean`	No	An inactive variant is kept but cannot be bought.

Name	Type	Required	Description
`status`	`string`	Yes	preparing, ready, shipped, delivered, cancelled, refunded, or paid (only with manual_payment).
`manual_payment`	`boolean`	No	Required (true) to mark an order paid: payment taken outside DeMark. Audited.
`tracking`	`string \| null`	No	Tracking number for shipped.

Name	In	Type	Required	Description
`invoice_id`	path	`integer`	Yes
`Idempotency-Key`	header	`string`	No	Retry safely: the first 2xx response is kept 24 hours and replayed with Idempotent-Replayed: true. Same key with a different body: 422 idempotency_key_reused.

Name	Type	Required	Description
`method`	`string`	Yes
`reference`	`string \| null`	No
`paid_at`	`string \| null`	No	ISO 8601; defaults to now.

Name	Type	Required	Description
`occurrence`	`string`	Yes	Occurrence id from /events, or its date YYYY-MM-DD.
`name`	`string`	Yes
`email`	`string`	Yes
`phone`	`string \| null`	No
`seats`	`integer`	No
`lang`	`string \| null`	No

Name	Type	Required	Description
`session`	`string \| null`	No	Omit on the first turn; send back the one you get.
`message`	`string`	No
`action`	`string \| null`	No	An option id from the previous reply.
`fields`	`object \| null`	No	Form values: nombre, email, detalle.
`lang`	`string \| null`	No
`page_url`	`string \| null`	No

Name	Type	Required	Description
`id`	`integer`	Yes
`filename`	`string`	Yes
`content_type`	`string`	Yes
`size`	`integer`	Yes	Bytes.
`url`	`string`	Yes	Signed download link; no key needed until expires_at.
`expires_at`	`string`	Yes	ISO 8601; ask for the request again to get a fresh url.

Name	Type	Required	Description
`id`	`string`	Yes	Occurrence id: <event_id>-<YYYY-MM-DD>.
`event_id`	`integer`	Yes
`title`	`string`	Yes	In the requested language.
`description`	`string`	Yes
`start`	`string`	Yes
`end`	`string`	Yes
`seats_left`	`integer \| null`	Yes	null = no capacity limit.
`price`	`string \| null`	Yes
`currency`	`string`	Yes
`url`	`string`	Yes	Event page in the requested language.

API reference

Basics

Authentication

Errors

Pagination

Dates and times

Rate limits

Account

GET /api/v1/me

Responses

Bookings

GET /api/v1/services

Parameters

Responses

GET /api/v1/availability

Parameters

Responses

GET /api/v1/locations

Responses

POST /api/v1/bookings

Parameters

Request body

Responses

GET /api/v1/bookings

Parameters

Responses

GET /api/v1/bookings/{booking_id}

Parameters

Responses

DELETE /api/v1/bookings/{booking_id}

Parameters

Responses

PATCH /api/v1/bookings/{booking_id}

Parameters

Request body

Responses

GET /api/v1/availability/slots

Parameters

Responses

POST /api/v1/booking-series

Parameters

Request body

Responses

GET /api/v1/booking-series/{series_id}

Parameters

Responses

POST /api/v1/booking-series/{series_id}/cancel

Parameters

Request body

Responses

Services

POST /api/v1/services

Parameters

Request body

Responses

GET /api/v1/services/{service_id}

Parameters

Responses

PATCH /api/v1/services/{service_id}

Parameters

Request body

Responses

Requests

POST /api/v1/requests

Parameters

Request body

Responses

GET /api/v1/requests

Parameters

Responses

Customers

GET /api/v1/customers

Parameters

Responses

POST /api/v1/customers

Parameters

Request body

Responses

GET /api/v1/customers/{customer_id}

Parameters

GET `/api/v1/me`

GET `/api/v1/services`

GET `/api/v1/availability`

GET `/api/v1/locations`

POST `/api/v1/bookings`

GET `/api/v1/bookings`

GET `/api/v1/bookings/{booking_id}`

DELETE `/api/v1/bookings/{booking_id}`

PATCH `/api/v1/bookings/{booking_id}`

GET `/api/v1/availability/slots`

POST `/api/v1/booking-series`

GET `/api/v1/booking-series/{series_id}`

POST `/api/v1/booking-series/{series_id}/cancel`

POST `/api/v1/services`

GET `/api/v1/services/{service_id}`

PATCH `/api/v1/services/{service_id}`

POST `/api/v1/requests`

GET `/api/v1/requests`

GET `/api/v1/customers`

POST `/api/v1/customers`

GET `/api/v1/customers/{customer_id}`

PATCH `/api/v1/customers/{customer_id}`

GET `/api/v1/products`

POST `/api/v1/carts`

POST `/api/v1/orders`

POST `/api/v1/products`

GET `/api/v1/products/{product_id}`

PATCH `/api/v1/products/{product_id}`

POST `/api/v1/products/{product_id}/publish`

POST `/api/v1/products/{product_id}/unpublish`

POST `/api/v1/products/{product_id}/option-groups`

PATCH `/api/v1/products/{product_id}/option-groups/{group_id}`

DELETE `/api/v1/products/{product_id}/option-groups/{group_id}`

POST `/api/v1/products/{product_id}/variants`

PATCH `/api/v1/products/{product_id}/variants/{variant_id}`

GET `/api/v1/shop/policies`

GET `/api/v1/orders`

GET `/api/v1/orders/{order_id}`

PATCH `/api/v1/orders/{order_id}/status`