Access Gamma Web API Help Page

This allows a list of mail orders to be created in the system by passing the details in the objects within the body of the request.

Gets a list of event details within a date range which are assigned to a resource view, it can also show a list of available dates for the event.

Gets a list of events within a date range, can select a single event by ID, it can also show the event products if specified.

Gets a list of events within a date range, can be filtered by a view name for a group of events, it can also show the event products if specified.

Gets a list of what's on items to display what up coming events are set-up for the site.

Allows an event to be update or created by passing an APIEvent within the body.

Saves a given Shopify order and creates a corresponding sale.

Saves a given Shopify order refund and creates a corresponding sale in Gamma.

This will return a full list of active EPOS users within the system as a datatable.

Returns a list of valid vouchers based on a date range

Clear the WebUsed flag for a Gift Voucher, allowing it to be used online. ONLY if it hasn't already been redeemed against a sale.

Allows a voucher to be checked against a list of products, to check if a discount can be applied to the price of the products.

Allows a voucher to be updated or created by passing an APIVoucher within the body, containing the valid details to create or update.

Returns a list of valid vouchers based on a date range

Gets a resource view based on the resourceID passed or a list of resource views if the resourceID is 0.

Allows a resource view object to be passed in the body, along with a second resource list object, if the view is valid it will be created/updated depending on if the ID passed within it exists in the database

Allows a number of spaces to be reserved for a resource on a particular visit date under a unique reservation ID. This should be used to allow space to be reserved while completing the booking process. With the reservationID being passed to the final booking save.

Allows a previously made reservation to be cancelled to open up the reserved space. This only works for reserved space that has not been assigned to a completed booking.

Allows the client to request a list of all booking categories that can be assigned against a booking.

Allows the client to request a list of all booking soruces that can be assigned against a booking.

Allows the client to request a list of all booking statuses that can be assigned against a booking.

Returns a list of bookings for a specific date, can optionally be filtered down by a view name

Returns a list of bookings for a specific date, can optionally be filtered down by a view name

Allows a client to retrieve the sale details of a booking, either using the Sale ID or the Booking ID.

Allows a client to request a list of cancelled bookings between a start and end date range.

Allows a client to request a list of redeemed bookings between a start and end date range and within a specific resource view.

Allows a client to request a list of amendments that have happened to bookings within a start and end date range.

Allows a client to request a ticket/booking reference to be validated.

Allows an outstanding amount against a booking to be charged, if a card token is valid and stored for the booking.

Allows a client to request a list of valid reasons within the system why a booking would be cancelled.

Allows a client to request that a booking is cancelled for a specific reason.

Allows a client to request a hist of a customers bookings based on a person ID or account code. Allows filtering based on a date range, booking source and booking status.

Allows a list of booking objects to be passed and the API will attempt to save each booking. *** E-Tickets and Gift Vouchers are only returned when the Advance payment option has been used and a sale has been processed. ***

Allows a list of booking amendments to be passed and the API will attempt to make the amendments to the booking

Allows a client to add new costs to an existing booking and charge a stored card token if one exists.

Allows a user to validate and check in a booking

Allows a user to search for a booking based on specific criteria

Allows a list of lines to be emailed to multiple email addresses based on a dictionary The dictionary is made up of keys, which are the text lines or body of the email, and the lists for each keys are the email address that body should be sent to. [Key = This is the body of the email to be passed to the email, List = test@test.com, A@B.com] The dictionary allows for multiple emails bodies to be sent in a single call.

Update an existing Product based on the PLU or creates a new Product if not found.

This will return the configuration for the kiosk

Loads a customer based on a number of parameters. If a parameter is not being used it can be left blank or as 0 for numbers, CheckExists is a boolean and must always have either a true or false value.

Loads a customer based on an object with parameters passed in the body of the request. If a parameter is not being used none it can be left blank or as 0 for numbers, CheckExists is a boolean and must always have either a true or false value.

Loads a list of interests. An optional parameter can be passed in which will bring only the interest relateing to the ID

Loads a list of person UDFs, that can be set when updating or creating a person.

Loads a list of interests associated to the customer id passed in

Allows a customer's password to be changed, by providing the Customer ID, Old Password, New Password and an Optional Boolean which when set to true will set new password as temporary

Allows a customer to be updated or created by passing an APICustomer within the body. Pass in an ID of 0 to create a new customer

Allows a list of customer interests to be created or updated against the customer's record.

Allows a list of customer interests to be removed from a customer's record.

This will transfer the stock using the passed parameters

This will issue the stock using the passed parameters

This will create a new stock replenishment batch within the system to be fulfilled, based on the data passed.

This will return a datatable containing a list of stock replenishment batches which have not yet been completed

This will download a full replenishment batch only including the outstanding items to be fulfilled.

This will update the stock replenishment batch adding the counted items but it will not complete the batch, allowing it to be reviewed and changed at a later point.

This will complete the stock replenishment batch which will fulfill the order meaning it can no longer be downloaded or changed.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Gets the current prices for Shopify products in Gamma.

This will return an order using the order number passed in within the system

This will return the list of orders within the system

This will return an order using the order number passed in within the system

This will update the lines for the order

This will return a full list of StockCountLocations, containing only the ID, locationName, stockCountBatchID and notes connected.

Gets the resource name from the passed in resource ID

Gets the messages from the passed in queueID

Handles a received message for a specific queue and message ID

Gets the list of queues for a certain direction, specified by the inbound parameter.

Allows the API to handle acknowledgement of a confirmation of a datahub message.

Allows the API to handle the rejection of a datahub message.

Checks the latest version of the mobile software available.

Checks the latest version of the mobile software available.

Gets the full questionnaire details based on the ID, this will return the name, description and list of questions for the Questionnaire.

Save a set of questionnaire results against a booking.

Gets a resource based on the resourceID passed or a list of resources if the resourceID is 0.

Gets a list of resources based on a date range and can also return a specific resource if the resource ID is passed.

Gets a list of resource based on a resource view name passed as a parameter.

Gets a list of resource based on a resource view name passed and also the start and end dates passed for availability.

Gets a list of resource based on a resource view name passed and also the start and end dates passed for availability and takes in person ID for custom product discounts.

Gets a list of resource based on a resource view name passed and also the start and end dates passed for availability and a number of visitors.

Allows a resource to be update or created by passing an APIResource within the body.

Handles product change notification event.

Handles product delete notification event.

Handles product stock level change notification event.

Handles multiple products notification event.

Returns a Shopify Collection Id for a given VAT rate.

No documentation available.

No documentation available.

Loads the licence key for the mobile device

No documentation available.

This allows a list of Gamma Output Fields to be returned

This will return a full list of StockCountBranchs, containing only the ID, description, Created on date, created by and notes connected.

Gets a list of products associated with the given Product Map ID

Gets a list of products associated with the given Product Map name.

Returns any product with the given product PLU.

Returns any products associated with the given Product Group name.

Gets a product list associated with the given Product Category name.

Returns a list of products that have the given Product Description.

Returns a list of all available Products.

This will return a list of products which have had changed since the date passed and against the branch passed

Returns all Product Maps or the Product Map with the given ID.

This will return a full list of product currently in use at a specific till's location.

No documentation available.

Update an existing Product based on the PLU or creates a new Product if not found.

Update an existing Product Map if the ID passed exists or create a new product map.

This will return a validated Booking, Ticket or Membership.

This will update a tickets validated state.

This will process a complimentary ticket against the booking

This will update the actuals against a booking line

This will return a full list of StockCountItems depending on the batch passed in, containing the ID,StockCountID, StockItemID, StockOnHand, StockDifference, StockCounted, Updated, UpdatedOn, UpdateCount, PackQty, CostPrice and notes connected.

This will create a new stock replenishment batch within the system to be fulfilled, based on the data passed.

This will return a full list of branches, containing only the ID, Code and Name of the branch

This will return a list of all valid issue reasons within the system

This will return a list of all valid issue sub reasons within the system

Loads a list of memberships currently active for a customer.

Loads a full list of membership types that can be purchased.

Loads a list of all member modifications within a date range.

Allows a membership to be cancelled for a customer.

Allows a membership to be purchased or renewed for a customer.

Gets a list of Tasks (Admin Only)

Runs Tasks by ID (Admin Only)