For AI agents: visit https://ewity-api.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
v1.0
API Reference
Log In
Jump to Content
v1.0
Guides
API Reference
My Requests
Log In
JUMP TO
Ewity Apps API
Products
Create Product
post
Get Product
get
Update Product
patch
Delete Product
del
Delete Variant Image
del
Get Product Availability
get
Get Product Variant
get
Search Products
get
List Offline Products (All Locations)
get
List Offline Products For Location
get
Get Offline Product For Variant
get
List Products For Location
get
Get Full Product List For Location
get
Get Full Product For Location
get
Product Categories
List Product Categories
get
Create Product Category
post
Update Product Category
patch
Delete Product Category
del
Get Product Category Tree
get
Brands
List Brands
get
Create Brand
post
Update Brand
patch
Delete Brand
del
Modifiers
List Modifier Groups
get
Create Modifier Group
post
Get Modifier Group
get
Update Modifier Group
patch
Delete Modifier Group
del
Create Modifier
post
Update Modifier
patch
Delete Modifier
del
Attach Modifier Group To Variant
post
Detach Modifier Group From Variant
del
Recipes
List Recipes
get
Create Recipe
post
Get Recipe
get
Update Recipe
patch
Delete Recipe
del
Prepare Recipe
post
Suppliers
List Suppliers
get
Create Supplier
post
Get Supplier
get
Update Supplier
patch
Delete Supplier
del
Taxes
List Taxes
get
Create Tax
post
Update Tax
patch
Delete Tax
del
Tags
Attach Tags To Object
post
List Tags
get
Customers
List Customers
get
Create Customer
post
Get Customer
get
Update Customer
patch
Delete Customer
del
Get or Create Customer by Passport MRZ
post
Adjust Customer Credit
post
List All Credit Changes
get
List Customer Credit Changes
get
Get Customer (Offline Shape)
get
List All Customers (Offline Cache)
get
Search Customers
get
Customer Addresses
Create Customer Address
post
Update Customer Address
patch
Delete Customer Address
del
Set Default Customer Address
post
Customer Groups
List Customer Groups
get
Create Customer Group
post
Get Customer Group
get
Update Customer Group
patch
Loyalty
List Loyalty Programs
get
Create Loyalty Program
post
Update Loyalty Program
post
Change Customer's Loyalty Program
patch
Adjust Customer Loyalty Points
post
Get Loyalty Program
get
List Customer Loyalty Changes
get
Bills
Create Bill
post
Create Minimal Sale
post
Void Bill
post
Change Bill Delivery Status
post
Change Bill Delivery Driver
post
List Bills by Location
get
List Bills by Customer
get
Get Bill
get
Refund Bill (Server-Derived)
post
List Open Bills by Location
get
Payments
Create Payment
post
Create Bulk Payments
post
Reverse Payment
post
List Payments by Register Session
get
Fees
List Fees
get
Create Fee
post
Get Fee
get
Update Fee
patch
Delete Fee
del
Discounts
List Fixed Discounts
get
Create Fixed Discount
post
Update Fixed Discount
patch
Delete Fixed Discount
del
Gift Cards
List Gift Cards
get
Create Gift Card
post
Get Gift Card
get
Update Gift Card
patch
Delete Gift Card
del
Get Gift Card for Redemption
get
Commissions
List Commissions
get
Create Commission
post
Get Commission
get
Delete Commission
del
Set Commission Employees
post
List Employee Commission Charges
get
Quotations
Create Quotation
post
Get Quotation
get
Update Quotation
patch
Set Quotation Lines
post
Finalize Quotation
post
Cancel Quotation
post
Duplicate Quotation
post
Email Quotation
post
Create Quotation From POS Bill
post
List Quotations
get
Expenses
List Expenses
get
Create Expense
post
Get Expense
get
Update Expense
patch
Delete Expense
del
Capture Expense Payment
post
Get Expense Dashboard Summary
get
Expense Categories
List Expense Categories
get
Create Expense Category
post
Update Expense Category
patch
Delete Expense Category
del
Expense Vendors
List Expense Vendors
get
Create Expense Vendor
post
Update Expense Vendor
patch
Delete Expense Vendor
del
Serials
Validate Serial Numbers
post
List Serial Numbers For Variant
get
Stock Counts
Create Stock Count
post
Add Products By Categories
post
Set Counted Quantities
post
Add Line To Stock Count
post
Set Line Remark
post
Update Counts From CSV
post
Recalculate Opening Balances
post
Cancel Stock Count
post
Send Back To Counting
post
Finish Stock Count
post
Send For Review
post
Set Stock Count Variants
post
List Stock Counts
get
Get Stock Count Details
get
Batch Rows For Counting
get
Stock
Create Stock
post
Receive Stock (Bulk)
post
Ignore Stock From Low-Stock List
post
List Stocks At Location
get
Get Stock Details
get
Stocks For Product By Location
get
Product Stock Breakdown
get
List Stock Changes
get
Get Stock Change Details
get
Transfers
Transfer Stock Directly (Bulk)
post
Create Transfer Request
post
Get Lines For Bulk Purchase Order
post
Approve Transfer
post
Cancel Transfer
post
Set Transfer Lines From CSV Data
post
Update Transfer Details
post
Set Transfer Lines
post
Issue Stock For Transfer
post
List Sent Transfer Requests
get
List Received Transfer Requests
get
List Transfer Issues
get
Get Transfer Request Details
get
Get Transfer Issue Details
get
Stock Adjustments
Create Stock Adjustment
post
Adjust Cost Price
post
Update Cost Of A Stock Change
post
Batches
List Batches For Variant
get
List Batches For Stock
get
List In-Stock Batches For Stock
get
Purchase Orders
Create Purchase Order
post
Create Purchase Orders in Bulk
post
Create Purchase Orders from Low Stocks
post
Set Purchase Order Lines
post
Update Purchase Order Details
post
Set Purchase Order Landed Costs
post
Approve Purchase Order
post
Email Purchase Order to Supplier
post
Cancel Purchase Order
post
Duplicate Purchase Order
post
Receive Purchase Order Stock
post
List Purchase Orders
get
Get Purchase Order
get
Purchase Receives
Update Purchase Receive Details
post
Void Purchase Receive
post
List Purchase Receives
get
Get Purchase Receive
get
Locations
List Locations
get
Create Location
post
List Locations (Minimal)
get
Get Location
get
Update Location
patch
Delete Location
del
Set Location Print Template
post
Get Table QR Codes
post
List Current User's Locations
get
List Locations With Authority
get
Registers
List Registers
get
Create Register
post
Get Register
get
Delete Register
del
Open Register
post
Close Register
post
Set Register Devices
post
List Register Sessions
get
Get Register Session
get
List Register Movements
get
Create Register Movement
post
Floors & Tables
List Floors
get
Create Floor
post
Update Floor
post
Set Floor Tables
post
Move Floor
post
Delete Floor
post
Devices
List Devices
get
Get Device
get
Create Device
post
Update Device
post
Delete Device
post
Employees
List Employees
get
Create Employee
post
List Employees For Location
get
Get Employee
get
Update Employee
patch
Delete Employee
del
Set Employee Location
post
Users
List Users
get
Get User
get
Get Current User
get
List Permission Levels
get
Get Permission Level
get
Print Templates
List Print Templates
get
Get Print Template
get
List Print Templates By Type
get
Get Default Print Template Config
get
Company
Get Company Settings
get
List Price Level Options
get
Activity Logs
List Activity Logs
get
Webhooks
How Webhook Delivery Works
get
App Installed
post
App Reauthorized
post
App Uninstalled
post
Bill Created
post
Bill voided
post
Bill refunded
post
Payment created
post
Payment reversed
post
Register session closed
post
Expense created
post
Expense updated
post
Customer Created
post
Customer Updated
post
Product Created
post
Product Updated
post
Quotation Created
post
Order Status Changed
post
Order Notification
post
Order Review Reminder
post
Store Turned On
post
Catalogue Updated
post
Legacy Webhooks
OrderStatusChanged (Legacy)
post
OrderNotification (Legacy)
post
StoreTurnedOn (Legacy)
post
ReviewRequestedReminder (Legacy)
post
CatalogueUpdated (Legacy)
post
Online Ordering Platforms
Connect Flow
GET — Connect Instructions
POST — Verify Connect Code
Stores
List stores
get
Catalogue
Root categories
get
Category details
get
Full catalogue
get
Bulk look up products by ID
post
Orders
Validate cart
post
Create order
post
Get order
get
Change order status
post
Payments
Record payment
post
Bank transfer payment
post
Webhooks
Order status changed
post
Store turned on
post
Order notification
post
Review-requested reminder
post
Catalogue updated
post
Powered by
