Articles in this section

Available Lightspeed APIs

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 Lighspeed API documentation . You can also create a composite endpoint for this application in HTTP mode.

Note: You can also create a composite endpoint for this application. For more information, see Application-specific (simple) forms.

{{start input collapse count=1}}

{{label=API v3 version}}

Resource

API endpoint

Export

Import

Account

Account - List

X

Account get by ID

X

Catalog search

Catalog search

X

Catalog vendor item

Catalog vendor item - List

X

Catalog vendor item get by ID

X

Category

Category - List

X

Create a category

X

Category get by ID

X

Update a category

X

Delete a category

X

CC charge

CC charge - List

X

CC charge get by ID

X

Credit account

Credit account - List

X

Create credit account

X

Credit account get by ID

X

Update credit account

X

Delete credit account

X

Customer

Customer - List

X

Create customer

X

Customer get by ID

X

Update customer

X

Delete customer

X

Customer custom field

Custom field - List

X

Create custom field

X

Custom field get by ID

X

Update custom field

X

Delete custom field

X

Customer field choice

Custom field choice- List [customer]

X

Create custom field choice [customer]

X

Custom field choice get by ID [customer]

X

Update custom field choice [customer]

X

Delete custom field choice [customer]

X

Customer type

Customer type- List

X

Create customer type

X

Customertype get by ID

X

Update customer type

X

Delete customer type

X

Discount

Discount - List

X

Discount

X

Discount get by ID

X

Update discount

X

Delete discount

X

Display template employee

Display template employee - List

X

Display template employee get by ID

X

Display template item as label

Display template item as label - List

X

Display template item as label get by ID

X

Display template label

Display template label - List

X

Display template label get by ID

X

Display template order

Display template order - List

X

Display template order get by ID

X

Display template order line as label

Display template order line as label - List

X

Display template order line as label get by ID

X

Display template register count

Display template register count - List

X

Display template register withdraw

Display template register withdraw - List

X

Display template register withdraw get by ID

X

Display template sale

Display template sale - List

X

Display template sale get by ID

X

Display template transfer

Display template transfer - List

X

Display template transfer get by ID

X

Display template transfer item as label

Display template transfer item as label - List

X

Display template transfer item as label get by ID

X

Display template vendor return

Display template vendor return - List

X

Display template vendor return get by ID

X

Display template work order

Display template work order - List

X

Display template work order get by ID

X

Employee

Employee - List

X

Employee

X

Employee get by ID

X

Update employee

X

Delete employee

X

Employee hours

Employee hours - List

X

Employee hours

X

Employee hours get by ID

X

Update employee hours

X

Delete employee hours

X

Industry

Industry - List

X

Industry get by ID

X

Industry

X

Inventory count

Inventory count - List

X

Inventory count

X

Inventory count get by ID

X

Update inventory count

X

Delete inventory count

X

Inventory count calc

Inventory count calc - List

X

Inventory count calc get by ID

X

Inventory count item

Inventory count item - List

X

Inventory count item

X

Inventory count item get by ID

X

Update inventory count item

X

Delete inventory count item

X

Inventory count reconcile

Inventory count reconcile - List

X

Inventory count reconcile get by ID

X

Inventory count reconcile

X

Inventory log

Inventory log

X

Inventory transfer

Inventory transfer - List

X

Create a transfer

X

Inventory transfer get by ID

X

Update a transfer

X

Archive a transfer

X

Restore a transfer

X

Send a transfer

X

Inventory transfer items

Transfers items on a transfer - List

X

Transfer item get by ID

X

Add items to a transfer

X

Update transfer items

X

Delete transfer items

X

Item

Items - List

X

Create item

X

Item get by ID

X

Update item

X

Delete item

X

Item attribute set

Item attribute set - List

X

Item attribute set get by ID

X

Item custom field

Item custom fields - List

X

Item custom field

X

Item custom field get by ID

X

Update item custom field

X

Delete item custom field

X

Item custom field choice

Custom field choice - List [item]

X

Item custom field choice

X

Custom field choice get by ID [item]

X

Update Item custom field choice

X

Delete Item custom field choice

X

Item matrix

Item matrix - List

X

Item matrix

X

Item matrix get by ID

X

Update item matrix

X

Delete item matrix

X

Locale

Locale - List

X

Manufacturer

Manufacturer - List

X

Manufacturer

X

Manufacturer get by ID

X

Update manufacturer

X

Option

Option

X

Order

Order - List

X

Order

X

Order get by ID

X

Update order

X

Delete order

X

Order custom field

Order custom field get by ID

X

Order custom field

X

Delete order custom field

X

Order custom field - List

X

Create order custom field Create

X

Order custom field choice

Order custom field choice get by ID

X

Order custom field custom field choice

Order custom field choice

X

Delete order custom field choice

X

Order custom field choice - List

X

Create order custom field create

X

Order line

Order line - List

X

Order line

X

Order line get by ID

X

Update order line

X

Delete order line

X

Payment type

Payment type - List

X

Payment type

X

Payment type get by ID

X

Update payment type

X

Delete payment type

X

Price level

Price level - List

X

Price level get by ID

X

Price level

X

Quote

Quote - List

X

Quote

X

Quote get by ID

X

Update quote

X

Delete quote

X

Register

Register - List

X

Register get by ID

X

Register calculated

Register calculated

X

Register close

Register close

X

Register count

Register count get by ID

X

Register count - List

X

Register count amount

Register count amount - List

X

Register count amount get by ID

X

Register open

Register open

X

Register withdraw

Register withdraw - List

X

Register withdraw

X

Register withdraw get 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

Sale - List

X

Sale

X

Sale get by ID

X

Update sale

X

Delete sale

X

Sale email receipt

Sale email receipt

X

Sale line

Sale line - List

X

Sale line get by ID

X

Sale line

X

Delete sale line

X

Sale payment

Sale payment - List

X

Sale payment get by ID

X

Sale payment signature

Sale payment signature - List

X

Sale payment signature get by ID

X

Sale payment signature

X

Sale refund

Sale refund

X

Sale sale line

Sale sale line - List

X

Sale sale line

X

Sale sale line get by ID

X

Update sale sale line

X

Delete sale sale line

X

Sale void

Sale void - List

X

Sale void get by ID

X

Season

Season - List

X

Season

X

Delete season

X

Season get by ID

X

Update season

X

Serialized

Serialized - List

X

Serialized

X

Serialized

X

Serialized get by ID

X

Update serialized

X

Session

Session

X

Ship to

Ship to - List

X

Ship to get by ID

X

Shop

Shop - List

X

Shop

X

Shop get by ID

X

Update shop

X

Special order

Special order - List

X

Special order get by ID

X

Tag

Tag - List

X

Tag

X

Delete tag

X

Tag get by ID

X

Tag

X

Tag group

Tag group

X

Tax category

Tax category - List

X

Tax category

X

Delete tax category

X

Tax category get by ID

X

Update tax category

X

Tax category class

Tax category class - List

X

Tax category class

X

Tax category class get by ID

X

Tax class

Tax class - List

X

Tax class

X

Delete tax class

X

Tax class get by ID

X

Update tax class

X

Transfer

Transfer - List

X

Transfer get by ID

X

Transfer item

Transfer item - List

X

Transfer item get by ID

X

Vendor

Vendor - List

X

Vendor

X

Delete vendor

X

Vendor get by ID

X

Update vendor

X

Work order

Work order - List

X

Work order get by ID

X

Work order item

Work order item - List

X

Work order item get by ID

X

Work order line

Work order line - List

X

Work order line get by ID

X

Work order status

Work order status - List

X

Work order status get by ID

X

{{start input collapse count=2}}

{{label=API v2 version}}

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

X

Update a credit account

X

Archive a credit account

X

Customer

All customers

X

Retrieve a customer

X

All custom fields

X

Retrieve a custom field

X

Create a customer

X

Update a customer

X

Archive a customer

X

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

Single inventory count

X

Create an inventory count

X

Update an inventory count

X

Delete an inventory count

X

Inventory count calc

All inventory counts calculations

X

Single inventory count calculation

X

Inventory count item

All inventories count items

X

Inventory count items

X

Create an inventory count item

X

Update an inventory count item

X

Delete an inventory count item

X

Inventory count reconcile

All inventory count reconciles

X

Single inventory count reconcile

X

Create an inventory count reconcile

X

Item

All items

X

Single item

X

Create an item

X

Update an item

X

Delete an item

X

Item attribute set

All item attribute sets

X

Single item attribute set

X

Item matrix

All items matrix

X

Single item matrix

X

Create an item matrix

X

Update an item matrix

X

Delete an item matrix

X

Order

All orders

X

Single order

X

Create an order

X

Update an order

X

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 sale lines

X

Single sale sale line

X

Create a sale

X

Update a sale

X

Sale email receipt

X

Delete a sale

X

Create a sale sale line

X

Update a sale sale line

X

Delete a sale sale line

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

Ship to

All ships to

X

Single ship to

X

Special order

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

All work orders

X

Single work order

X

Work order item

All work order items

X

Single work order item

X

All work order lines

X

Single work order lines

X

{{end input collapse count=2}}

{{end input collapse count=1}}

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.