Jump to Content
Home
Tutorials
API Reference
Changelog
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Tutorials
API Reference
Changelog
Create a tax
Search
JUMP TO
API 0.9
Customers
List customers
get
Create or update a customer
post
Outlets
List outlets
get
Payment Types
List payment types
get
Registers
List registers
get
Register Sales
List register sales
get
Create or update a register sale
post
Get a single register sale by ID
get
Suppliers
List suppliers
get
Create or update a supplier
post
Get a single supplier by ID
get
Delete a supplier
delete
Taxes
List taxes
get
Create a tax
post
Get a single tax by ID
get
Users
List users
get
API 2.0
Audit
List security events for current user
get
Brands
List brands
get
Create brand
post
Get a single brand
get
Update a single brand
put
Delete a single brand
delete
Consignments
List consignments
get
Create a consignment
post
Get a single consignment
get
Update a consignment
put
Delete a consignment
delete
Get consignment totals
get
Consignment Products
List all products for a specific consignment
get
Add a product to a consignment
post
Update a product in a consignment
put
Delete an item from a consignment
delete
Bulk update consignment products
post
Customers
List customers
get
Create a new customer
post
Get a single customer
get
Update a customer
put
Delete a customer
delete
Channel Request Log
List request records
get
Get a single request log
get
Get a single request log as text
get
List channel records
get
Customer Groups
List customer groups
get
Create new customer group
post
Get single customer group
get
Update the given customer group
put
Delete a customer group
delete
Get customers for customer group
get
Add customers to customer group
post
Delete customers from customer group
delete
Fulfillment
List Sale Fulfillments
get
Fulfil a sale
post
Inventory
List inventory records
get
Outlet Product Taxes
List outlet product taxes
get
Outlets
List outlets
get
Get a single outlet
get
Payment Types
List payment types
get
Price Books
List price book products
get
List price books
get
Create a single price book
post
Get a single price book
get
Update a single price book
post
Delete a price book
delete
List price book products per price book
get
Add the products to a price book
post
Delete some entries for a price book
delete
Update the products in a price book
patch
Update the products in a price book
put
Product Categories
List product categories
get
Create and update a product category hierarchy
post
Delete a list of product categories
delete
Product Images
Get a single product image data
get
Set image position
put
Delete a product image
delete
Product Types
List product types
get
Get a single product type
get
Products
List products
get
Create product
post
Get a single product
get
Delete a single product
delete
Delete a product family
delete
Upload an image
post
Get inventory data for a single product
get
Get a list of price books the given product is in
get
Promotions
Apply discounts to a sale object
post
Search promotions
get
List promotions
get
Create a promotion
post
Get a promotion by ID
get
Update a promotion
put
Get products for a promotion
get
Get the promo codes for a promotion
get
Quotes
Get Quote
get
List Quotes
get
Registers
List registers
get
Get a single register
get
Open a single register
put
Close a single register
put
Get all the payments data associated with a single register.
get
Retailers
Get information about this retailer
get
Sales
List Sales
get
Get a single sale
get
Return a sale
put
Search
Search for resources
get
Serial Numbers
List serial numbers
get
Create a serial number
post
Get a single serial number
get
Delete a serial number
delete
Service Orders
List services
get
List a customer's service items
get
Get service
get
Get services agenda by outlet
get
Suppliers
List suppliers
get
Create new supplier
post
Get a single supplier
get
Update a supplier
put
Delete a single supplier
delete
Tags
List tags
get
Create tag
post
Get a single tag
get
Update a single tag
put
Delete a single tag
delete
Taxes
List taxes
get
Users
Get current user
get
List users
get
Get multiple users by id
post
Get a single user
get
Delete a single user
delete
Delete user sessions
delete
Get the sales totals for a single user
get
Variant Attributes
Retrieve all Variant Attributes
get
Create a Variant Attribute
post
Retrieve a single Variant Attribute
get
Update a Variant Attribute's name
put
Delete a variant attribute
delete
Promo Code
Get the active status of promo codes
post
Delete promo codes
delete
Pick Lists
List Sale Pick Lists
get
Shifts
List shifts
get
API 2.0 - BETA
Audit
List audit events
get
Gift Cards
List gift cards
get
Create gift card
post
Find gift card
get
Void gift card
delete
Create a gift card transaction
post
Find gift card by transaction id
get
Reverse gift card transaction
delete
Partner Billing
List partner subscriptions
get
Get a partner subscription
get
Create a partner subscription token
post
Get subscription by token
get
Create a partner update subscription token
post
Store Credits
Store credit list
get
Store credit list for the given customer id
get
Store credit bulk list
post
Create a store credit transaction
post
Store credit report
get
Webhooks
Get Webhook
get
Update Webhook
put
Delete Webhook
delete
List webhooks
get
Create Webhook
post
Workflows
List custom field definitions
get
Define a new custom field
post
Update a custom field
put
Delete a custom field
delete
List custom field values
get
Set new custom field values
post
List remote rules
get
Create remote rule
post
Delete a remote rule
delete
List rules
get
Create rule
post
Delete a business rule
delete
API 2.1
Products
Update a product
put
Create a single variant
post
API 3.0 - BETA
Products
List Products
get
Get Product
get
API 3.0
Price Books
List price books
get
Create a single price book
post
Get a single price book
get
Update a single price book
put
Powered by
Create a tax
post
https://{domain_prefix}.retail.lightspeed.app/api/taxes
Creates a new tax.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
example
.retail.lightspeed.app/api
/taxes
RESPONSE
Click
Try It!
to start a request and see the response here!