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
All
Pages
Start typing to 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
Register Sales
List register sales
get
Create or update a register sale
post
Get a single register sale by ID
get
Registers
List registers
get
Suppliers
List suppliers
get
Create or update a supplier
post
Get a single supplier by ID
get
Delete a supplier
del
Taxes
List taxes
get
Create a tax
post
Get a single tax by ID
get
Users
List users
get
Webhooks
List webhooks
get
Create a webhook
post
Get a single webhook by ID
get
Update a webhook by ID
put
Delete a webhook by ID
del
API 2.0
Audit
List security events for current user
get
Brands
Create brand
post
Delete a single brand
del
Get a single brand
get
List brands
get
Update a single brand
put
Channel Request Log
Get a single request log
get
Get a single request log as text
get
List channel records
get
List request records
get
Consignment Products
Add a product to a consignment
post
Bulk update consignment products
post
Delete an item from a consignment
del
List all products for a specific consignment
get
Update a product in a consignment
put
Consignments
Create a consignment
post
Delete a consignment
del
Get a single consignment
get
List consignments
get
Get consignment totals
get
Update a consignment
put
Customer Groups
Add customers to customer group
post
Create new customer group
post
Delete a customer group
del
Delete customers from customer group
del
Get single customer group
get
Get customers for customer group
get
List customer groups
get
Update the given customer group
put
Customers
Create a new customer
post
Bulk update customer tax assignments
post
Delete a customer
del
Get a single customer
get
List customers
get
Update a customer
put
Fulfillment
Fulfil a sale
post
List Sale Fulfillments
get
Inventory
List inventory records
get
Outlet Product Taxes
List outlet product taxes
get
Outlets
Get a single outlet
get
List outlets
get
Payment Types
List payment types
get
Payments
Get a single payment
get
Pick Lists
List Sale Pick Lists
get
Price Books
Add the products to a price book
post
Create a single price book
post
Delete a price book
del
Delete some entries for a price book
del
Get a single price book
get
List price book products per price book
get
List price book products
get
List price books
get
Update a single price book
post
Update the products in a price book
patch
Update the products in a price book
put
Product Categories
Create and update a product category hierarchy
post
Delete a list of product categories
del
List product categories
get
Product Images
Delete a product image
del
Get a single product image data
get
Set image position
put
Product Types
Get a single product type
get
List product types
get
Products
Create product
post
Delete a single product
del
Delete a product family
del
Get inventory data for a single product
get
Get a list of price books the given product is in
get
Get a single product
get
List products
get
Upload an image
post
Promo Code
Delete promo codes
del
Get the active status of promo codes
post
Promotions
Apply discounts to a sale object
post
Create a promotion
post
Get a promotion by ID
get
Get products for a promotion
get
Get the promo codes for a promotion
get
List promotions
get
Search promotions
get
Update a promotion
put
Quotes
Get Quote
get
List Quotes
get
Registers
Close a single register
put
Get a single register
get
List registers
get
Open a single register
put
Get all the payments data associated with a single register.
get
Retailers
Get information about this retailer
get
Sales
Get a single sale
get
Return a sale
put
List Sales
get
Search
Search for resources
get
Serial Numbers
Create a serial number
post
Delete a serial number
del
Get a single serial number
get
List serial numbers
get
Service Orders
Get services agenda by outlet
get
Get service
get
List a customer's service items
get
List services
get
Shifts
List shifts
get
Suppliers
Create new supplier
post
Delete a single supplier
del
Get a single supplier
get
List suppliers
get
Update a supplier
put
Tags
Create tag
post
Delete a single tag
del
Get a single tag
get
List tags
get
Update a single tag
put
Taxes
List taxes
get
Users
Delete user sessions
del
Delete a single user
del
Get the sales totals for a single user
get
Get current user
get
Get a single user
get
Get multiple users by id
post
List users
get
Variant Attributes
Create a Variant Attribute
post
Delete a variant attribute
del
Retrieve a single Variant Attribute
get
Retrieve all Variant Attributes
get
Update a Variant Attribute's name
put
API 2.1
Products
Update a product
put
Create a single variant
post
API 2.0 - BETA
Audit
List audit events
get
Fulfillments
Get Fulfillments Summary
get
Fulfill line items within a sale
post
Partial Pack line items within a sale
post
Partial Pick line items within a sale
post
Fulfill a Sale
post
Gift Cards
List gift cards
get
Create gift card
post
Find gift card
get
Void gift card
del
Create a gift card transaction
post
Find gift card by transaction id
get
Reverse gift card transaction
del
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
Workflows
List custom field definitions
get
Define a new custom field
post
Update a custom field
put
Delete a custom field
del
List custom field values
get
Set new custom field values
post
List remote rules
get
Create remote rule
post
Delete a remote rule
del
List rules
get
Create rule
post
Delete a business rule
del
Webhooks
Get Webhook
get
Update Webhook
put
Delete Webhook
del
List webhooks
get
Create Webhook
post
API 3.0
Gift Cards
Find gift card by id
get
Price Books
List price books
get
Create a single price book
post
Get a single price book
get
Update a single price book
put
API 3.0 - BETA
Products
List Products
get
Get Product
get
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!