Mariana Tek API
Quick Start
Mariana Tek's API is REST based. We use http://jsonapi.org/ for payload structure.
Before getting started you must contact our integrations team at integrations@marianatek.com and agree to the API Terms of Service. Once completed, a member from our integrations team will contact you and help coordinate the creation of a sandbox site.
Authentication
The Admin API uses Bearer Auth in order to authenticate requests. The token that is used for authentication can be either an API Key or an access token obtained with OAuth. For details please consult our authentication documentation.
Status Codes
| Status Code | Description |
|---|---|
200 - OK
|
The request was handled successfully. |
201 - Created
|
The request was handled successfully and the resource was created. |
401 - Unauthorized
|
A valid Bearer Token was not provided for a resource that requires authentication. |
403 - Forbidden
|
The authenticated user does not have permission to perform this action. |
404 - Not Found
|
The requested resource was not found. |
422 - Unprocessable Entity
|
The request was syntactically correct, but resulted in errors. This typically happens when data validation has failed. |
429 - Too Many Requests
|
The request was throttled. Check the
Retry-After header which will indicate when you may make additional requests.
|
500 - Internal Server Error
|
The request failed due to an error in Mariana Tek. These should be rare, but if you encounter this please contact integrations@marianatek.com. |
503 - Service Unavailable
|
The server is currently unavailable due to scheduled maintenance. You should display a message indicating that the system is undergoing maintenance and try the request again. |
account_transactions
list
List account transactions
Query Parameters
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
id | |
user | |
broker | |
transaction_amount | |
transaction_currency | |
transaction_datetime | |
parent_account_transaction | |
revenue_type | |
ordering | Which field to use when ordering the results. |
create
Create an account transaction Creating an account transaction either adds or removes value from a user's account balance, which they can use to pay for orders.
Request Body
| Parameter | Description |
|---|---|
user required | |
broker | |
transaction_amount required | |
transaction_currency required | |
parent_account_transaction | |
revenue_type |
read
Retrieve an account transaction
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this account transaction. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
user | |
broker | |
transaction_amount | |
transaction_currency | |
transaction_datetime | |
parent_account_transaction | |
revenue_type | |
ordering | Which field to use when ordering the results. |
admin_versions
read
Retrieve an admin_version Represents a version of the admin ember app. Specifically the ember index file with references to the fingerprinted css and js files hosted on s3.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this admin version. |
Query Parameters
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
activate
Activate an admin_version This will set the specified version live and it will immediately start serving from the /admin route.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this admin version. |
Request Body
| Parameter | Description |
|---|---|
content required | |
active | |
activation_datetime | |
commit_hash | |
branch |
apps
bankcards
list
List bankcards
Query Parameters
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
user | |
card_type | |
is_expired | |
min_expiry_date | |
max_expiry_date | |
payment_gateway | |
partner | |
is_active | |
ordering | Which field to use when ordering the results. |
create
Create a bankcard Bankcards can be created with either valid `track1` data OR a valid combination of `number`, `expiration_month` (either M or MM), `expiration_year` (either YY or YYYY) and `ccv`. Bankcards cannot be saved without a relationship to a user. Billing address is required when saving or charging a new credit card unless `track1` data is provided and/or the broker has the `can_use_pos` permission. Valid request with `number`, `expiration_month`, `expiration_year` and `ccv`: { 'data': { 'relationships': { 'user': { 'data': { 'type': 'users', 'id': USER_ID } }, 'billing_address': { 'data': { 'type': 'billing_addresses', 'id': BILLING_ADDRESS_ID } } }, 'attributes': { 'number': '4111111111111111, 'expiration_month': '2', 'expiration_year': '2018', 'ccv': '900' }, 'type': 'bankcards' } } Valid request with `track1`: { 'data': { 'relationships': { 'user': { 'data': { 'type': 'users', 'id': USER_ID } } }, 'attributes': { 'track1': '%B4147000000000006^LAST_NAME/FIRST_NAME MIDDLE_INITIAL ^2302201145051100000000919000000?', 'ccv': '900' }, 'type': 'bankcards' } }
Request Body
| Parameter | Description |
|---|---|
billing_address | |
card_type | |
ccv | |
expiration_month | |
expiration_year | |
label | |
name | |
number | |
partner_reference | |
payment_gateway | |
track1 | |
user |
partial_update
Update a bankcard
Query Parameters
| Parameter | Description |
|---|---|
user | |
card_type | |
is_expired | |
min_expiry_date | |
max_expiry_date | |
payment_gateway | |
partner | |
is_active | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
billing_address | |
card_type | |
ccv | |
expiration_month | |
expiration_year | |
label | |
name | |
number | |
partner_reference | |
payment_gateway | |
track1 | |
user |
read
Retrieve a bankcard
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this bankcard. |
Query Parameters
| Parameter | Description |
|---|---|
user | |
card_type | |
is_expired | |
min_expiry_date | |
max_expiry_date | |
payment_gateway | |
partner | |
is_active | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a bankcard
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this bankcard. |
Query Parameters
| Parameter | Description |
|---|---|
user | |
card_type | |
is_expired | |
min_expiry_date | |
max_expiry_date | |
payment_gateway | |
partner | |
is_active | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
billing_address | |
card_type | |
ccv | |
expiration_month | |
expiration_year | |
label | |
name | |
number | |
partner_reference | |
payment_gateway | |
track1 | |
user |
delete_0
Delete a bankcard
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this bankcard. |
Query Parameters
| Parameter | Description |
|---|---|
user | |
card_type | |
is_expired | |
min_expiry_date | |
max_expiry_date | |
payment_gateway | |
partner | |
is_active | |
ordering | Which field to use when ordering the results. |
billing_addresses
partial_update
Update a billing_address
Query Parameters
| Parameter | Description |
|---|---|
id | |
first_name | |
last_name | |
city | |
state_province | |
postal_code | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
title | |
first_name | |
last_name | |
address_line1 | |
address_line2 | |
address_line3 | |
city | |
state_province | |
postal_code | |
address_sorting_code | |
country |
read
Retrieve a billing_address
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this billing address. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
first_name | |
last_name | |
city | |
state_province | |
postal_code | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a billing_address
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this billing address. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
first_name | |
last_name | |
city | |
state_province | |
postal_code | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
title | |
first_name | |
last_name | |
address_line1 | |
address_line2 | |
address_line3 | |
city | |
state_province | |
postal_code | |
address_sorting_code | |
country |
booking_limits
read
Retrieve booking limit
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this booking limit. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
is_active | |
query | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a booking limit
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this booking limit. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
is_active | |
query | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
name | |
is_active | |
reservation_limit | |
rules |
bulk_product_uploads
create
To upload a file using cURL, post something like this: curl 'http://cousteau-cycle.test.com:8000/api/bulk_product_upload' \ -F 'csv=@<Path to File>' \ -H 'Origin: http://cousteau-cycle.test.com:4200' \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Accept-Language: en-US,en;q=0.9' \ -H 'Authorization: Bearer d99jbv52qnj6vcEi2Fclbk97fEQaT' Replacing ```<Path to File>``` and use a valid Bearer token.
Request Body
| Parameter | Description |
|---|---|
file required |
read
Retrieve a single Bulk Product Upload. This will be polled by the frontend as a file is processed(i.e. is in any non-final status).
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this bulk product upload. |
Query Parameters
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
business_metrics
buy_page_sections
read
Retrieve a buy page section
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this product collection to product comparison assignment. |
Query Parameters
| Parameter | Description |
|---|---|
location | |
partner | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a buy page section
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this product collection to product comparison assignment. |
Query Parameters
| Parameter | Description |
|---|---|
location | |
partner | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
name | |
buy_page | |
products |
delete_0
Delete a buy page section
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this product collection to product comparison assignment. |
Query Parameters
| Parameter | Description |
|---|---|
location | |
partner | |
ordering | Which field to use when ordering the results. |
buy_pages
read
Retrieve a Buy Page
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this product collection. |
Query Parameters
| Parameter | Description |
|---|---|
location | |
partner | |
user_has_any_locations | |
query | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a Buy Page
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this product collection. |
Query Parameters
| Parameter | Description |
|---|---|
location | |
partner | |
user_has_any_locations | |
query | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
name | |
slug | |
sections |
cart_lines
list
List cart lines
Query Parameters
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
id | |
cart | |
line_reference | |
product | |
quantity | |
min_quantity | |
max_quantity | |
unit_price | |
min_unit_price | |
max_unit_price | |
date_created | |
query | |
ordering | Which field to use when ordering the results. |
create
Create a cart line Creating a cart line is the means of adding a product to a cart. Here is a valid request with product option information: { 'data': { 'attributes': { 'quantity': 1, 'options': [ { 'option': 'OPTION_CODE', 'value': 'OPTION_VALUE' } ], 'has_options': False, }, 'relationships': { 'cart': { 'data': { 'type': 'carts', 'id': CART_ID } }, 'partner': { 'data': { 'type': 'partners', 'id': PARTNER_ID } }, 'product': { 'data': { 'type': 'child_products', 'id': CHILD_PRODUCT_ID, } } }, 'type': 'cart_lines' } }
Request Body
| Parameter | Description |
|---|---|
cart required | |
options | |
partner required | |
product required | |
quantity |
partial_update
Modify a cart line The `product`, `partner` and `cart` relationships on a cart line instance cannot be modified, but the `quantity` attribute can be changed, and `options` can be added, updated or removed. To add an option, add a corresponding `{'option': 'OPTION_CODE', 'value': 'OPTION_VALUE'}` to the `options` list. To change the value of an option, change the `value` in the associated `{'option': 'OPTION_CODE', 'value': 'OPTION_VALUE'}` dictionary, like so: `{'option': 'OPTION_CODE', 'value': 'NEW_OPTION_VALUE'}` To remove an option, remove the entire associated `{'option': 'OPTION_CODE', 'value': 'OPTION_VALUE'}` dictionary from the `options` list. Required options cannot be removed; they can only be modified. Here is a valid request with product option information: { 'data': { 'attributes': { 'quantity': 2, 'options': [ { 'option': 'OPTION_CODE', 'value': 'NEW_OPTION_VALUE' } ], }, 'type': 'cart_lines', 'id': CART_LINE_ID } }
Query Parameters
| Parameter | Description |
|---|---|
id | |
cart | |
line_reference | |
product | |
quantity | |
min_quantity | |
max_quantity | |
unit_price | |
min_unit_price | |
max_unit_price | |
date_created | |
query | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
cart | |
options | |
partner | |
product | |
quantity |
delete
Deletion is not allowed. To remove an item from a cart, decrement a cart line's `quantity` to 0.
Query Parameters
| Parameter | Description |
|---|---|
id | |
cart | |
line_reference | |
product | |
quantity | |
min_quantity | |
max_quantity | |
unit_price | |
min_unit_price | |
max_unit_price | |
date_created | |
query | |
ordering | Which field to use when ordering the results. |
read
Retrieve a cart line
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this line. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
cart | |
line_reference | |
product | |
quantity | |
min_quantity | |
max_quantity | |
unit_price | |
min_unit_price | |
max_unit_price | |
date_created | |
query | |
ordering | Which field to use when ordering the results. |
partial_update_0
Modify a cart line The `product`, `partner` and `cart` relationships on a cart line instance cannot be modified, but the `quantity` attribute can be changed, and `options` can be added, updated or removed. To add an option, add a corresponding `{'option': 'OPTION_CODE', 'value': 'OPTION_VALUE'}` to the `options` list. To change the value of an option, change the `value` in the associated `{'option': 'OPTION_CODE', 'value': 'OPTION_VALUE'}` dictionary, like so: `{'option': 'OPTION_CODE', 'value': 'NEW_OPTION_VALUE'}` To remove an option, remove the entire associated `{'option': 'OPTION_CODE', 'value': 'OPTION_VALUE'}` dictionary from the `options` list. Required options cannot be removed; they can only be modified. Here is a valid request with product option information: { 'data': { 'attributes': { 'quantity': 2, 'options': [ { 'option': 'OPTION_CODE', 'value': 'NEW_OPTION_VALUE' } ], }, 'type': 'cart_lines', 'id': CART_LINE_ID } }
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this line. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
cart | |
line_reference | |
product | |
quantity | |
min_quantity | |
max_quantity | |
unit_price | |
min_unit_price | |
max_unit_price | |
date_created | |
query | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
cart | |
options | |
partner | |
product | |
quantity |
delete_0
Deletion is not allowed. To remove an item from a cart, decrement a cart line's `quantity` to 0.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this line. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
cart | |
line_reference | |
product | |
quantity | |
min_quantity | |
max_quantity | |
unit_price | |
min_unit_price | |
max_unit_price | |
date_created | |
query | |
ordering | Which field to use when ordering the results. |
apply_line_item_discount
Sets fields for Line Item Discounts (line_item_discount_notional_amount and line_item_discount_notional_type) on BasketLine (current object obtained from the detail URL) Here is a valid request with line item discount and basket line information: { 'data': { 'line_item_discount_notional_amount': 0.50, 'line_item_discount_notional_type': 'fixed_amount_off' } }
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this line. |
Request Body
| Parameter | Description |
|---|---|
cart required | |
options | |
partner required | |
product required | |
quantity |
clear_line_item_discount
Sets fields for Line Item Discounts (lid_notional_amount and lid_notional_type) on BasketLine to None (current object obtained from the detail URL)
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this line. |
Request Body
| Parameter | Description |
|---|---|
cart required | |
options | |
partner required | |
product required | |
quantity |
carts
list
List carts
Query Parameters
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
min_updated_datetime | |
max_updated_datetime | |
id | |
user | |
status | |
originating_partner | |
fulfillment_partner | |
has_reservation | |
for_reservation | |
for_reservation_min_updated_datetime | |
for_reservation_max_updated_datetime | |
for_reservation_id | |
for_reservation_class_session | |
for_reservation_spot | |
for_reservation_creation_date | |
for_reservation_cancel_date | |
for_reservation_reservation_type | |
for_reservation_user | |
for_reservation_broker | |
for_reservation_booked_on_behalf_of_user | |
for_reservation_check_in_date | |
for_reservation_reserved_for_guest | |
for_reservation_credit_transactions | |
for_reservation_membership_transactions | |
for_reservation_status | |
for_reservation_location | |
for_reservation_user_or_booked_on_behalf_of_user | |
for_reservation_class_session_min_updated_datetime | |
for_reservation_class_session_max_updated_datetime | |
for_reservation_class_session_class_session_type | |
for_reservation_class_session_class_tags | |
for_reservation_class_session_classroom | |
for_reservation_class_session_has_instructors | |
for_reservation_class_session_is_cancelled | |
for_reservation_class_session_hour | |
for_reservation_class_session_layout | |
for_reservation_class_session_location | |
for_reservation_class_session_max_date | |
for_reservation_class_session_max_datetime | |
for_reservation_class_session_max_end_datetime | |
for_reservation_class_session_min_date | |
for_reservation_class_session_min_datetime | |
for_reservation_class_session_min_end_datetime | |
for_reservation_class_session_public | |
for_reservation_class_session_recurring_id | |
for_reservation_class_session_week_day | |
for_reservation_class_session_region | |
for_reservation_credit_transactions_id | |
for_reservation_credit_transactions_broker | |
for_reservation_credit_transactions_credit | |
for_reservation_credit_transactions_expiration_datetime | |
for_reservation_credit_transactions_is_expired | |
for_reservation_credit_transactions_parent_credit_transaction | |
for_reservation_credit_transactions_remaining_credits_cache | |
for_reservation_credit_transactions_transaction_amount | |
for_reservation_credit_transactions_transaction_currency | |
for_reservation_credit_transactions_transaction_datetime | |
for_reservation_credit_transactions_user | |
for_reservation_credit_transactions_min_updated_datetime | |
for_reservation_credit_transactions_max_updated_datetime | |
for_reservation_membership_transactions_id | |
for_reservation_membership_transactions_transaction_amount | |
for_reservation_membership_transactions_membership_instance | |
for_reservation_membership_transactions_user | |
for_reservation_membership_transactions_broker | |
for_reservation_membership_transactions_parent_membership_transaction | |
for_reservation_membership_transactions_transaction_datetime | |
for_reservation_membership_transactions_payment_interval_start_date | |
for_reservation_membership_transactions_payment_interval_end_date | |
for_reservation_membership_transactions_min_updated_datetime | |
for_reservation_membership_transactions_max_updated_datetime | |
ordering | Which field to use when ordering the results. |
partial_update
Update a cart
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
user | |
status | |
originating_partner | |
fulfillment_partner | |
has_reservation | |
for_reservation | |
for_reservation_min_updated_datetime | |
for_reservation_max_updated_datetime | |
for_reservation_id | |
for_reservation_class_session | |
for_reservation_spot | |
for_reservation_creation_date | |
for_reservation_cancel_date | |
for_reservation_reservation_type | |
for_reservation_user | |
for_reservation_broker | |
for_reservation_booked_on_behalf_of_user | |
for_reservation_check_in_date | |
for_reservation_reserved_for_guest | |
for_reservation_credit_transactions | |
for_reservation_membership_transactions | |
for_reservation_status | |
for_reservation_location | |
for_reservation_user_or_booked_on_behalf_of_user | |
for_reservation_class_session_min_updated_datetime | |
for_reservation_class_session_max_updated_datetime | |
for_reservation_class_session_class_session_type | |
for_reservation_class_session_class_tags | |
for_reservation_class_session_classroom | |
for_reservation_class_session_has_instructors | |
for_reservation_class_session_is_cancelled | |
for_reservation_class_session_hour | |
for_reservation_class_session_layout | |
for_reservation_class_session_location | |
for_reservation_class_session_max_date | |
for_reservation_class_session_max_datetime | |
for_reservation_class_session_max_end_datetime | |
for_reservation_class_session_min_date | |
for_reservation_class_session_min_datetime | |
for_reservation_class_session_min_end_datetime | |
for_reservation_class_session_public | |
for_reservation_class_session_recurring_id | |
for_reservation_class_session_week_day | |
for_reservation_class_session_region | |
for_reservation_credit_transactions_id | |
for_reservation_credit_transactions_broker | |
for_reservation_credit_transactions_credit | |
for_reservation_credit_transactions_expiration_datetime | |
for_reservation_credit_transactions_is_expired | |
for_reservation_credit_transactions_parent_credit_transaction | |
for_reservation_credit_transactions_remaining_credits_cache | |
for_reservation_credit_transactions_transaction_amount | |
for_reservation_credit_transactions_transaction_currency | |
for_reservation_credit_transactions_transaction_datetime | |
for_reservation_credit_transactions_user | |
for_reservation_credit_transactions_min_updated_datetime | |
for_reservation_credit_transactions_max_updated_datetime | |
for_reservation_membership_transactions_id | |
for_reservation_membership_transactions_transaction_amount | |
for_reservation_membership_transactions_membership_instance | |
for_reservation_membership_transactions_user | |
for_reservation_membership_transactions_broker | |
for_reservation_membership_transactions_parent_membership_transaction | |
for_reservation_membership_transactions_transaction_datetime | |
for_reservation_membership_transactions_payment_interval_start_date | |
for_reservation_membership_transactions_payment_interval_end_date | |
for_reservation_membership_transactions_min_updated_datetime | |
for_reservation_membership_transactions_max_updated_datetime | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
broker | |
date_merged | |
date_submitted | |
for_reservation | |
fulfillment_partner | |
originating_partner | |
status | |
user |
read
Retrieve a cart Products may be added to carts by creating `cart_lines`; and then purchased using the `checkout` endpoint. Retrieving `/api/carts/self?originating_partner=<id>&fulfillment_partner=<id>` is guaranteed to return a cart for the authenticated user. Note that there are distinct carts for each originating_partner/fulfillment_partner combination.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this basket. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
user | |
status | |
originating_partner | |
fulfillment_partner | |
has_reservation | |
for_reservation | |
for_reservation_min_updated_datetime | |
for_reservation_max_updated_datetime | |
for_reservation_id | |
for_reservation_class_session | |
for_reservation_spot | |
for_reservation_creation_date | |
for_reservation_cancel_date | |
for_reservation_reservation_type | |
for_reservation_user | |
for_reservation_broker | |
for_reservation_booked_on_behalf_of_user | |
for_reservation_check_in_date | |
for_reservation_reserved_for_guest | |
for_reservation_credit_transactions | |
for_reservation_membership_transactions | |
for_reservation_status | |
for_reservation_location | |
for_reservation_user_or_booked_on_behalf_of_user | |
for_reservation_class_session_min_updated_datetime | |
for_reservation_class_session_max_updated_datetime | |
for_reservation_class_session_class_session_type | |
for_reservation_class_session_class_tags | |
for_reservation_class_session_classroom | |
for_reservation_class_session_has_instructors | |
for_reservation_class_session_is_cancelled | |
for_reservation_class_session_hour | |
for_reservation_class_session_layout | |
for_reservation_class_session_location | |
for_reservation_class_session_max_date | |
for_reservation_class_session_max_datetime | |
for_reservation_class_session_max_end_datetime | |
for_reservation_class_session_min_date | |
for_reservation_class_session_min_datetime | |
for_reservation_class_session_min_end_datetime | |
for_reservation_class_session_public | |
for_reservation_class_session_recurring_id | |
for_reservation_class_session_week_day | |
for_reservation_class_session_region | |
for_reservation_credit_transactions_id | |
for_reservation_credit_transactions_broker | |
for_reservation_credit_transactions_credit | |
for_reservation_credit_transactions_expiration_datetime | |
for_reservation_credit_transactions_is_expired | |
for_reservation_credit_transactions_parent_credit_transaction | |
for_reservation_credit_transactions_remaining_credits_cache | |
for_reservation_credit_transactions_transaction_amount | |
for_reservation_credit_transactions_transaction_currency | |
for_reservation_credit_transactions_transaction_datetime | |
for_reservation_credit_transactions_user | |
for_reservation_credit_transactions_min_updated_datetime | |
for_reservation_credit_transactions_max_updated_datetime | |
for_reservation_membership_transactions_id | |
for_reservation_membership_transactions_transaction_amount | |
for_reservation_membership_transactions_membership_instance | |
for_reservation_membership_transactions_user | |
for_reservation_membership_transactions_broker | |
for_reservation_membership_transactions_parent_membership_transaction | |
for_reservation_membership_transactions_transaction_datetime | |
for_reservation_membership_transactions_payment_interval_start_date | |
for_reservation_membership_transactions_payment_interval_end_date | |
for_reservation_membership_transactions_min_updated_datetime | |
for_reservation_membership_transactions_max_updated_datetime | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a cart
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this basket. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
user | |
status | |
originating_partner | |
fulfillment_partner | |
has_reservation | |
for_reservation | |
for_reservation_min_updated_datetime | |
for_reservation_max_updated_datetime | |
for_reservation_id | |
for_reservation_class_session | |
for_reservation_spot | |
for_reservation_creation_date | |
for_reservation_cancel_date | |
for_reservation_reservation_type | |
for_reservation_user | |
for_reservation_broker | |
for_reservation_booked_on_behalf_of_user | |
for_reservation_check_in_date | |
for_reservation_reserved_for_guest | |
for_reservation_credit_transactions | |
for_reservation_membership_transactions | |
for_reservation_status | |
for_reservation_location | |
for_reservation_user_or_booked_on_behalf_of_user | |
for_reservation_class_session_min_updated_datetime | |
for_reservation_class_session_max_updated_datetime | |
for_reservation_class_session_class_session_type | |
for_reservation_class_session_class_tags | |
for_reservation_class_session_classroom | |
for_reservation_class_session_has_instructors | |
for_reservation_class_session_is_cancelled | |
for_reservation_class_session_hour | |
for_reservation_class_session_layout | |
for_reservation_class_session_location | |
for_reservation_class_session_max_date | |
for_reservation_class_session_max_datetime | |
for_reservation_class_session_max_end_datetime | |
for_reservation_class_session_min_date | |
for_reservation_class_session_min_datetime | |
for_reservation_class_session_min_end_datetime | |
for_reservation_class_session_public | |
for_reservation_class_session_recurring_id | |
for_reservation_class_session_week_day | |
for_reservation_class_session_region | |
for_reservation_credit_transactions_id | |
for_reservation_credit_transactions_broker | |
for_reservation_credit_transactions_credit | |
for_reservation_credit_transactions_expiration_datetime | |
for_reservation_credit_transactions_is_expired | |
for_reservation_credit_transactions_parent_credit_transaction | |
for_reservation_credit_transactions_remaining_credits_cache | |
for_reservation_credit_transactions_transaction_amount | |
for_reservation_credit_transactions_transaction_currency | |
for_reservation_credit_transactions_transaction_datetime | |
for_reservation_credit_transactions_user | |
for_reservation_credit_transactions_min_updated_datetime | |
for_reservation_credit_transactions_max_updated_datetime | |
for_reservation_membership_transactions_id | |
for_reservation_membership_transactions_transaction_amount | |
for_reservation_membership_transactions_membership_instance | |
for_reservation_membership_transactions_user | |
for_reservation_membership_transactions_broker | |
for_reservation_membership_transactions_parent_membership_transaction | |
for_reservation_membership_transactions_transaction_datetime | |
for_reservation_membership_transactions_payment_interval_start_date | |
for_reservation_membership_transactions_payment_interval_end_date | |
for_reservation_membership_transactions_min_updated_datetime | |
for_reservation_membership_transactions_max_updated_datetime | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
broker | |
date_merged | |
date_submitted | |
for_reservation | |
fulfillment_partner | |
originating_partner | |
status | |
user |
apply_voucher
Apply a voucher to a cart
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this basket. |
Request Body
| Parameter | Description |
|---|---|
broker | |
date_merged | |
date_submitted | |
for_reservation | |
fulfillment_partner | |
originating_partner | |
status | |
user |
clear
Empty a cart
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this basket. |
Request Body
| Parameter | Description |
|---|---|
broker | |
date_merged | |
date_submitted | |
for_reservation | |
fulfillment_partner | |
originating_partner | |
status | |
user |
clear_vouchers
Clear any vouchers that are currently applied to the cart
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this basket. |
Request Body
| Parameter | Description |
|---|---|
broker | |
date_merged | |
date_submitted | |
for_reservation | |
fulfillment_partner | |
originating_partner | |
status | |
user |
checkouts
create
Checkout To checkout a basket and create an order, you must post to this endpoint with information about the basket you want to checkout, and a list of payments for the order. Valid payment types are `cash`, `account` and `bankcard`. Some bankcard payments require additional fields; unless `track1` data is provided, the bankcard in question is already saved, or the order broker is a POS admin, billing address information must be submitted along with the checkout request. Valid checkout request with a cash payment: { 'data': { 'relationships': { 'cart': { 'data': { 'type': 'carts', 'id': BASKET_ID } }, 'for_reservation': { # optional 'data': { 'type': 'reservations', 'id': RESERVATION_ID } } }, 'attributes': { 'payments': [ { 'type': 'cash', 'amount': '24.00' } ] }, 'type': 'checkouts' } } Valid checkout request with an account payment: { 'data': { 'relationships': { 'cart': { 'data': { 'type': 'carts', 'id': BASKET_ID } }, 'for_reservation': { # optional 'data': { 'type': 'reservations', 'id': RESERVATION_ID } } }, 'attributes': { 'payments': [ { 'type': 'account', 'amount': '24.00' } ] }, 'type': 'checkouts' } } Valid checkout request with a bankcard payment: { 'data': { 'relationships': { 'cart': { 'data': { 'type': 'carts', 'id': BASKET_ID } }, 'for_reservation': { # optional 'data': { 'type': 'reservations', 'id': RESERVATION_ID } } }, 'attributes': { 'payments': [ { 'type': 'bankcard', 'amount':'24.00', 'number': '4147000000000006', 'expiration_month': '02', 'expiration_year': '19', 'ccv': '123' } ], 'billing_address_title': 'Dr', 'billing_address_first_name': 'Clemma', 'billing_address_last_name': 'Glover', 'billing_address_line1': '868 Hermann Fort', 'billing_address_line2': 'Apt. 649', 'billing_address_city': 'East Micah', 'billing_address_state': 'WY', 'billing_address_postcode': '89237-7517', 'billing_address_country': 'US' }, 'type': 'checkouts' } }
Request Body
| Parameter | Description |
|---|---|
cart required | |
payments required | |
for_reservation | |
status | |
billing_address_title | |
billing_address_first_name | |
billing_address_last_name | |
billing_address_line1 | |
billing_address_line2 | |
billing_address_city | |
billing_address_state | |
billing_address_postcode | |
billing_address_country |
child_products
list
List child products.
Query Parameters
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
min_updated_datetime | |
max_updated_datetime | |
id | |
product_class | |
upc | |
is_discountable | |
is_public | |
structure | |
date_created | |
min_date_created | |
max_date_created | |
date_updated | |
min_date_updated | |
max_date_updated | |
query | |
simple_product_query | |
is_inventoriable | |
inventory_location | |
user_has_any_locations | |
has_stockrecords | |
credit_membership_locations | |
parent | |
credit | |
membership | |
partner | |
product_class_id | |
product_class_interface | |
product_class_default_anonymously_purchasable | |
product_class_slug | |
product_class_exclude_ids | |
product_class_exclude_slugs | |
ordering | Which field to use when ordering the results. |
create
Create is not allowed. Instead use product class-specific endpoints for product creation.
Request Body
| Parameter | Description |
|---|---|
description | |
is_discountable | This flag indicates if this product can be used in an offer or not |
slug | |
is_public | |
default_inventoriable | |
is_first_timer_only | |
parent required | |
upc | Universal Product Code (UPC) is an identifier for a product which is not specific to a particular supplier. Eg an ISBN for a book. |
sku | Stock Keeping Unit (SKU) is an identifier for a product which is specific to a particular supplier. |
partial_update
Partial update is not allowed. Instead use product class-specific endpoints for product partial updates.
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
product_class | |
upc | |
is_discountable | |
is_public | |
structure | |
date_created | |
min_date_created | |
max_date_created | |
date_updated | |
min_date_updated | |
max_date_updated | |
query | |
simple_product_query | |
is_inventoriable | |
inventory_location | |
user_has_any_locations | |
has_stockrecords | |
credit_membership_locations | |
parent | |
credit | |
membership | |
partner | |
product_class_id | |
product_class_interface | |
product_class_default_anonymously_purchasable | |
product_class_slug | |
product_class_exclude_ids | |
product_class_exclude_slugs | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
description | |
is_discountable | This flag indicates if this product can be used in an offer or not |
slug | |
is_public | |
default_inventoriable | |
is_first_timer_only | |
parent | |
upc | Universal Product Code (UPC) is an identifier for a product which is not specific to a particular supplier. Eg an ISBN for a book. |
sku | Stock Keeping Unit (SKU) is an identifier for a product which is specific to a particular supplier. |
delete
Deletion is not allowed.
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
product_class | |
upc | |
is_discountable | |
is_public | |
structure | |
date_created | |
min_date_created | |
max_date_created | |
date_updated | |
min_date_updated | |
max_date_updated | |
query | |
simple_product_query | |
is_inventoriable | |
inventory_location | |
user_has_any_locations | |
has_stockrecords | |
credit_membership_locations | |
parent | |
credit | |
membership | |
partner | |
product_class_id | |
product_class_interface | |
product_class_default_anonymously_purchasable | |
product_class_slug | |
product_class_exclude_ids | |
product_class_exclude_slugs | |
ordering | Which field to use when ordering the results. |
read
Retrieve a child product.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this child product. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
product_class | |
upc | |
is_discountable | |
is_public | |
structure | |
date_created | |
min_date_created | |
max_date_created | |
date_updated | |
min_date_updated | |
max_date_updated | |
query | |
simple_product_query | |
is_inventoriable | |
inventory_location | |
user_has_any_locations | |
has_stockrecords | |
credit_membership_locations | |
parent | |
credit | |
membership | |
partner | |
product_class_id | |
product_class_interface | |
product_class_default_anonymously_purchasable | |
product_class_slug | |
product_class_exclude_ids | |
product_class_exclude_slugs | |
ordering | Which field to use when ordering the results. |
partial_update_0
Partial update is not allowed. Instead use product class-specific endpoints for product partial updates.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this child product. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
product_class | |
upc | |
is_discountable | |
is_public | |
structure | |
date_created | |
min_date_created | |
max_date_created | |
date_updated | |
min_date_updated | |
max_date_updated | |
query | |
simple_product_query | |
is_inventoriable | |
inventory_location | |
user_has_any_locations | |
has_stockrecords | |
credit_membership_locations | |
parent | |
credit | |
membership | |
partner | |
product_class_id | |
product_class_interface | |
product_class_default_anonymously_purchasable | |
product_class_slug | |
product_class_exclude_ids | |
product_class_exclude_slugs | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
description | |
is_discountable | This flag indicates if this product can be used in an offer or not |
slug | |
is_public | |
default_inventoriable | |
is_first_timer_only | |
parent | |
upc | Universal Product Code (UPC) is an identifier for a product which is not specific to a particular supplier. Eg an ISBN for a book. |
sku | Stock Keeping Unit (SKU) is an identifier for a product which is specific to a particular supplier. |
delete_0
Deletion is not allowed.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this child product. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
id | |
product_class | |
upc | |
is_discountable | |
is_public | |
structure | |
date_created | |
min_date_created | |
max_date_created | |
date_updated | |
min_date_updated | |
max_date_updated | |
query | |
simple_product_query | |
is_inventoriable | |
inventory_location | |
user_has_any_locations | |
has_stockrecords | |
credit_membership_locations | |
parent | |
credit | |
membership | |
partner | |
product_class_id | |
product_class_interface | |
product_class_default_anonymously_purchasable | |
product_class_slug | |
product_class_exclude_ids | |
product_class_exclude_slugs | |
ordering | Which field to use when ordering the results. |
class_session_notes
list
List class_session_notes
Query Parameters
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
id | |
author | |
note_content_type | |
note_object_id | |
min_note_datetime | |
max_note_datetime | |
query | |
user | |
class_session | |
time_clock_shift | |
order | |
author_min_updated_datetime | |
author_max_updated_datetime | |
author_id | |
author_email | |
author_password | |
author_first_name | |
author_last_name | |
author_last_region | |
author_signed_waiver | |
author_membership_instances | |
author_apply_account_balance_to_fees | |
author_is_minimal | |
author_birth_date | |
author_phone_number | |
author_address_line1 | |
author_address_line2 | |
author_city | |
author_state_province | |
author_postal_code | |
author_country | |
author_gender | |
author_emergency_contact_name | |
author_emergency_contact_relationship | |
author_emergency_contact_phone | |
author_emergency_contact_email | |
author_home_location | |
author_phone_query | |
author_user_tags | |
author_exclude_ids | |
ordering | Which field to use when ordering the results. |
partial_update
Update a class_session_note
Query Parameters
| Parameter | Description |
|---|---|
id | |
author | |
note_content_type | |
note_object_id | |
min_note_datetime | |
max_note_datetime | |
query | |
user | |
class_session | |
time_clock_shift | |
order | |
author_min_updated_datetime | |
author_max_updated_datetime | |
author_id | |
author_email | |
author_password | |
author_first_name | |
author_last_name | |
author_last_region | |
author_signed_waiver | |
author_membership_instances | |
author_apply_account_balance_to_fees | |
author_is_minimal | |
author_birth_date | |
author_phone_number | |
author_address_line1 | |
author_address_line2 | |
author_city | |
author_state_province | |
author_postal_code | |
author_country | |
author_gender | |
author_emergency_contact_name | |
author_emergency_contact_relationship | |
author_emergency_contact_phone | |
author_emergency_contact_email | |
author_home_location | |
author_phone_query | |
author_user_tags | |
author_exclude_ids | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
author | |
text | |
class_session |
delete
Delete a class_session_note
Query Parameters
| Parameter | Description |
|---|---|
id | |
author | |
note_content_type | |
note_object_id | |
min_note_datetime | |
max_note_datetime | |
query | |
user | |
class_session | |
time_clock_shift | |
order | |
author_min_updated_datetime | |
author_max_updated_datetime | |
author_id | |
author_email | |
author_password | |
author_first_name | |
author_last_name | |
author_last_region | |
author_signed_waiver | |
author_membership_instances | |
author_apply_account_balance_to_fees | |
author_is_minimal | |
author_birth_date | |
author_phone_number | |
author_address_line1 | |
author_address_line2 | |
author_city | |
author_state_province | |
author_postal_code | |
author_country | |
author_gender | |
author_emergency_contact_name | |
author_emergency_contact_relationship | |
author_emergency_contact_phone | |
author_emergency_contact_email | |
author_home_location | |
author_phone_query | |
author_user_tags | |
author_exclude_ids | |
ordering | Which field to use when ordering the results. |
read
Retrieve a class_session_note Class notes provide a simple note taking mechanism. Notes currently appear in the top right corner of the class roster page.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this note. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
author | |
note_content_type | |
note_object_id | |
min_note_datetime | |
max_note_datetime | |
query | |
user | |
class_session | |
time_clock_shift | |
order | |
author_min_updated_datetime | |
author_max_updated_datetime | |
author_id | |
author_email | |
author_password | |
author_first_name | |
author_last_name | |
author_last_region | |
author_signed_waiver | |
author_membership_instances | |
author_apply_account_balance_to_fees | |
author_is_minimal | |
author_birth_date | |
author_phone_number | |
author_address_line1 | |
author_address_line2 | |
author_city | |
author_state_province | |
author_postal_code | |
author_country | |
author_gender | |
author_emergency_contact_name | |
author_emergency_contact_relationship | |
author_emergency_contact_phone | |
author_emergency_contact_email | |
author_home_location | |
author_phone_query | |
author_user_tags | |
author_exclude_ids | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a class_session_note
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this note. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
author | |
note_content_type | |
note_object_id | |
min_note_datetime | |
max_note_datetime | |
query | |
user | |
class_session | |
time_clock_shift | |
order | |
author_min_updated_datetime | |
author_max_updated_datetime | |
author_id | |
author_email | |
author_password | |
author_first_name | |
author_last_name | |
author_last_region | |
author_signed_waiver | |
author_membership_instances | |
author_apply_account_balance_to_fees | |
author_is_minimal | |
author_birth_date | |
author_phone_number | |
author_address_line1 | |
author_address_line2 | |
author_city | |
author_state_province | |
author_postal_code | |
author_country | |
author_gender | |
author_emergency_contact_name | |
author_emergency_contact_relationship | |
author_emergency_contact_phone | |
author_emergency_contact_email | |
author_home_location | |
author_phone_query | |
author_user_tags | |
author_exclude_ids | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
author | |
text | |
class_session |
delete_0
Delete a class_session_note
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this note. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
author | |
note_content_type | |
note_object_id | |
min_note_datetime | |
max_note_datetime | |
query | |
user | |
class_session | |
time_clock_shift | |
order | |
author_min_updated_datetime | |
author_max_updated_datetime | |
author_id | |
author_email | |
author_password | |
author_first_name | |
author_last_name | |
author_last_region | |
author_signed_waiver | |
author_membership_instances | |
author_apply_account_balance_to_fees | |
author_is_minimal | |
author_birth_date | |
author_phone_number | |
author_address_line1 | |
author_address_line2 | |
author_city | |
author_state_province | |
author_postal_code | |
author_country | |
author_gender | |
author_emergency_contact_name | |
author_emergency_contact_relationship | |
author_emergency_contact_phone | |
author_emergency_contact_email | |
author_home_location | |
author_phone_query | |
author_user_tags | |
author_exclude_ids | |
ordering | Which field to use when ordering the results. |
class_session_tags
read
Retrieve a class session tag
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this Class Session Tag. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
name | |
slug | |
ordering | Which field to use when ordering the results. |
class_session_types
read
Retrieve a class_session_type Class Session Types are used to categorize types of fitness classes; for example, you might have a "Hot Yoga" class type and a "Boot Camp" class type.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session type. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
name | |
query | |
enabled | |
suggested_for_location | |
suggested_for_region | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a class_session_type
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session type. |
Query Parameters
| Parameter | Description |
|---|---|
id | |
name | |
query | |
enabled | |
suggested_for_location | |
suggested_for_region | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
name | |
duration | |
description | |
enabled | |
is_live_stream |
class_sessions
list
List class_sessions
Query Parameters
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
min_updated_datetime | |
max_updated_datetime | |
class_session_type | |
class_tags | |
classroom | |
employee_public_profiles | |
has_instructors | |
is_cancelled | |
hour | |
in_listed_turf | |
layout | |
location | |
max_date | |
max_datetime | |
max_end_datetime | |
min_date | |
min_datetime | |
min_end_datetime | |
public | |
recurring_id | |
week_day | |
region | |
ordering | Which field to use when ordering the results. |
create
Create a class_session
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
partial_update
Update a class_session
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
class_session_type | |
class_tags | |
classroom | |
employee_public_profiles | |
has_instructors | |
is_cancelled | |
hour | |
in_listed_turf | |
layout | |
location | |
max_date | |
max_datetime | |
max_end_datetime | |
min_date | |
min_datetime | |
min_end_datetime | |
public | |
recurring_id | |
week_day | |
region | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
layout | |
start_date | |
start_time | |
public | |
instructors | |
class_session_type | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
delete
Destroy a class session
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
class_session_type | |
class_tags | |
classroom | |
employee_public_profiles | |
has_instructors | |
is_cancelled | |
hour | |
in_listed_turf | |
layout | |
location | |
max_date | |
max_datetime | |
max_end_datetime | |
min_date | |
min_datetime | |
min_end_datetime | |
public | |
recurring_id | |
week_day | |
region | |
ordering | Which field to use when ordering the results. |
read
Retrieve a class_session Class sessions are instances of scheduled fitness classes.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
class_session_type | |
class_tags | |
classroom | |
employee_public_profiles | |
has_instructors | |
is_cancelled | |
hour | |
in_listed_turf | |
layout | |
location | |
max_date | |
max_datetime | |
max_end_datetime | |
min_date | |
min_datetime | |
min_end_datetime | |
public | |
recurring_id | |
week_day | |
region | |
ordering | Which field to use when ordering the results. |
partial_update_0
Update a class_session
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
class_session_type | |
class_tags | |
classroom | |
employee_public_profiles | |
has_instructors | |
is_cancelled | |
hour | |
in_listed_turf | |
layout | |
location | |
max_date | |
max_datetime | |
max_end_datetime | |
min_date | |
min_datetime | |
min_end_datetime | |
public | |
recurring_id | |
week_day | |
region | |
ordering | Which field to use when ordering the results. |
Request Body
| Parameter | Description |
|---|---|
layout | |
start_date | |
start_time | |
public | |
instructors | |
class_session_type | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
delete_0
Destroy a class session
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Query Parameters
| Parameter | Description |
|---|---|
min_updated_datetime | |
max_updated_datetime | |
class_session_type | |
class_tags | |
classroom | |
employee_public_profiles | |
has_instructors | |
is_cancelled | |
hour | |
in_listed_turf | |
layout | |
location | |
max_date | |
max_datetime | |
max_end_datetime | |
min_date | |
min_datetime | |
min_end_datetime | |
public | |
recurring_id | |
week_day | |
region | |
ordering | Which field to use when ordering the results. |
archive
Archive a class_session
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
cancel
Cancel a class_session Once a class is cancelled, all active reservations in that class -- meaning both standard and waitlist reservations with statuses of 'pending' or 'checked in' -- will be cancelled, and the payment sources for those reservations will be refunded to the appropriate users, if applicable.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
check_in_all_reservations
Check in all reservations in a class_session This endpoint allows users to check in all `pending` reservations in a class
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
hold_all_spots
Hold all spots in a class_session This endpoint allows users to place a hold on all or a specified number of spots in a class session
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
hold_spot
Holds a single spot in a class session This endpoint allows users to hold a spot in a class session
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
message
Message users with active reservations in a class_session
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
release_all_holds
Release all spot holds in a class_session This endpoint allows users to release all soft spot holds in a given class session. Admin spot holds will remain in effect.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
release_hold
Release a spot in a class session This endpoint allows users to release all soft spot holds in a given class session. Admin spot holds will remain in effect.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
tag
Tag a class session Manually tag a class session.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |
live_stream_url | |
standby_capacity | |
recurring_status | |
monday | |
tuesday | |
wednesday | |
thursday | |
friday | |
saturday | |
sunday | |
recurring_end_date | |
tags | |
waitlist_capacity | |
is_auto_check_in | |
should_reuse_live_stream_url | |
booking_window_override | |
late_cancel_window_override | |
waitlist_cutoff_window_override | |
reservation_cutoff_override | |
is_free_class |
untag
Untag a class session Manually untag a class session.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this class session. |
Request Body
| Parameter | Description |
|---|---|
layout required | |
start_date required | |
start_time required | |
public | |
instructors | |
class_session_type required | |
booking_limit | |
public_note | |