POS API Reference
One single API to push and pull data from multiple connectors.
Copy Unified API ID
Visit changelog
10.18.0
List Items
get/pos/items
Create Item
post/pos/items
Get Item
get/pos/items/{id}
Update Item
patch/pos/items/{id}
Delete Item
delete/pos/items/{id}
List Locations
get/pos/locations
Create Location
post/pos/locations
Get Location
get/pos/locations/{id}
Update Location
patch/pos/locations/{id}
Delete Location
delete/pos/locations/{id}
List Merchants
get/pos/merchants
Create Merchant
post/pos/merchants
Get Merchant
get/pos/merchants/{id}
Update Merchant
patch/pos/merchants/{id}
Delete Merchant
delete/pos/merchants/{id}
List Modifier Groups
get/pos/modifier-groups
Create Modifier Group
post/pos/modifier-groups
Get Modifier Group
get/pos/modifier-groups/{id}
Update Modifier Group
patch/pos/modifier-groups/{id}
Delete Modifier Group
delete/pos/modifier-groups/{id}
List Modifiers
get/pos/modifiers
Create Modifier
post/pos/modifiers
Get Modifier
get/pos/modifiers/{id}
Update Modifier
patch/pos/modifiers/{id}
Delete Modifier
delete/pos/modifiers/{id}
List Order Types
get/pos/order-types
Create Order Type
post/pos/order-types
Get Order Type
get/pos/order-types/{id}
Update Order Type
patch/pos/order-types/{id}
Delete Order Type
delete/pos/order-types/{id}
List Orders
get/pos/orders
Create Order
post/pos/orders
Get Order
get/pos/orders/{id}
Update Order
patch/pos/orders/{id}
Delete Order
delete/pos/orders/{id}
Pay Order
post/pos/orders/{id}/pay
List Payments
get/pos/payments
Create Payment
post/pos/payments
Get Payment
get/pos/payments/{id}
Update Payment
patch/pos/payments/{id}
Delete Payment
delete/pos/payments/{id}
List Tenders
get/pos/tenders
Create Tender
post/pos/tenders
Get Tender
get/pos/tenders/{id}
Update Tender
patch/pos/tenders/{id}
Delete Tender
delete/pos/tenders/{id}
Order Created
postOrderCreated
Order Updated
postOrderUpdated
Order Deleted
postOrderDeleted
Payment Created
postPosPaymentCreated
Payment Updated
postPosPaymentUpdated
Payment Deleted
postPosPaymentDeleted
Merchant Created
postMerchantCreated
Merchant Updated
postMerchantUpdated
Merchant Deleted
postMerchantDeleted
Location Created
postLocationCreated
Location Updated
postLocationUpdated
Location Deleted
postLocationDeleted
Item Created
postItemCreated
Item Deleted
postItemDeleted
Item Updated
postItemUpdated
Modifier Created
postModifierCreated
Modifier Updated
postModifierUpdated
Modifier Deleted
postModifierDeleted
Modifier Group Deleted
postModifierGroupDeleted
Modifier Group Created
postModifierGroupCreated
Modifier Group Updated
postModifierGroupUpdated