For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Inventory

Introduction to the Item Backend API

This page is for API Reference.

Was this page helpful?

System Services
Accounts
Ticketing
Memberships
Speedgate
Attraction Wallet
OTA Channel Manager
POS
Restaurant
Inventory
Coupon
Vouchers
- Vouchers
Sales Documents
Finance
Customers
- Customers
- GDPR
BI
Retail Print
- Print Price Labels
PDF Designer

Introduction
URL Structure
API Key
Errors
Versioning
Pagination
Replication
Rate Limits
Webhooks
Caching
API Reference
System Services
Companies
Get all companies
Get Current Company
Hello World
Hello World
Get subscriptions
Get subscription
Create subscription
Delete subscription
Find Accounts
Get Account
Create Account
Update Account
Get Payment Methods
Create Payment Method
Ticketing
Getting started
Catalog
Get Catalog
Availability
Get Capacity
Search Time Slots
Get Schedule
Tickets
Get Ticket
Find Ticket
Request Revoke Ticket
Confirm Revoke Ticket
Validate Arrival
Validate Departure
Send to Wallet
Exchange For Coupon
Confirm Print
Clear Confirm Print
Reservations
Create Reservation
Update Reservation
Cancel Reservation
Pre Confirm Reservation
Confirm Reservation
Get Reservation
Get Tickets
Time Slot Capacity Changed
Memberships
Catalog
Get Catalog
Membership
Create Membership
Get using Id
Get using Number
Block Membership
Unblock Membership
Get Members
Attributes
List Attributes
Get Values
Set Values
Remove Values
Member
Get using Id
Add Member
Update Member
Get Member Image
Set Member Image
Find Members
Block Member
Unblock Member
Get Member Notes
Add Member Note
Attributes
List Attributes
Get Values
Set Values
Remove Values
Card
Get using Id
Get using Number
Add Card
Replace Card
Update Card
Block Card
Unblock Card
Send to Apple Wallet
Payment Method
Retrieve membership payment methods
Get payment method using Id
Add payment method
Update payment method
Delete payment method
Get Subscription
Start Subscription
Terminate Subscription
Lifecycle
Get Membership History
Activate Membership
Get Cancel Options
Cancel Membership
Get Renewal Options
Renew Membership
Get Upgrade Options
Upgrade Membership
Get Extend Options
Extend Membership
Get Membership Recurring Subscription Payment Information
Miscellaneous
Resolve Member Identifier
List Memberships
Get Loyalty Tags
Create Loyalty Tags
Points
Get Points Balance
Authorize Points Transaction
Cancel Point authorization
Register Sale
Get Points Sale History
Get Points Transactions
Membership Created
Member Added
Membership Renew Staged
Membership Upgrade Staged
Membership Extend Staged
Membership Auto Renew Staged
Membership Period Cancel
Membership Period Regret
Membership Period Activated
Member Details Updated
Membership Details Updated
Speedgate
Find Scanners
Find Categories
Get Scanner Setup
Reference Number Lookup
Try Admit
Admit Token
Try And Attempt Admit
Fail Admit Token
Attraction Wallet
Create Wallet
Add to Wallet
Get Wallet
Find Wallet
Asset History
Confirm Print
Clear Confirm Print
OTA Channel Manager
Getting started
Orders
Create Order
Get Order
List Orders by Partner
Confirm Order
Replace Order
Delete Order
OTA Channel Manager Order Processed
POS
POS Sale
Search POS Sale
Get POS Sale
Create POS Sale
Update POS Sale
Delete POS Sale
Complete POS Sale
Park POS Sale
Resume POS Sale
List Sale Lines
Get Sale Line
Create Sale Line
Create Sale Line Addon
Update Sale Line
Delete Sale Line
List Payment Lines
Get Payment Line
Create Payment Line
Delete Payment Line
Prepare EFT Payment
Build EFT Request (Local)
Parse EFT Response (Local)
Start EFT Payment (Cloud)
Poll EFT Status
Cancel EFT Transaction
Generate Boarding Token (Local)
POS Entry
List POS Entries
Get POS Entry
Get Sales Receipt Print
Get Terminal Receipt Print
Issue Digital Receipt
POS Unit
Get Current POS Unit
Get POS Unit
Open POS Unit
List POS Units
POS Store
List POS Stores
Salesperson
Salesperson
Find Salespersons
Login
Block Salesperson
Unblock Salesperson
Create Salesperson
Update Salesperson
External POS Sale
List External POS Sales
Get External POS Sale
Create External POS Sale
Global POS Entry
Get using Id
Get Global Entry by Global Reference.
Get Global Entry by Global Reference as PDF
Search Global Entry
Create Global Entry
POS Sale Completed
POS Unit Balanced
POS Bin Transferred Out
POS Bin Transferred In
Restaurant
List Restaurants
List Seating Locations
Get Seating Location
List Seatings
Get Seating
List Menus
Get Menu
List Kitchen Orders
Get Kitchen Order
Restaurant Order Ready for Serving
Inventory
Barcodes
Get Barcodes
Items
Get Item
Get Items
Item Ledger Entries
Get Item Ledger Entries
Item Categories
Get Item Categories
Item Variants
Get Item Variants
Item Translations
Get Item Translations
Coupon
Find Coupons
Get Coupon
Create Coupon
Void Coupon
Apply Coupon Discount
Check Coupon
Reserve Coupon
Cancel Coupon Reservation
Redeem Coupon
Vouchers
Vouchers
Find Vouchers
Get Voucher
Create Voucher
Reserve Voucher
Cancel Voucher Reservation
Voucher Created
Voucher Payment
Sales Documents
Ecommerce
Create Sales Document
Get Sales Document
Find Sales Documents
Get Sales Invoice as PDF
Get Sales Credit Memo as PDF
Sales Order Created
Sales Order Posted
Sales Order Cancelled
Sales Return Order Created
Sales Return Order Posted
Sales Return Order Cancelled
Finance
General Ledger Account
Get G/L Accounts
Get G/L Account by ID
General Ledger Entries
Get G/L Entries
Get G/L Entry by ID
General Ledger Journal
Create General Journal
List General Journals
Get General Journal
Customers
Customers
Get Customer
Find Customers
Create Customer
GDPR
Request Customer Anonymization
BI
Read Table
List Tables
Get Table Metadata
Retail Print
Print Price Labels
Print Price Labels
PDF Designer
Get Manifest
Manifest Created
Manifest Deleted
Manifest Content Added
Manifest Content Removed
Manifest Content Changed

Home
Product Documentation
API Reference
Entria API Reference
Changelog