ASP.NET Web API Help Page

Endpoint to fetch data for the transaction report for the Filters provided.

Endpoint to fetch the payment transaction records needed to populate a CSV file.

Endpoint to fetch any configuration data for the transaction report. Provides data necessary to populate filters, search fields, default values, etc.

Gets contracts purchase history summary

Get a list of location identifiers corresponding to locations that the requesting user is an owner of

Add staff members as location owners

Delete staff members as location owners

Update location owners' IsLocked values.

Get a list of all locations that have owners set, and the LocationOwner object for each.

Get a list of all users for a subscriber that are eligible to be location owners

Called to fetch Marketplace Membership configuration for the subscriber.

Gets Marketplace Membership Dashboard configuration management information for the subscriber.

Called to Update Marketplace membership configuration for the subscriber on studio level opt-in/out.

Fetch all the marketplace membership configuration with locations, service categories and classes

update all the Marketplace membership configuration with location, service category and classes.

Get browse config

Gets service categories

Gets retail categories

Gets retail categories

Handle a change made to an entity

Fully sync all deals for a subscriber

Fully sync all classes for a subscriber

Fully sync all classes for a subscriber for the given date

This method sends the invoice email with the pdf attachment (in bytes) to the recipient(s)

This method is used to "Populate" an invoice after it has been reserved. One method of determining if an invoice has been populated is to check table Invoice.OriginalInvoiceData JSON contents and if it is not NULL, then it has been populated.

This method is used to "Populate" several invoices in a separate queue than the main Sales workflows queue. Example: AutoPay invoices will use this workflow so to not disrupt/slow down the regular sale population workflow.

Sync settings for a subscriber

Finalizes a list of reservations(classes/enrollments)

Finalizes a group of recurring reservations(classes/enrollments)

Finalizes a list of cancelled reservations(classes/enrollments)

Resend client form finalize

Finalizes a list of reservation from waitlist confirmations

Sends first-to-claim notifications to clients on a waitlist

Gets global shopping rules for the acting user at the subscriber

Raises an event to the push system

Searches for staff that are usable in carting actions (is either a sales rep, earns commissions, and/or can receive tips).

Fetches the shopping profile for a consumer

The action to handle the Stripe Platform webhook events.

The action to handle the Stripe Platform webhook events.

The action to handle the Stripe Connect webhook events.

The action to handle the Stripe Connect webhook events.

Endpoint to fetch any configuration data for the Mindbody Flex Revenue report. Provides data necessary to populate filters, default values, etc.

Endpoint to fetch data for the Mindbody Flex Revenue report for the Filters provided.

Endpoint to fetch data for the Mindbody Flex Revenue report for the export to return file.

Adds Catalog Discount Item to cart

Adds a promotion code to the cart

Update a discount item that exists in a cart

Removes a discount item from the cart

Resend appointment reminders for the givin client ids, date, and time

Finalizes a list of appointments

Resend client form with specific appointment

Called to fetch Mindbody Network configuration for the subscriber.

Called to update dynamic pricing configuration for the subscriber.

Called to update promoted deals configuration for the subscriber.

Called to update promoted deals configuration for the subscriber.

Called to update partner network configuration for the non SA subscriber(first time only).

Gets Mindbody Network configuration management information for the subscriber

Check whether studio is eligible for auto enable partner network or not

Retrieve dynamic pricing organization meta data

Add an organization

Updates an organization

Gets dynamic pricing defaults

Retrieve dynamic pricing configs data

Called to start processing for Membership Payouts billing at Zuora side. Do not use this once Aria is available for Flex Credit in PROD. The authentication for this endpoint uses the X-SERVICE-TRUST header along with your JWT i.e. X-SERVICE-TRUST: {{jwt}} We can pass ("test_request = "true") in the request header just to test connectivity to this endpoint. It will not hit Subscriber Service

Called to start processing for Membership Payouts billing at Aria side. The authentication for this endpoint uses the X-SERVICE-TRUST header along with your JWT i.e. X-SERVICE-TRUST: {{jwt}} We can pass ("test_request = "true") in the request header just to test connectivity to this endpoint. It will not hit Subscriber Service

Deprecated. Use Subscriber/{subscriberId:int}/Location/{locationId:int}/Cart/{cartId:guid}/Items2.

Adds an item to a shopping cart

Adds an item to a shopping cart

Adds an item to shopping cart via the catalog item id

Updates an item in a shopping cart

Deletes an item from a shopping cart

Retrieve a list of all amenities that can be applied to a location.

Retrieve a list of all amenities that can be applied to a location.

Retrieve a list of all amenities assigned to the location indicated.

Updates the amenities list assigned to a specific location to the amenities specified in the body.

Adds a package to a shopping cart.

For contracts with autopays, the valid payment method types are CreditCards and AccountBalance.
The CreditCard specified must be the same across all contracts. The CreditCard specified will be stored to the consumer's profile and all existing autopays will now use it as their payment method.

Updates a package in a shopping cart. Use Item endpoints to update items within a package.

For contracts with autopays, the valid payment method types are CreditCards and AccountBalance.
The CreditCard specified must be the same across all contracts. The CreditCard specified will be stored to the consumer's profile and all existing autopays will now use it as their payment method.

Deletes a package from a shopping cart

Endpoint to fetch data for the subscriber payout report for the date range specified.

Endpoint to fetch any configuration data for the subscriber payout report. For example, the first payout date is needed for populating date dropdowns.

Returns an exported CSV of the currently filtered payout report.

Called to fetch virtual Marketplace Membership configuration for the subscriber.

Gets Virtual Marketplace Membership Dashboard configuration management information for the subscriber

Called to Create Or Update Virtual membership configuration for the subscriber.

Called to Create Or Update Virtual membership Location configurations for the subscriber.

Adds schedule item to cart optionally with a payment option.
This will will attempt to associate all the schedule items passed in with the payment option provided. If at least one schedule item cannot be reconciled with the payment option, a validation failure will ocurr.

Delete schedule item in cart. Returns 404 when not found.

Update Subscriber Settings

Adds account schedule item payment to cart. Returns 409 if already in cart.

Removes cart account schedul eitem payment from cart. Returns 404 when not found. This will leave any schedule items that were linked to it within the cart.

Suggest a new service tag for an appointment

Pass in a Service Category Type instance as a staff member to find all pricing options that can pay for the id Service Category Types: • Class • Appointment • Enrollment

Builds items from a search request. The Odata options of top and skip are accepted.
OData example: $top=10&$skip=20

Gets tip item to use for tips in a cart. The item returned is meant to be reused by the client.

Prepares a catalog package for carting.

Prepares a catalog item for carting.

Get schedule item payment options for some schedule item

Get schedule item account payment options for some schedule item

Finds unpaid schedule items for a consumer

Returns a list of classes for the specified subscriber according to the dates and filters provided in the request.

Puts account contract signature. Max file size of 4MB.

Creates a new default payout account for a subscriber.

Updates a subscriber stripe payout account with the values in provided account

Fetches a subscriber stripe payout account given a subscriber id

Fetches the status of a subscriber stripe payout account. Includes eligibility status for determining the existance of a subscriber payout account and whether a subscriber can be migrated to a stripe account.

Migrates from subscribers using TSYS for dynamic pricing to a subscriber stripe payout account for dynamic pricing.

Retrieves all applicable fee rates for a subscriber.

Obtains the required fields and associated validations needed to onboard a subscriber at a country for a Stripe Payout account.

Obtains the required fields and associated bank validations needed to onboard a subscriber at a country for a Stripe Payout account.

Gets a subscriber Stripe account for an individual location.

Gets all subscriber Stripe payout accounts and their associated statuses given you have the appropriate permissions. Includes both the Stripe specific status in addition to Stripe onboarding eligibility status.

Creates a subscriber Stripe payout account for an individual location

Updates a subscriber Stripe payout account for an individual location

Manages the identity verification document submission associated with Stripe accounts

Creates a request to assign a poynt terminal. This will create the terminal if it does not exist along with the merchant account information. Warning: Please NOTE that If the terminal is already assigned to a different subscriber, all links to the previous subscriber will be REMOVED.

Creates a request to assign a poynt terminal. This will create the terminal if it does not exist along with the merchant account information. Warning: Please NOTE that If the terminal is already assigned to a different subscriber, all links to the previous subscriber will be REMOVED.

Publish message

Initializes the workflow for configuring an accounting integration; the next step in the workflow should be determined based on the Status property Examples: Status of Available means the next step is to go through the oauth linking process, Status of Initialized means the next step is to go through the mapping configuration process, Status of Configured means they can skip to the management/history step

Stores an AccountingMap for the provided subscriber Can be used to save a single map or a collection

Validates and saves the integration for the provided subscriber. If it is valid, it updates the integration status to be "Configured"

Kicks off the sync process for sales data

Kicks off the a resync request for the specified sync record. This action is idempotent in the sense that once a sync has successfully pushed all orders, calling this again for that sync will have no effect other than to confirm that the sync has been successful.

Removes the stored integration

Forces a manual refresh of any cached configuration data within the integration

Adds a new Xero tax rate. Note that the entry-point is specific to integration type, but there could potentially be multiple entry points that use the same service call.

adds payment method to a cart, using consumption amounts if provided

Deletes payment method from a cart

Updates payment items

This endpoint construct a catalog feed (a collection of catalog items). The items to include are specified by an OData filter.

OData Filtering

To specify which catalog items to include in the feed, you may include an OData $filter parameter. The available fields to filter by are described below.

• ItemType (string) - One of GiftCard, ServicePricingOption, Retail, AccountCredit, Package.

• ItemId (int) - The ID of the item.

• Name (string) - The name of the item.

• Price (Decimal) - The price of the item.

• AvailableOnline (bool) - Is the item available in the online store?

• Introductory (bool) - Is the item an introductory offer?

• ServiceCategoryId (int) - Service category ID. Not applicable to all item types.

• AppointmentTypeId (int) - Appointment type ID. Not applicable to all item types.

• LastUpdated (DateTime) - When the item was last updated.

• BarcodeId (string) - The barcode ID for the item.

• Favorite (bool) - Is the item marked as a favorite for the consumer?

• QuickCash (bool) - Is the item a Quick Cash product? Only applicable to the Retail item type.

• ProductGroupId (int) - Product group ID. Not applicable to all item types.

• HasContract (bool) - Does the package contain a contract? Applicable only to the Package item type.

• IsProfessionalProduct (bool) - Is the item a professional product? Only applicable to retail products. Professional products are never returned for non-professional consumers.

• PrimaryCategoryId (int) - Primary category for retail products.

• SecondaryCategoryId (int) - Secondary category for retail products.

• SubcategoryId (int) - Subcategory for retail products.

• PrimaryRevenueCategoryId (int) - Primary revenue category for service pricing options. Typically a negative ID.

• SecondaryRevenueCategoryId (int) - Secondary revenue category for service pricing options. Typically a negative ID.

For example, you may construct a feed containing contracts like so:

$filter=ItemType eq 'Package' and HasContract eq true

Result Ordering

Some of the above fields can also be used in an $orderby OData parameter. For example you may order by price high to low like so:

$orderby=Price desc

Creates a CatalogFeed for ServicePricingOptions or Packages with ServicePricingOptions that can be used to pay for a scheduled item

Gets the results for a CatalogFeed. This endpoint is intended to be polled. It will return Accepted if building of the CatalogFeed is still in progress.
Excessive requests to a CatalogFeed that is still in progress will cancel it and return a Gone. A completed CatalogFeed will be returned through a OK.

A CatalogFeed will have at most 250 items in it's result set.

For a page size of 20: Page 1 (skip 0, top 20), Page 2 (skip 20, top 20), Page 3 (skip 40, top 20)

This endpoint construct a catalog feed (a collection of catalog items). The items to include are specified by an OData filter.

OData Filtering

To specify which catalog items to include in the feed, you may include an OData $filter parameter. The available fields to filter by are described below.

• ItemType (string) - One of GiftCard, ServicePricingOption, Retail, AccountCredit, Package.

• ItemId (int) - The ID of the item.

• Name (string) - The name of the item.

• Price (Decimal) - The price of the item.

• AvailableOnline (bool) - Is the item available in the online store?

• Introductory (bool) - Is the item an introductory offer?

• ServiceCategoryId (int) - Service category ID. Not applicable to all item types.

• AppointmentTypeId (int) - Appointment type ID. Not applicable to all item types.

• LastUpdated (DateTime) - When the item was last updated.

• BarcodeId (string) - The barcode ID for the item.

• Favorite (bool) - Is the item marked as a favorite for the consumer?

• QuickCash (bool) - Is the item a Quick Cash product? Only applicable to the Retail item type.

• ProductGroupId (int) - Product group ID. Not applicable to all item types.

• HasContract (bool) - Does the package contain a contract? Applicable only to the Package item type.

• IsProfessionalProduct (bool) - Is the item a professional product? Only applicable to retail products. Professional products are never returned for non-professional consumers.

• PrimaryCategoryId (int) - Primary category for retail products.

• SecondaryCategoryId (int) - Secondary category for retail products.

• SubcategoryId (int) - Subcategory for retail products.

• PrimaryRevenueCategoryId (int) - Primary revenue category for service pricing options. Typically a negative ID.

• SecondaryRevenueCategoryId (int) - Secondary revenue category for service pricing options. Typically a negative ID.

For example, you may construct a feed containing contracts like so:

$filter=ItemType eq 'Package' and HasContract eq true

Result Ordering

Some of the above fields can also be used in an $orderby OData parameter. For example you may order by price high to low like so:

$orderby=Price desc

Pagination

A CatalogFeed will have at most 250 items in it's result set. Paging can be achieved with the OData $skip and $top parameters.

For a page size of 20: Page 1 ($skip 0, $top 20), Page 2 ($skip 20, $top 20), Page 3 ($skip 40, $top 20)

Resend client form with specific form Id

The ping endpoint for the application

The Status endpoint for the application

Update the opt in and enabled status of the Dynamic Pricing Configuration

Gets the Merchant Processor Configuration values for the subscriber The authentication for this endpoint uses the X-SERVICE-TRUST header along with your JWT i.e. X-SERVICE-TRUST: {{jwt}}

Creates a terminal using rest

Finds a list of terminals with optional paging support

Find a terminal by its id

Remove a terminal by its terminal id

Finds a terminal along with its merchant account links, if they exist. Results returned are ordered by the terminal external id, studio name and location id.

Get all terminal merchant accounts associated with this terminal

Gets all terminal merchant accounts, ordered by terminal external id, subscriber name and location id.

get list of terminal merchant accounts by location

Add a terminal merchant account

Delete a terminal merchant account

Adds post auth tips to an order's credit card payments. Order must not be voided or refunded. Staff members receiving tips must be configured to do so. Tip amounts must be greater than 0. Payment transactions must not already be settled. A settled payment transaction cannot be modified. PaymentMethods must be the same PaymentMethod that was used in the original order creation.

Puts order signature. Max file size of 4MB.

Attempts to start a shopping session. Will either return an existing valid cart, or create a new one.

Attempts to start a shopping session for a walk in consumer.

Checkout a cart and initiate payment processing. GetCart must be used to check payment processing status.

Returns metadata about the order and account information that is pending finalization from this cart's processing. This data is only usable if the cart successfuly processes.

Abandon Cart

Returns Cart

Attempts to change the location context of a cart

Finds current cart identifiers for a consumer. They are ordered by most recent first.

Marks the cart as participating in a client side transaction. Transaction will be completed once a cart is checked out and finalized successfully.

Gets receipts for an order. This will return all receipts requested as one response.

The request below generates a merchant copy receipt:

/Subscriber/6283/Order/123/Receipts?types[0]=Merchant

To also generate a customer copy, include a types[1]=Customer parameter.

Both receipts will be returned individually, along with a combined version separated by a page break for easy printing.

Gets account contract agreement receipt

Triggers the sending of an order receipt notification. Accepts configuration overrides