When you configure an export, import, or other type of flow step using the prebuilt Lightspeed connector, you can select any of the API operations listed below, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Lightspeed API documentation . You can also create a composite endpoint for this application in HTTP mode.
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Account |
Account details |
X |
|
|
Category |
All categories |
X |
|
|
Retrieve a category |
X |
||
|
Create a category |
X |
||
|
Update a category |
X |
||
|
Delete a category |
X |
||
|
Credit account |
All credit accounts |
X |
|
|
Retrieve a credit account |
X |
||
|
Create a credit account |
|||
|
Update a credit account |
|||
|
Archive a credit account |
X |
||
|
Customer |
All customers |
X |
X |
|
Retrieve a customer |
X |
X |
|
|
All custom fields |
X |
X |
|
|
Retrieve a custom field |
X |
X |
|
|
Create a customer |
X |
||
|
Update a customer |
|||
|
Archive a customer |
|||
|
Create a custom field |
X |
||
|
Update a custom field |
X |
||
|
Archive a custom field |
X |
||
|
Customer type |
All customer types |
X |
|
|
Retrieve a customer type |
X |
||
|
Create a customer type |
X |
||
|
Update a customer type |
X |
||
|
Delete a customer type |
X |
||
|
Discount |
All discounts |
X |
|
|
Retrieve a discount |
X |
||
|
Create a discount |
X |
||
|
Update a discount |
X |
||
|
Archive a discount |
X |
||
|
Employee |
All employees |
X |
|
|
Single employee |
X |
||
|
Update an employee |
X |
||
|
Delete an employee |
X |
||
|
Inventory |
All inventory |
X |
|
|
Single inventory |
X |
||
|
Inventory count |
All inventory counts |
X |
X |
|
Single inventory count |
X |
X |
|
|
Create an inventory count |
X |
||
|
Update an inventory count |
|||
|
Delete an inventory count |
|||
|
Inventory count calc |
All inventory counts calculations |
X |
X |
|
Single inventory count calculation |
X |
X |
|
|
Inventory count item |
All inventories count items |
X |
X |
|
Inventory count items |
X |
||
|
Create an inventory count item |
|||
|
Update an inventory count item |
X |
||
|
Delete an inventory count item |
X |
||
|
Inventory count reconcile |
All inventory count reconciles |
X |
X |
|
Single inventory count reconcile |
X |
||
|
Create an inventory count reconcile |
|||
|
Item |
All items |
X |
|
|
Single item |
X |
||
|
Create an item |
|||
|
Update an item |
|||
|
Delete an item |
X |
||
|
Item attribute set |
All item attribute sets |
X |
X |
|
Single item attribute set |
X |
X |
|
|
Item matrix |
All items matrix |
X |
|
|
Single item matrix |
X |
||
|
Create an item matrix |
|||
|
Update an item matrix |
|||
|
Delete an item matrix |
X |
||
|
Order |
All orders |
X |
X |
|
Single order |
X |
X |
|
|
Create an order |
|||
|
Update an order |
|||
|
Delete an order |
X |
||
|
Order line |
All order lines |
X |
|
|
Single order line |
X |
||
|
Create an order line |
X |
||
|
Update an order line |
X |
||
|
Delete |
X |
||
|
Quote |
All quotes |
X |
|
|
Single quote |
X |
||
|
Create a quote |
X |
||
|
Update a quote |
X |
||
|
Delete a quote |
X |
||
|
Sale |
All sales |
X |
|
|
Single sale |
X |
||
|
All sale salelines |
X |
||
|
Single sale saleline |
X |
||
|
Create a sale |
X |
||
|
Update a sale |
X |
||
|
Sale email receipt |
X |
||
|
Delete a sale |
X |
||
|
Create a sale saleline |
X |
||
|
Update a sale saleline |
X |
||
|
Delete a sale saleline |
X |
||
|
Sale line |
All sale lines |
X |
|
|
Sale payment |
All sales payments |
X |
|
|
Single sale payment |
X |
||
|
Sale void |
All sales void |
X |
|
|
Single sale void |
X |
||
|
Serialized |
All serial numbers |
X |
|
|
Single serial number |
X |
||
|
Create a serial number |
X |
||
|
Update a serial number |
X |
||
|
Delete a serial number |
X |
||
|
Shipto |
All ships to |
X |
|
|
Single ship to |
X |
||
|
Specialorder |
All special orders |
X |
|
|
Single special order |
X |
||
|
Tag |
All tags |
X |
|
|
Single tag |
X |
||
|
Create a tag |
X |
||
|
Update a tag |
X |
||
|
Delete a tag |
X |
||
|
Tax category |
All tax categories |
X |
|
|
Single tax category |
X |
||
|
Create a tax category |
X |
||
|
Update a tax category |
X |
||
|
Delete a tax category |
X |
||
|
Vendor |
All vendors |
X |
|
|
Single vendor |
X |
||
|
Create a vendor |
X |
||
|
Update a vendor |
X |
||
|
Delete a vendor |
X |
||
|
Work order item |
All work order items |
X |
|
|
Single work order item |
X |
||
|
Work order |
All work orders |
X |
|
|
Single work order |
X |
||
|
Work order line |
All work order lines |
X |
|
|
Single work order lines |
X |
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Account |
List account |
X |
|
|
Get account by ID |
X |
||
|
Catalog search |
Catalog search |
X |
|
|
Catalog vendor item |
List catalog vendor item |
X |
|
|
Get catalog vendor item by ID |
X |
||
|
Category |
List category |
X |
|
|
Create a category |
X |
||
|
Get category by ID |
X |
||
|
Update a category |
X |
||
|
Delete a category |
X |
||
|
CC charge |
List CC charge |
X |
|
|
Get CC charge by ID |
X |
||
|
Credit account |
List credit account |
X |
|
|
Create credit account |
X |
||
|
Get credit account by ID |
X |
||
|
Update credit account |
X |
||
|
Delete credit account |
X |
||
|
Customer |
List customer |
X |
|
|
Create customer |
X |
||
|
Get customer by ID |
X |
||
|
Update customer |
X |
||
|
Delete customer |
X |
||
|
Customer custom field |
List custom field |
X |
|
|
Create custom field |
X |
||
|
Get custom field by ID |
X |
||
|
Update custom field |
X |
||
|
Delete custom field |
X |
||
|
Customer field choice |
List custom field choice (customer) |
X |
|
|
Create custom field choice (customer) |
X |
||
|
Get custom field choice by ID (customer) |
X |
||
|
Update custom field choice (customer) |
X |
||
|
Delete custom field choice (customer) |
X |
||
|
Customer type |
List customer type |
X |
|
|
Create customer type |
X |
||
|
Get customer type by ID |
X |
||
|
Update customer type |
X |
||
|
Delete customer type |
X |
||
|
Discount |
List discount |
X |
|
|
Create discount |
X |
||
|
Get discount by ID |
X |
||
|
Update discount |
X |
||
|
Delete discount |
X |
||
|
Display template employee |
List display template employee |
X |
|
|
Get display template employee by ID |
X |
||
|
Display template item as label |
List display template item as label |
X |
|
|
Get display template item as label by ID |
X |
||
|
Display template label |
List display template label |
X |
|
|
Get display template label by ID |
X |
||
|
Display template order |
List display template order |
X |
|
|
Get display template order by ID |
X |
||
|
Display template order line as label |
List display template order line as label |
X |
|
|
Get display template order line as label by ID |
X |
||
|
Display template register count |
List display template register count |
X |
|
|
Display template register withdraw |
List display template register withdraw |
X |
|
|
Get display template register withdraw by ID |
X |
||
|
Display template sale |
List display template sale |
X |
|
|
Get display template sale by ID |
X |
||
|
Display template transfer |
List display template transfer |
X |
|
|
Get display template transfer by ID |
X |
||
|
Display template transfer item as label |
List display template transfer item as label |
X |
|
|
Get display template transfer item as label by ID |
X |
||
|
Display template vendor return |
List display template vendor return |
X |
|
|
Get display template vendor return by ID |
X |
||
|
Display template work order |
List display template work order |
X |
|
|
Get display template work order by ID |
X |
||
|
Employee |
List employee |
X |
|
|
Create employee |
X |
||
|
Get employee by ID |
X |
||
|
Update employee |
X |
||
|
Delete employee |
X |
||
|
Employee hours |
List employee hours |
X |
|
|
Get employee hours |
X |
||
|
Get employee hours by ID |
X |
||
|
Update employee hours |
X |
||
|
Delete employee hours |
X |
||
|
Industry |
List industry |
X |
|
|
Get industry by ID |
X |
||
|
Create industry |
X |
||
|
Inventory count |
List inventory count |
X |
|
|
Create inventory count |
X |
||
|
Get inventory count by ID |
X |
||
|
Update inventory count |
X |
||
|
Delete inventory count |
X |
||
|
Inventory count calc |
List inventory count calc |
X |
|
|
Get inventory count calc by ID |
X |
||
|
Inventory count item |
List inventory count item |
X |
|
|
Inventory count item |
X |
||
|
Get inventory count item by ID |
X |
||
|
Update inventory count item |
X |
||
|
Delete inventory count item |
X |
||
|
Inventory count reconcile |
List inventory count reconcile |
X |
|
|
Get inventory count reconcile by ID |
X |
||
|
Inventory count reconcile |
X |
||
|
Inventory log |
Get log inventory |
X |
|
|
Inventory transfer |
List inventory transfer |
X |
|
|
Create a transfer |
X |
||
|
Get inventory transfer by ID |
X |
||
|
Update a transfer |
X |
||
|
Archive a transfer |
X |
||
|
Restore a transfer |
X |
||
|
Send a transfer |
X |
||
|
Inventory transfer items |
List transfers items on a transfer |
X |
|
|
Get transferitem by ID |
X |
||
|
Add items to a transfer |
X |
||
|
Update transferitems |
X |
||
|
Delete transferitems |
X |
||
|
Item |
List items |
X |
|
|
Create item |
X |
||
|
Get item by ID |
X |
||
|
Update item |
X |
||
|
Delete item |
X |
||
|
Item attribute set |
List item attribute set |
X |
|
|
Get item attribute set by ID |
X |
||
|
Item custom field |
List item custom fields |
X |
|
|
Create item custom field |
X |
||
|
Get item custom field by ID |
X |
||
|
Update item custom field |
X |
||
|
Delete item custom field |
X |
||
|
Item custom field choice |
List custom field choice (item) |
X |
|
|
Item custom field choice |
X |
||
|
Get custom field choice by ID (item) |
X |
||
|
Update item custom field |
X |
||
|
Delete item custom field |
X |
||
|
Item matrix |
List item matrix |
X |
|
|
Create item matrix |
X |
||
|
Get item matrix by ID |
X |
||
|
Update item matrix |
X |
||
|
Delete item matrix |
X |
||
|
Locale |
List locale |
X |
|
|
Manufacturer |
List manufacturer |
X |
|
|
Create manufacturer |
X |
||
|
Get manufacturer by ID |
X |
||
|
Update manufacturer |
X |
||
|
Option |
Create option |
X |
|
|
Order |
List order |
X |
|
|
Create order |
X |
||
|
Get order by ID |
X |
||
|
Update order |
X |
||
|
Delete order |
X |
||
|
Order custom field |
Get order custom field by ID |
X |
|
|
Create order custom field |
X |
||
|
Delete order custom field |
X |
||
|
List order custom field |
X |
||
|
Create order custom field create |
X |
||
|
Order custom field choice |
Get order custom field choice by ID |
X |
|
|
Order custom field choice |
X |
||
|
Delete order custom field choice |
X |
||
|
List order custom field choice |
X |
||
|
Create order custom field choice create |
X |
||
|
Order line |
List order line |
X |
|
|
Get order line |
X |
||
|
Get order line by ID |
X |
||
|
Update order line |
X |
||
|
Delete order line |
X |
||
|
Payment type |
List payment type |
X |
|
|
Get payment type |
X |
||
|
Get payment type by ID |
X |
||
|
Update payment type |
X |
||
|
Delete payment type |
X |
||
|
Price level |
List price level |
X |
|
|
Get price level by ID |
X |
||
|
Price level |
X |
||
|
Quote |
List quote |
X |
|
|
Create quote |
X |
||
|
Get quote by ID |
X |
||
|
Update quote |
X |
||
|
Delete quote |
X |
||
|
Register |
List register |
X |
|
|
Get register by ID |
X |
||
|
Register calculated |
Register calculated |
X |
|
|
Register close |
Register close |
X |
|
|
Register count |
Get register count by ID |
X |
|
|
List register count |
X |
||
|
Register count amount |
List register count amount |
X |
|
|
Get register count amount by ID |
X |
||
|
Register open |
Register open |
X |
|
|
Register withdraw |
List register withdraw |
X |
|
|
Register withdraw |
X |
||
|
Get register withdraw by ID |
X |
||
|
Reports |
Reports accounting discounts by day |
X |
|
|
Reports accounting orders by tax class |
X |
||
|
Reports accounting tax class sales by day |
X |
||
|
Reports accounting taxes by day |
X |
||
|
Reports accounting payments by day |
X |
||
|
Sale |
List sale |
X |
|
|
Create sale |
X |
||
|
Get sale by ID |
X |
||
|
Update sale |
X |
||
|
Delete sale |
X |
||
|
Sale email receipt |
Sale email receipt |
X |
|
|
Sale line |
List sale line |
X |
|
|
Get sale line by ID |
X |
||
|
Create sale line |
X |
||
|
Delete sale line |
X |
||
|
Sale payment |
List sale payment |
X |
|
|
Get sale payment by ID |
X |
||
|
Sale payment signature |
List sale payment sale payment signature |
X |
|
|
Get sale payment sale payment signature by ID |
X |
||
|
Sale payment sale payment signature |
X |
||
|
Sale refund |
Sale refund |
X |
|
|
Sale void |
List sale void |
X |
|
|
Get sale void by ID |
X |
||
|
Sale: Sale line |
List sale line |
X |
|
|
Get sale line |
X |
||
|
Get sale line by ID |
X |
||
|
Update sale line |
X |
||
|
Delete sale line |
X |
||
|
Season |
List season |
X |
|
|
Create season |
X |
||
|
Delete season |
X |
||
|
Get season by ID |
X |
||
|
Update season |
X |
||
|
Serialized |
List serialized |
X |
|
|
Create serialized |
X |
||
|
Delete serialized |
X |
||
|
Get serialized by ID |
X |
||
|
Update serialized |
X |
||
|
Session |
Get session |
X |
|
|
Ship to |
List ship to |
X |
|
|
Get ship to by ID |
X |
||
|
Shop |
List shop |
X |
|
|
Create shop |
X |
||
|
Get shop by ID |
X |
||
|
Update shop |
X |
||
|
Special order |
List special order |
X |
|
|
Get special order by ID |
X |
||
|
Tag |
List tag |
X |
|
|
Update tag |
X |
||
|
Delete tag |
X |
||
|
Get tag by ID |
X |
||
|
Create tag |
X |
||
|
Tag group |
Tag group |
X |
|
|
Tax category |
List tax category |
X |
|
|
Tax category |
X |
||
|
Delete tax category |
X |
||
|
Get tax category by ID |
X |
||
|
Update tax category |
X |
||
|
Tax category class |
List tax category class |
X |
|
|
Tax category class |
X |
||
|
Get tax category class by ID |
X |
||
|
Tax class |
List tax class |
X |
|
|
Update tax class |
X |
||
|
Create tax class |
X |
||
|
Get tax class by ID |
X |
||
|
Delete tax class |
X |
||
|
Transfer |
List transfer |
X |
|
|
Get transfer by ID |
X |
||
|
Transfer item |
List transfer item |
X |
|
|
Get transfer item by ID |
X |
||
|
Vendor |
List vendor |
X |
|
|
Create vendor |
X |
||
|
Delete vendor |
X |
||
|
Get vendor by ID |
X |
||
|
Update vendor |
X |
||
|
Work order |
List work order |
X |
|
|
Get work order by ID |
X |
||
|
Work order item |
List work order item |
X |
|
|
Get work order item by ID |
X |
||
|
Work order line |
List work order line |
X |
|
|
Get work order line by ID |
X |
||
|
Work order status |
List work order status |
X |
|
|
Get work order status by ID |
X |
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Audit |
List audit events |
X |
|
|
List security events for current user |
X |
||
|
Brands |
List brands |
X |
|
|
Get a single brand |
X |
||
|
Create brand |
X |
||
|
Update a single brand |
X |
||
|
Delete a single brand |
X |
||
|
Channel request log |
List request records |
X |
|
|
Get single request log |
X |
||
|
Get a single request log as text |
X |
||
|
List channel records |
X |
||
|
Consignment products |
List products for consignment |
X |
|
|
Add a product to a consignment |
X |
||
|
Update a product in a consignment |
X |
||
|
Delete consignment product |
X |
||
|
Consignments |
List consignments |
X |
|
|
Get a single consignment |
X |
||
|
Get consignment totals |
X |
||
|
Create a consignment |
X |
||
|
Update a consignment |
X |
||
|
Delete a consignment |
X |
||
|
Customer groups |
List customer groups |
X |
|
|
Get single customer group |
X |
||
|
Get customers for customer group |
X |
||
|
Create new customer group |
X |
||
|
Update customer group |
X |
||
|
Delete customer group |
X |
||
|
Add customers to customer group |
X |
||
|
Delete customers from customer group |
X |
||
|
Customers |
List customers |
X |
|
|
Get a single customer |
X |
||
|
Create a new customer |
X |
||
|
Update a customer |
X |
||
|
Delete a customer |
X |
||
|
Fulfillment |
List sale fulfillments |
X |
|
|
Fulfil a sale |
X |
||
|
Gift cards |
List gift cards |
X |
|
|
Find gift card |
X |
||
|
Find gift card by transaction ID |
X |
||
|
Create gift card |
X |
||
|
Void gift card |
X |
||
|
Create gift card transaction |
X |
||
|
Reverse gift card transaction |
X |
||
|
Inventory |
List inventory records |
X |
|
|
Outlet product taxes |
List outlet product taxes |
X |
|
|
Outlets |
List outlets |
X |
|
|
Get a single outlet |
X |
||
|
Partner billing |
List partner subscriptions |
X |
|
|
Get partner subscription |
X |
||
|
Get subscription by token |
X |
||
|
Create a partner subscription token |
X |
||
|
Create partner update subscription token |
X |
||
|
Payment types |
List payment types |
X |
|
|
Pick lists |
List sale pick lists |
X |
|
|
Price books |
List price book products |
X |
|
|
List price book products |
X |
||
|
Delete a price book |
X |
||
|
Add products to price book |
X |
||
|
Delete price book products |
X |
||
|
Update products in price book |
X |
||
|
Update price book products |
X |
||
|
Price books (v3.0) |
List price books |
X |
|
|
Create a single price book |
X |
||
|
Get a single price book |
X |
||
|
Update a single price book |
X |
||
|
Product categories |
List product categories |
X |
|
|
Create and update a product category hierarchy |
X |
||
|
Delete product categories |
X |
||
|
Product images |
Get single product image data |
X |
|
|
Set image position |
X |
||
|
Delete product image |
X |
||
|
Product types |
Get a single product type |
X |
|
|
Products |
List products |
X |
|
|
Get a single product |
X |
||
|
Get inventory data for a single product |
X |
||
|
Get price books for product |
X |
||
|
Create product |
X |
||
|
Delete a single product |
X |
||
|
Delete a product family |
X |
||
|
Products (v2.1) |
Create a single variant |
X |
|
|
Update a product |
X |
||
|
Promo code |
Get active promo codes |
X |
|
|
Delete promo codes |
X |
||
|
Promotions |
Search promotions |
X |
|
|
List promotions |
X |
||
|
Get a promotion by ID |
X |
||
|
Get products for a promotion |
X |
||
|
Get promo codes for a promotion |
X |
||
|
Create a promotion |
X |
||
|
Update a promotion |
X |
||
|
Quotes |
Get quote |
X |
|
|
List quotes |
X |
||
|
Registers |
List registers |
X |
|
|
Get a single register |
X |
||
|
Get payments summary |
X |
||
|
Open a single register |
X |
||
|
Close a single register |
X |
||
|
Search |
Search for resources |
X |
|
|
Serial numbers |
List serial numbers |
X |
|
|
Get a single serial number |
X |
||
|
Create a serial number |
X |
||
|
Delete serial number |
X |
||
|
Service orders |
List services |
X |
|
|
Get service |
X |
||
|
Get services agenda by outlet |
X |
||
|
List a customer's service items |
X |
||
|
Shifts |
List shifts |
X |
|
|
Store credits |
List store credit |
X |
|
|
List of store credits for the given customer ID |
X |
||
|
List of store credit for multiple customers |
X |
||
|
Returns a report of store credits |
X |
||
|
Create store credit transaction |
X |
||
|
Suppliers |
List suppliers |
X |
|
|
Get a single supplier |
X |
||
|
Create new supplier |
X |
||
|
Update a supplier |
X |
||
|
Delete a single supplier |
X |
||
|
Tags |
List tags |
X |
|
|
Get a single tag |
X |
||
|
Create tag |
X |
||
|
Update a single tag |
X |
||
|
Delete a single tag |
X |
||
|
Taxes |
List taxes |
X |
|
|
Users |
Get current user |
X |
|
|
List users |
X |
||
|
Get multiple users by ID |
X |
||
|
Get a single user |
X |
||
|
Get user sales totals |
X |
||
|
Delete user |
X |
||
|
Delete user sessions |
X |
||
|
Variant attributes |
Retrieve all variant attributes |
X |
|
|
Retrieve a single variant attribute |
X |
||
|
Create a variant attribute |
X |
||
|
Update a variant attribute's name |
X |
||
|
Delete a variant attribute |
X |
||
|
Webhooks |
Get webhook |
X |
|
|
List webhooks |
X |
||
|
Update webhook |
X |
||
|
Delete webhook |
X |
||
|
Create webhook |
X |
||
|
Workflows |
Get custom field definitions |
X |
|
|
List custom field values |
X |
||
|
List remote rules |
X |
||
|
List rules |
X |
||
|
Create custom field |
X |
||
|
Update a custom field |
X |
||
|
Delete custom field |
X |
||
|
Set new custom field values |
X |
||
|
Create remote rule |
X |
||
|
Delete remote rule |
X |
||
|
Create rule |
X |
||
|
Delete business rule |
X |