Lightspeed-retail actions
Lightspeed-retail API component actions.
Create Object
Action creates a new record/object. This action is supported by limited list of entities.
Input fields description
- Object type - you should select the type of object which updates you want to get.
Supported entities:
- Category
- CreditAccount
- Customer
- CustomerCustomField
- CustomerType
- Discount
- EmployeeHours
- InventoryTransfer
- InventoryCount
- InventoryCountItem
- Item
- ItemCustomField
- ItemMatrix
- Manufacturer
- Order
- OrderCustomField
- OrderLine
- PaymentType
- Quote
- RegisterClose
- RegisterOpen
- RegisterWithdraw
- Sale
- SaleEmailReceipt
- Season
- Serialized
- Tag
- TaxCategory
- TaxClass
- Vendor
Upsert Object
Action creates a new object or updates object which already exists by provided ID. This action is supported by limited list of entities.
Input fields description
- Object type - you should select the type of object which updates you want to get.
Supported entities:
- Category
- CreditAccount
- Customer
- CustomerCustomField
- CustomerType
- Discount
- Employee
- EmployeeHours
- Industry
- InventoryTransfer
- InventoryCount
- InventoryCountItem
- Item
- ItemCustomField
- ItemMatrix
- Manufacturer
- Order
- OrderCustomField
- OrderLine
- PaymentType
- PriceLevel
- Quote
- RegisterClose
- RegisterOpen
- RegisterWithdraw
- Sale
- SaleEmailReceipt
- SaleLine
- Season
- Serialized
- Shop
- Tag
- TaxCategory
- TaxClass
- Vendor
Update Object
Action updates object which already exists by provided ID. This action is supported by limited list of entities.
Input fields description
- Object type - you should select the type of object which updates you want to get.
Supported entities:
- Category
- CreditAccount
- Customer
- CustomerCustomField
- CustomerType
- Discount
- Employee
- EmployeeHours
- Industry
- InventoryTransfer
- InventoryCount
- InventoryCountItem
- Item
- ItemCustomField
- ItemMatrix
- Manufacturer
- Order
- OrderCustomField
- OrderLine
- PaymentType
- PriceLevel
- Quote
- Sale
- SaleLine
- Season
- Serialized
- Shop
- Tag
- TaxCategory
- TaxClass
- Vendor
Lookup Object By ID
Action gets a list of objects by filters or specific object by provided ID.
Input fields description
- Object type - you should select the type of object which updates you want to get.
Supported entities:
- Account
- CatalogVendorItem
- Category
- CCCharge
- CreditAccount
- Customer
- CustomerCustomField
- CustomerType
- Discount
- Employee
- EmployeeHours
- Industry
- InventoryTransfer
- InventoryCount
- InventoryCountCalc
- InventoryCountItem
- Item
- ItemCustomField
- ItemAttributeSet
- ItemMatrix
- Locale
- Manufacturer
- Option
- Order
- OrderCustomField
- OrderLine
- PaymentType
- PriceLevel
- Quote
- Register
- RegisterCalculated
- RegisterCount
- RegisterCountAmount
- RegisterWithdraw
- Sale
- SaleLine
- SalePayment
- SaleVoid
- Season
- Serialized
- Session
- ShipTo
- Shop
- SpecialOrder
- Tag
- TaxCategory
- TaxClass
- Transfer
- TransferItem
- Vendor
- Workorder
- WorkorderItem
- WorkorderLine
- WorkorderStatus
Delete Object By ID
Action removes object which already exists by provided ID.
Input fields description
- Object type - you should select the type of object which updates you want to get.
Supported entities:
- Category
- CreditAccount
- Customer
- CustomerCustomField
- CustomerType
- Discount
- Employee
- EmployeeHours
- InventoryCount
- InventoryCountItem
- Item
- ItemCustomField
- ItemMatrix
- Order
- OrderCustomField
- OrderLine
- PaymentType
- Quote
- Sale
- SaleLine
- Season
- Serialized
- Tag
- TaxCategory
- TaxClass
- Vendor