### GET All Sale Lines Example Source: https://developers.lightspeedhq.com/retail/endpoints/SaleLine This example demonstrates how to retrieve all sale lines. It includes associated sales accounts and item fees. ```json { "SalesAccounts": { "SaleAccount": { "saleAccountID": "1", "creditAccountID": "1", "salePaymentID": "1", "saleLineID": "1" } }, "ItemFee": { "itemFeeID": "6", "name": "Bottle Deposit", "calculationMethod": "fixed_amount", "feeValue": "0.50", "taxable": "false", "discountable": "false", "nonRefundable": "false", "archived": "false", "createTime": "2024-02-07T20:36:15+00:00", "timestamp": "2024-02-21T18:37:49+00:00" } } ] } ``` -------------------------------- ### Sample Request to Get All Sales Source: https://developers.lightspeedhq.com/retail/endpoints/DisplayTemplate-Sale This sample demonstrates how to make a GET request to the All Sales endpoint using curl. Include your authorization token and account ID. ```bash $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/DisplayTemplate/Sale.json" ``` -------------------------------- ### Account Object Example (JSON) Source: https://developers.lightspeedhq.com/retail/endpoints/Account This is an example of the JSON structure returned when retrieving account information. It includes the account ID, name, and a link to the account resource. ```json "Account": { "accountID": "{accountID}", "name": "{Account Name}", "link": { "@attributes": { "href": "/API/V3/Account/{accountID}" } } } ``` -------------------------------- ### Example Purchase Order Response Body Source: https://developers.lightspeedhq.com/retail/tutorials/inventory This is an example of a successful response when creating a purchase order. It contains details of the created order. ```json { "@attributes": { "count": "1" }, "Order": { "orderID": "14", "shipInstructions": "", "stockInstructions": "", "shipCost": "10", "otherCost": "0", "complete": "false", "archived": "false", "discount": "0", "totalDiscount": "0", "totalQuantity": "0", "timeStamp": "2016-11-08T17:03:21+00:00", "refNum": "", "vendorID": "2", "noteID": "0", "shopID": "1" } } ``` -------------------------------- ### Sample Request to Get All Orders Source: https://developers.lightspeedhq.com/retail/endpoints/DisplayTemplate-Order This is a sample cURL command to make a GET request to the All Orders endpoint. Remember to include your authorization token and account ID. ```bash $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/DisplayTemplate/Order.json" ``` -------------------------------- ### Retrieve All Options Source: https://developers.lightspeedhq.com/retail/endpoints/Option Use this endpoint to get a comprehensive list of all configurable options for a specific account. Ensure you replace `{Access Token}` and `{accountID}` with your actual credentials and account identifier. ```bash $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/Option.json" ``` -------------------------------- ### Example Response for Adding a Product Source: https://developers.lightspeedhq.com/retail/tutorials/itemmatrix This is a successful response after adding a product. It includes details of the created item, its attributes, and associated pricing and shop information. ```json { "@attributes": { "count": "1" }, "Item": { "itemID": "133", "systemSku": "210000000133", "defaultCost": "0", "avgCost": "0", "discountable": "true", "tax": "true", "archived": "false", "itemType": "default", "serialized": "false", "description": "T-Shirt White Small", "modelYear": "0", "upc": "", "ean": "", "customSku": "", "manufacturerSku": "", "createTime": "2017-12-04T19:49:44+00:00", "timeStamp": "2017-12-04T19:53:35+00:00", "publishToEcom": "true", "categoryID": "0", "taxClassID": "1", "departmentID": "0", "itemMatrixID": "20", "manufacturerID": "0", "seasonID": "0", "defaultVendorID": "0", "ItemAttributes": { "attribute1": "White", "attribute2": "Small", "attribute3": "", "itemAttributeSetID": "1" }, "ItemMatrix": { "itemMatrixID": "20", "description": "T-Shirt", "tax": "true", "defaultCost": "10", "itemType": "default", "serialized": "false", "modelYear": "0", "archived": "false", "timeStamp": "2017-12-04T19:53:35+00:00", "itemAttributeSetID": "1", "manufacturerID": "0", "categoryID": "0", "defaultVendorID": "0", "taxClassID": "1", "seasonID": "0", "departmentID": "0", "Prices": { "ItemPrice": [ { "amount": "20", "useTypeID": "1", "useType": "Default" }, { "amount": "15", "useTypeID": "2", "useType": "MSRP" }, { "amount": "0", "useTypeID": "3", "useType": "My Online Store" }, { "amount": "0", "useTypeID": "5", "useType": "Online" } ] }, "attribute1Values": "White", "attribute2Values": "Small" }, "ItemShops": { "ItemShop": [ { "itemShopID": "666", "qoh": "0", "backorder": "0", "componentQoh": "0", "componentBackorder": "0", "reorderPoint": "0", "reorderLevel": "0", "timeStamp": "2017-12-04T19:49:44+00:00", "itemID": "133", "shopID": "1" }, { "itemShopID": "667", "qoh": "0", "backorder": "0", "componentQoh": "0", "componentBackorder": "0", "reorderPoint": "0", "reorderLevel": "0", "timeStamp": "2017-12-04T19:49:44+00:00", "itemID": "133", "shopID": "2" }, { "itemShopID": "668", "qoh": "0", "backorder": "0", "componentQoh": "0", "componentBackorder": "0", "reorderPoint": "0", "reorderLevel": "0", "timeStamp": "2017-12-04T19:49:44+00:00", "itemID": "133", "shopID": "3" }, { "itemShopID": "665", "qoh": "0", "backorder": "0", "componentQoh": "0", "componentBackorder": "0", "reorderPoint": "0", "reorderLevel": "0", "timeStamp": "2017-12-04T19:49:44+00:00", "itemID": "133", "shopID": "0" } ] }, "Prices": { "ItemPrice": [ { "amount": "0", "useTypeID": "1", "useType": "Default" }, { "amount": "0", "useTypeID": "2", "useType": "MSRP" } ] } } } ``` -------------------------------- ### GET All Tax Categories Source: https://developers.lightspeedhq.com/retail/endpoints/TaxCategory Retrieve a list of all tax categories configured for the account. This is useful for viewing existing tax setups. ```shell curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/TaxCategory.json" ``` -------------------------------- ### Counting Total Records Source: https://developers.lightspeedhq.com/retail/introduction/pagination This example shows how to get the total count of records matching specific criteria without returning any records. ```APIDOC ## GET /API/V3/Account/{AccountID}/Item.json?count=1 ### Description Retrieves the total count of items matching the criteria. No item records are returned. ### Method GET ### Endpoint /API/V3/Account/{AccountID}/Item.json ### Query Parameters - **count** (integer) - Required - Set to `1` to enable counting. ### Response #### Success Response (200) - **@attributes** (object) - Contains metadata including the count. - **count** (integer) - The total number of records matching the criteria. ### Note Combining `count=1` with pagination or sorting parameters (`limit`, `next`, `previous`, `sort`) will result in an error. ``` -------------------------------- ### Example URL from Button Click Source: https://developers.lightspeedhq.com/retail/tutorials/custombutton This is an example of the URL that Retail POS appends query parameters to when a custom button is clicked. These parameters provide context about the user and the current sale. ```text {Menu Button base URL} ?accountID=5 &alg=RS256 &customerID=0 &employeeID=1 &exp=1733416075 &kid=RT_GENERIC_WEBHOOK_2023_03_17 ®isterID=1 &returnURL=https%3A%2F%2Fus.lightspeedapp.com%2Fregister.php &saleID=119 &shopID=1 &systemUserID=4 &type=sale &signature={Signature} ``` -------------------------------- ### GET Single Transfer Response Sample Source: https://developers.lightspeedhq.com/retail/endpoints/Inventory-Transfer Example JSON response for a single inventory transfer. It provides detailed information about the specified transfer. ```json { "@attributes": { "count": "1" }, "Transfer": { "transferID": "1", "note": "", "archived": "false", "timeStamp": "2021-01-29T21:19:43+00:00", "createTime": "2021-01-29T21:19:43+00:00", "status": "open", "sentOn": "2021-01-29T21:19:43+00:00", "needBy": "2021-01-29T21:19:43+00:00", "sendingShopID": "1", "sentByEmployeeID": "0", "receivingShopID": "2", "createdByEmployeeID": "1" } } ``` -------------------------------- ### Read Item Collection (JSON) Source: https://developers.lightspeedhq.com/retail Example of reading a collection of Item objects using an HTTP GET request, specifying JSON format in the URI. ```http https://api.lightspeedapp.com/API/V3/Account/{AccoundID}/Item.json ``` -------------------------------- ### Sample Request to Get All Items as Labels Source: https://developers.lightspeedhq.com/retail/endpoints/DisplayTemplate-ItemAsLabel This cURL command demonstrates how to make a request to the API endpoint. Include your authorization token and account ID. ```Shell $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/DisplayTemplate/ItemAsLabel.json" ``` -------------------------------- ### GET All Transfer Items Response Example Source: https://developers.lightspeedhq.com/retail/endpoints/TransferItem This is a sample JSON response when retrieving all transfer items. It includes details for each item such as quantities, values, and associated IDs. ```json { "@attributes": { "next": "", "previous": "" }, "TransferItem": [ { "transferItemID": "2", "toSend": "0", "toReceive": "0", "sent": "0", "received": "10", "sentValue": "0", "receivedValue": "3000", "comment": "", "timeStamp": "2021-06-10T14:16:47+00:00", "transferID": "1", "itemID": "5" }, { "transferItemID": "3", "toSend": "1", "toReceive": "0", "sent": "0", "received": "0", "sentValue": "0", "receivedValue": "0", "comment": "", "timeStamp": "2021-04-21T19:39:35+00:00", "transferID": "2", "itemID": "47" } ] } ``` -------------------------------- ### GET All Transfers Response Sample Source: https://developers.lightspeedhq.com/retail/endpoints/Inventory-Transfer Example JSON response when retrieving multiple inventory transfers. It includes details for each transfer such as IDs, dates, and shop assignments. ```json { "@attributes": { "next": "", "previous": "" }, "Transfer": [ { "transferID": "1", "note": "Transfer note", "archived": "false", "timeStamp": "2021-01-29T21:19:43+00:00", "createTime": "2021-01-29T21:19:43+00:00", "status": "open", "sentOn": "2021-01-29T21:19:43+00:00", "needBy": "2021-01-29T21:19:43+00:00", "sendingShopID": "1", "sentByEmployeeID": "0", "receivingShopID": "2", "createdByEmployeeID": "1" }, { "transferID": "2", "note": "Transfer note", "archived": "false", "timeStamp": "2021-01-30T12:00:32+00:00", "createTime": "2021-01-30T12:00:32+00:00", "status": "open", "sentOn": "2021-01-30T12:00:32+00:00", "needBy": "2021-01-30T12:00:32+00:00", "sendingShopID": "1", "sentByEmployeeID": "0", "receivingShopID": "2", "createdByEmployeeID": "1" } ] } ``` -------------------------------- ### Sample JSON Response for Options Source: https://developers.lightspeedhq.com/retail/endpoints/Option This is an example of the JSON structure returned when successfully retrieving all options. It includes various settings like auto-logout delay, cost method, and display preferences. ```json { "Option": [ { "name": "auto_logout_delay", "value": "120" }, { "name": "require_pin_delay", "value": "0" }, { "name": "cost_method", "value": "average" }, { "name": "require_pin_before_each_sale", "value": "" }, { "name": "no_discounts_on_labor", "value": "" }, { "name": "require_customer_for_serialized_sales", "value": "" }, { "name": "no_original_receipt_refund_to_credit_account_only", "value": "" }, { "name": "no_auto_switching_to_box_of_from_singles_on_sales", "value": "" }, { "name": "disable_giftcard_refunds", "value": "" }, { "name": "disable_credit_refunds", "value": "" }, { "name": "disable_inventory_warnings", "value": "" }, { "name": "billing_header", "value": "" }, { "name": "billing_address", "value": "" }, { "name": "billing_payable_to", "value": "" }, { "name": "billing_show_limit", "value": "" }, { "name": "billing_days_till_due", "value": "30" }, { "name": "billing_percent_due", "value": "1.0E-8" }, { "name": "import_catalog_categories_with_products", "value": "" }, { "name": "disable_email", "value": "" }, { "name": "email_header", "value": "" }, { "name": "email_footer", "value": "" }, { "name": "email_reply_to", "value": "" }, { "name": "email_subject", "value": "" }, { "name": "label_size", "value": "2.25x1.25" }, { "name": "scan_small_labels", "value": "" }, { "name": "disable_receipt_auto_print", "value": "" }, { "name": "locale", "value": "United States" }, { "name": "locale_code", "value": "" }, { "name": "share_item_data_online", "value": "" }, { "name": "first_start_status", "value": "done" }, { "name": "last_welcome_back", "value": "" }, { "name": "goto_training_registered", "value": "" }, { "name": "background_url", "value": "" }, { "name": "logo_url", "value": "" }, { "name": "invert_logo", "value": "true" }, { "name": "hide_custom_fields", "value": "" }, { "name": "currency_code", "value": "0" }, { "name": "tax_pricing", "value": "0" }, { "name": "date_format", "value": "m/d/Y" }, { "name": "ecom_language", "value": "en_US" }, { "name": "payments_settings_opencashdrawer", "value": "all_payments" }, { "name": "publish_item_to_ecom_limit", "value": "" }, { "name": "publish_to_ecom_default_value", "value": "0" }, { "name": "publish_to_ecom_matrix_child_limit", "value": "" }, { "name": "loyalty_merchant_id", "value": "" }, { "name": "payment_settings_migrated", "value": "3" } ] } ``` -------------------------------- ### POST Create a Discount - Sample JSON Response Source: https://developers.lightspeedhq.com/retail/endpoints/Discount This is a sample JSON response after successfully creating a new discount. It includes the details of the newly created discount. ```json { "@attributes": { "count": "1" }, "Discount": { "discountID": "5", "name": "10 Percent", "discountAmount": "50", "discountPercent": "0", "requireCustomer": "false", "archived": "false", "timeStamp": "2021-03-22T20:04:15+00:00" } } ``` -------------------------------- ### Read Item Collection (XML) Source: https://developers.lightspeedhq.com/retail Example of reading a collection of Item objects using an HTTP GET request. The .xml extension specifies the desired response format. ```http https://api.lightspeedapp.com/API/V3/Account/{AccoundID}/Item ``` -------------------------------- ### Create Item Example (POST) Source: https://developers.lightspeedhq.com/retail/introduction/introduction Use an HTTP POST request to create a new Item object. The payload should be an XML block defining the new object. Fields omitted will be set to their default values. ```HTTP POST /API/V3/Account/1/Item My new item 10.00 ``` -------------------------------- ### GET All RegisterWithdraws Sample Request Source: https://developers.lightspeedhq.com/retail/endpoints/DisplayTemplate-RegisterWithdraw Example cURL command to retrieve all register withdraw records. Ensure you replace {Access Token} and {accountID} with your actual credentials and account identifier. ```shell $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/DisplayTemplate/RegisterWithdraw.json" ``` -------------------------------- ### Sample Request to Update Item Source: https://developers.lightspeedhq.com/retail/endpoints/Item This sample demonstrates how to send a PUT request to update an item's description. Ensure you include your authorization token and the correct account and item IDs. ```bash $ curl -X PUT -H "Authorization: Bearer {Access Token}" \ -d '{ "description": "The best product" }' "https://api.lightspeedapp.com/API/V3/Account/{accountID}/Item/{itemID}.json" ``` -------------------------------- ### GET Taxes by day API Endpoint Source: https://developers.lightspeedhq.com/retail/endpoints/Reports-Accounting-TaxesByDay Use this endpoint to retrieve a list of taxes collected per day. Specify the start and end dates for the desired reporting period. This is a read-only report. ```bash $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/Reports/Accounting/TaxesByDay.json?startDate={startDate}&endDate={endDate}" ``` -------------------------------- ### GET Single Transfer Item Response Example Source: https://developers.lightspeedhq.com/retail/endpoints/TransferItem This is a sample JSON response for a single transfer item. It returns the details of the requested item, including its ID, quantities, and associated transfer and item IDs. ```json { "@attributes": { "count": "1" }, "TransferItem": { "transferItemID": "2", "toSend": "0", "toReceive": "0", "sent": "0", "received": "10", "sentValue": "0", "receivedValue": "3000", "comment": "", "timeStamp": "2021-06-10T14:16:47+00:00", "transferID": "1", "itemID": "5" } } ``` -------------------------------- ### V3 Pagination Example Source: https://developers.lightspeedhq.com/retail/tutorials/v2v3migration This example shows how to retrieve the second page of results, including the 'next' and 'previous' attributes for managing pagination. The 'previous' attribute contains a 'before' parameter necessary for fetching preceding pages. ```json { "@attributes": { "next": "https://api.lightspeedapp.com/API/V3/Account/182255/Sale.json?sort=saleID&limit=100&after=WzIwNl0%3D", "previous": "https://api.lightspeedapp.com/API/V3/Account/182255/Sale.json?sort=saleID&limit=100&before=WzEwNl0%3D" }, "Sale": [ { "saleID": "106", "timeStamp": "2019-02-15T19:27:52+00:00", "discountPercent": "0", "completed": "false", "archived": "false", "voided": "false" } ] } ``` -------------------------------- ### GET All Employees Source: https://developers.lightspeedhq.com/retail/endpoints/Employee Retrieve a list of all employees associated with the account. This endpoint is useful for getting an overview of all personnel. ```APIDOC ## GET /API/V3/Account/{accountID}/Employee.json ### Description Retrieve a list of all employees in the account. ### Method GET ### Endpoint /API/V3/Account/{accountID}/Employee.json ### Parameters #### Path Parameters - **accountID** (string) - Required - The unique identifier for the account. ### Response #### Success Response (200) - **@attributes** (object) - Contains metadata about the response, such as pagination details. - **Employee** (array) - A list of employee objects. - **employeeID** (string) - The unique identifier for the employee. - **firstName** (string) - The first name of the employee. - **lastName** (string) - The last name of the employee. - **lockOut** (string) - Indicates if the employee is locked out. - **archived** (string) - Indicates if the employee is archived. - **timeStamp** (string) - The timestamp of the record. - **contactID** (string) - The contact ID associated with the employee. - **clockInEmployeeHoursID** (string) - The ID for the employee's clock-in hours. - **employeeRoleID** (string) - The ID of the employee's role. - **limitToShopID** (string) - The ID of the shop the employee is limited to. - **lastShopID** (string) - The ID of the last shop the employee was associated with. - **lastSaleID** (string) - The ID of the last sale the employee was involved in. - **lastRegisterID** (string) - The ID of the last register the employee used. ### Request Example ```bash $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/Employee.json" ``` ### Response Example ```json { "@attributes": { "next": "", "previous": "" }, "Employee": [ { "employeeID": "1", "firstName": "Alex ", "lastName": "Lugo", "lockOut": "false", "archived": "false", "timeStamp": "2021-03-23T14:33:22+00:00", "contactID": "1", "clockInEmployeeHoursID": "0", "employeeRoleID": "4", "limitToShopID": "0", "lastShopID": "2", "lastSaleID": "143", "lastRegisterID": "0" }, {...} ] } ``` ``` -------------------------------- ### POST Create Shop Source: https://developers.lightspeedhq.com/retail/endpoints/Shop Create a new shop by providing necessary parameters such as the shop's name. The response includes the newly created shop's details and associated contact information. ```bash $ curl -X POST -H "Authorization: Bearer {Access Token}" \ -d '{ "name": "2nd Location", }' "https://api.lightspeedapp.com/API/V3/Account/{accountID}/Shop.json" ``` -------------------------------- ### GET Single manufacturer Source: https://developers.lightspeedhq.com/retail/endpoints/Manufacturer Retrieve a single manufacturer by its ID. Use this endpoint to get details for a specific manufacturer. ```APIDOC ## GET Single manufacturer ### Description Retrieve a single manufacturer by its ID. ### Method GET ### Endpoint /API/V3/Account/{accountID}/Manufacturer/{manufacturerID}.json ### Parameters #### Path Parameters - **manufacturerID** (integer) - Required - The unique numerical ID for the manufacturer. ### Request Example ```bash curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/Manufacturer/{manufacturerID}.json" ``` ### Response Example ```json { "@attributes": { "count": "1" }, "Manufacturer": { "manufacturerID": "2", "name": "LightSpeed", "createTime": "2021-03-18T20:57:49+00:00", "timeStamp": "2021-04-03T16:17:11+00:00" } } ``` ``` -------------------------------- ### Example Request Body for Reconciling Count Source: https://developers.lightspeedhq.com/retail/tutorials/inventory This is an example of the JSON payload required to reconcile an inventory count. It only requires the `inventoryCountID`. ```json { "inventoryCountID": 3 } ``` -------------------------------- ### Create Item Source: https://developers.lightspeedhq.com/retail/endpoints/Item Creates a new item with its product information and initial inventory levels. ```APIDOC ## POST /item ### Description Creates a new item with its product information and initial inventory levels. ### Method POST ### Endpoint /item ### Parameters #### Request Body - **item** (object) - Required - The details of the item to create. - **description** (string) - Required - The name or description of the item. - **price** (number) - Required - The selling price of the item. - **cost** (number) - Required - The cost of the item. - **upc** (string) - Optional - The Universal Product Code. - **ean** (string) - Optional - The European Article Number. - **inventory** (array) - Optional - An array of inventory levels per shop. - **shopID** (integer) - Required - The ID of the shop. - **quantity** (integer) - Required - The quantity of the item in the shop. ### Request Example ```json { "item": { "description": "New Gadget", "price": 29.99, "cost": 15.00, "upc": "123456789012", "inventory": [ { "shopID": 1, "quantity": 100 } ] } } ``` ### Response #### Success Response (201) - **item** (object) - The newly created item with its assigned itemID. #### Response Example ```json { "item": { "itemID": 456, "itemCode": "456", "description": "New Gadget", "price": 29.99, "cost": 15.00, "archived": false, "inventory": [ { "shopID": 1, "quantity": 100 } ] } } ``` ``` -------------------------------- ### GET All tax categories Source: https://developers.lightspeedhq.com/retail/endpoints/TaxCategory Retrieve a list of all tax categories configured for your account. This is useful for getting an overview of all sales tax rules. ```APIDOC ## GET All tax categories ### Description Retrieve a list of all tax categories ### Method GET ### Endpoint /API/V3/Account/{accountID}/TaxCategory.json ### Request Example ```bash curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/TaxCategory.json" ``` ### Response Example ```json { "@attributes": { "next": "", "previous": "" }, "TaxCategory": [ { "taxCategoryID": "1", "isTaxInclusive": "false", "tax1Name": "Sales Tax", "tax2Name": "", "tax1Rate": "0.05", "tax2Rate": "0.099475", "timeStamp": "2021-04-07T13:52:16+00:00" }, {"..."} ] } ``` ``` -------------------------------- ### POST Create Shop Source: https://developers.lightspeedhq.com/retail/endpoints/Shop Create a new shop with the provided parameters. ```APIDOC ## POST /API/V3/Account/{accountID}/Shop.json ### Description Create a shop based on given parameters. ### Method POST ### Endpoint /API/V3/Account/{accountID}/Shop.json ### Parameters #### Path Parameters - **accountID** (string) - Required - The ID of the account. #### Request Body - **name** (string) - Required - The name of the store. - **serviceRate** (float) - Optional - The hourly service rate for the shop, if any. - **timeZone** (string) - Optional - The timezone for the shop. - **taxLabor** (boolean) - Optional - Whether this service/labor has sales tax. - **labelTitle** (enum) - Optional - What the title of product labels should be. Possible values: No Title, Shop Name, Website, Phone, Custom. - **labelMsrp** (boolean) - Optional - Whether the label should include the MSRP for items it’s filled in for when it’s more than the shop’s price. - **contactID** (integer) - Optional - The foreign key for the phone number address etc for the shop. - **taxCategoryID** (integer) - Optional - The foreign key for the default sales tax category for the shop to use on sales. - **receiptSetupID** (integer) - Optional - The foreign key for the receipt setup, text at the top and bottom of the receipt etc. - **ccGatewayID** (integer) - Optional - The foreign key for the credit card gateway setup for this shop. - **priceLevelID** (integer) - Optional - The foreign key for default price level for this shop. ### Request Example ```json { "name": "2nd Location" } ``` ### Response #### Success Response (200) - **@attributes** (object) - Contains attributes like count. - **Shop** (object) - The created shop object. - **shopID** (string) - The unique ID of the shop. - **name** (string) - The name of the shop. - **serviceRate** (string) - The service rate for the shop. - **timeZone** (string) - The timezone of the shop. - **taxLabor** (string) - Indicates if tax is applied to labor. - **labelTitle** (string) - The title for labels. - **labelMsrp** (string) - Indicates if MSRP is included on labels. - **archived** (string) - Indicates if the shop is archived. - **timeStamp** (string) - The timestamp of the last modification. - **companyRegistrationNumber** (string) - The company registration number. - **vatNumber** (string) - The VAT number. - **zebraBrowserPrint** (string) - Indicates if Zebra Browser Print is enabled. - **contactID** (string) - The ID of the associated contact. - **taxCategoryID** (string) - The ID of the tax category. - **receiptSetupID** (string) - The ID of the receipt setup. - **ccGatewayID** (string) - The ID of the credit card gateway. - **gatewayConfigID** (string) - The ID of the gateway configuration. - **priceLevelID** (string) - The ID of the price level. - **Contact** (object) - Details of the associated contact. ``` -------------------------------- ### Sample JSON Response for Vendor Returns Source: https://developers.lightspeedhq.com/retail/endpoints/VendorReturn Example structure of the JSON response when retrieving vendor returns. It includes details for each return and its associated items. ```json { "@attributes": { "next": "", "previous": "" }, "VendorReturn": [ { "vendorReturnID": "1", "vendorID": "1", "shopID": "1", "refNum": "", "status": "open", "archived": "false", "shipCost": "0", "otherCost": "0", "VendorReturnItems": "", "subtotal": "0", "total": "0", "timeStamp": "2024-10-29T15:43:18+00:00", "hideVendorDetails": "false" }, { "vendorReturnID": "2", "vendorID": "5", "shopID": "1", "refNum": "", "status": "open", "archived": "false", "shipCost": "0", "otherCost": "0", "VendorReturnItems": "", "subtotal": "0", "total": "0", "timeStamp": "2025-07-09T19:12:35+00:00", "hideVendorDetails": "false" }, { "vendorReturnID": "3", "vendorID": "2", "shopID": "1", "refNum": "4524324324324", "status": "sent", "archived": "false", "sentDate": "2025-12-18T08:00:00+00:00", "shipCost": "0", "otherCost": "0", "VendorReturnItems": { "VendorReturnItem": { "vendorReturnItemID": "1", "vendorReturnID": "3", "itemID": "262", "Item": { "itemID": "262", "systemSku": "210000000263", "defaultCost": "0", "avgCost": "0", "fifoCost": "0", "discountable": "true", "tax": "true", "archived": "false", "itemType": "default", "serialized": "false", "description": "Vendor Return Item", "modelYear": "0", "upc": "", "ean": "", "customSku": "", "manufacturerSku": "", "timeStamp": "2025-12-18T21:05:24+00:00", "createTime": "2025-12-19T01:05:18+00:00", "categoryID": "0", "taxClassID": "0", "departmentID": "0", "itemMatrixID": "0", "itemAttributesID": "0", "manufacturerID": "0", "seasonID": "0", "defaultVendorID": "0", "Prices": { "ItemPrice": [ { "amount": "200", "useType": "Default", "useTypeID": "1" }, { "amount": "215", "useType": "MSRP", "useTypeID": "2" } ] } }, "orderID": "0", "quantity": "10", "cost": "0", "subtotal": "0", "inventoryInStock": "8788", "vendorReturnItemReasonID": "2", "VendorReturnItemReason": { "vendorReturnItemReasonID": "2", "reason": "Defective", "defaultSelected": "false", "archived": "false", "createTime": "2024-09-11T16:25:06+00:00", "timeStamp": "2024-09-11T16:25:06+00:00", "isSystem": "true", "sortOrder": "2" } } }, "subtotal": "0", "total": "0", "timeStamp": "2025-12-18T21:05:46+00:00", "hideVendorDetails": "false" }, { "vendorReturnID": "4", "vendorID": "4", "shopID": "1", "refNum": "453453453534", "status": "sent", "archived": "false", "sentDate": "2025-12-18T08:00:00+00:00", "shipCost": "0", "otherCost": "0", "VendorReturnItems": { "VendorReturnItem": { "vendorReturnItemID": "2", "vendorReturnID": "4", "itemID": "263", "Item": { "itemID": "263", "systemSku": "210000000264", "defaultCost": "0", "avgCost": "0", "fifoCost": "0", "discountable": "true", "tax": "true", "archived": "false", "itemType": "default", "serialized": "false", "description": "Vendor Return Item 2", "modelYear": "0", "upc": "", "ean": "", "customSku": "", "manufacturerSku": "", "timeStamp": "2025-12-18T21:10:09+00:00", "createTime": "2025-12-19T01:10:03+00:00", "categoryID": "0", "taxClassID": "0", "departmentID": "0", "itemMatrixID": "0", "itemAttributesID": "0", "manufacturerID": "0", "seasonID": "0", "defaultVendorID": "0", "Prices": { "ItemPrice": [ { "amount": "45", ``` -------------------------------- ### GET All Tax Classes Source: https://developers.lightspeedhq.com/retail/endpoints/TaxClass Retrieve a list of all tax classes associated with the account. This endpoint is useful for getting an overview of all available tax classifications. ```APIDOC ## GET /API/V3/Account/{accountID}/TaxClass.json ### Description Retrieve a list of all tax classes in the account. ### Method GET ### Endpoint /API/V3/Account/{accountID}/TaxClass.json ### Request Example ```bash curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/TaxClass.json" ``` ### Response #### Success Response (200) - **@attributes** (object) - Contains pagination information like 'next' and 'previous' links. - **TaxClass** (array) - A list of tax class objects, each containing 'taxClassID', 'name', and 'timeStamp'. #### Response Example ```json { "@attributes": { "next": "", "previous": "" }, "TaxClass": [ { "taxClassID": "1", "name": "Item", "timeStamp": "2021-02-29T19:17:59+00:00" }, { "taxClassID": "2", "name": "Labor", "timeStamp": "2021-06-03T15:12:02+00:00" } ] } ``` ``` -------------------------------- ### Sample JSON Response for All Item Matrices Source: https://developers.lightspeedhq.com/retail/endpoints/ItemMatrix Example JSON response structure when retrieving all item matrices. It includes details like item IDs, descriptions, pricing, and attribute values. ```json { "@attributes": { "next": "", "previous": "" }, "ItemMatrix": [ { "itemMatrixID": "1", "description": "Matrix Master", "tax": "true", "defaultCost": "0", "itemType": "default", "serialized": "false", "modelYear": "0", "archived": "false", "timeStamp": "2021-03-31T17:35:47+00:00", "itemAttributeSetID": "3", "manufacturerID": "0", "categoryID": "0", "defaultVendorID": "0", "taxClassID": "1", "seasonID": "0", "departmentID": "0", "Prices": { "ItemPrice": [ { "amount": "100000", "useTypeID": "1", "useType": "Default" }, { "amount": "0", "useTypeID": "2", "useType": "MSRP" }, { "amount": "0", "useTypeID": "3", "useType": "Online" } ] }, "attribute1Values": [ "Color 1", "Color 2", "Color 3" ] }, {"..."} ] } ``` -------------------------------- ### GET Single Shipment Source: https://developers.lightspeedhq.com/retail/endpoints/ShipTo Retrieves a specific ShipTo record using its unique ID. This is useful for getting detailed information about a particular shipment. ```shell $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/ShipTo/{shipToID}.json" ``` -------------------------------- ### GET Single Register Withdraw Source: https://developers.lightspeedhq.com/retail/endpoints/RegisterWithdraw Retrieve a specific register withdraw by its unique ID. Use this to get details of a single cash transaction. ```shell $ curl -H "Authorization: Bearer {Access Token}" \ "https://api.lightspeedapp.com/API/V3/Account/{accountID}/RegisterWithdraw/{registerWithdrawID}.json" ``` -------------------------------- ### POST Create a Customer Source: https://developers.lightspeedhq.com/retail/endpoints/Customer Create a new customer with basic information like first and last name. Additional fields can be included in the request body. ```bash $ curl -X POST -H "Authorization: Bearer {Access Token}" \ -d '{ "firstName": "Junior", "lastName": "Doe", }' "https://api.lightspeedapp.com/API/V3/Account/{accountID}/Customer.json" ```