# Lightspeed Retail (X-Series) API Documentation Hub Documentation > Documentation for Lightspeed Retail (X-Series) API Documentation Hub ## Tutorials: Introduction - [Introduction to the Lightspeed Retail (X-Series) API](https://x-series-api.lightspeedhq.com/docs/introduction.md) - [Authorization](https://x-series-api.lightspeedhq.com/docs/authorization.md) - [Versioning Strategy](https://x-series-api.lightspeedhq.com/docs/versioning-strategy.md) - [OAuth Scopes](https://x-series-api.lightspeedhq.com/docs/scopes.md) - [Data Security](https://x-series-api.lightspeedhq.com/docs/data_security.md) - [User Agent](https://x-series-api.lightspeedhq.com/docs/user_agent.md) - [Rate Limiting](https://x-series-api.lightspeedhq.com/docs/rate_limiting.md) - [Pagination](https://x-series-api.lightspeedhq.com/docs/pagination.md) - [Request Format](https://x-series-api.lightspeedhq.com/docs/request_format.md) - [Dates and Times](https://x-series-api.lightspeedhq.com/docs/dates_and_times.md) - [Outbound Request Origins](https://x-series-api.lightspeedhq.com/docs/outbound_request_origins.md) ## Tutorials: Step by Step Tutorials - [Quick Start](https://x-series-api.lightspeedhq.com/docs/quick_start.md) - [How to React to Lightspeed Retail (X-Series) Events](https://x-series-api.lightspeedhq.com/docs/reacting_to_vend_events.md) - [Syncing an Entity to an External System](https://x-series-api.lightspeedhq.com/docs/sync_entity_to_external_system.md) - [Synchronizing Sales from External Systems into Lightspeed Retail (X-Series)](https://x-series-api.lightspeedhq.com/docs/sync_sale_into_vend.md) ## Tutorials: Fulfillments - [Fulfillments](https://x-series-api.lightspeedhq.com/docs/fulfillments_partial_fulfillment.md) ## Tutorials: Gift Cards - [Gift Cards](https://x-series-api.lightspeedhq.com/docs/gift_cards.md) ## Tutorials: Inventory - [Creating Inventory Counts](https://x-series-api.lightspeedhq.com/docs/inventory_creating_inventory_counts.md) - [Creating Stock Orders](https://x-series-api.lightspeedhq.com/docs/inventory_creating_stock_orders.md) - [Inventory Updates](https://x-series-api.lightspeedhq.com/docs/inventory_updates.md) ## Tutorials: Loyalty - [Loyalty 101](https://x-series-api.lightspeedhq.com/docs/loyalty_101.md) ## Tutorials: Pricebooks - [Pricebooks](https://x-series-api.lightspeedhq.com/docs/pricebooks.md) ## Tutorials: Products - [Creating Composite Products](https://x-series-api.lightspeedhq.com/docs/products_creating_composites.md) - [Updating Composite Products](https://x-series-api.lightspeedhq.com/docs/products_updating_composites.md) - [Image Upload Basics](https://x-series-api.lightspeedhq.com/docs/products_image_upload_basics.md) - [Image Upload Code Sample - Golang](https://x-series-api.lightspeedhq.com/docs/products_image_uploads_code_sample_go.md) - [Image Upload Code Sample - Java with Jersey](https://x-series-api.lightspeedhq.com/docs/products_image_uploads_code_sample_java_jersey.md) - [Image Upload Code Sample - JavaScript with Request](https://x-series-api.lightspeedhq.com/docs/products_image_uploads_code_sample_javascript_request.md) - [Image Upload Code Sample - JavaScript with Superagent](https://x-series-api.lightspeedhq.com/docs/products_image_uploads_code_sample_javascript_superagent.md) - [Image Upload Code Sample - PHP with Guzzle](https://x-series-api.lightspeedhq.com/docs/products_image_uploads_code_sample_php_guzzle.md) - [Image Upload Code Sample - Python with Requests](https://x-series-api.lightspeedhq.com/docs/products_image_uploads_code_sample_python_requests.md) - [Image Upload Code Sample - Ruby with Typhoeus](https://x-series-api.lightspeedhq.com/docs/products_image_uploads_code_sample_ruby_typhoeus.md) - [Variants](https://x-series-api.lightspeedhq.com/docs/products_variants.md) - [Creating Variants](https://x-series-api.lightspeedhq.com/docs/products_variants_creating_variants.md) - [Updating Variants](https://x-series-api.lightspeedhq.com/docs/products_variants_update.md) ## Tutorials: Promotions - [Promotions](https://x-series-api.lightspeedhq.com/docs/promotions.md) ## Tutorials: Registers - [Closing](https://x-series-api.lightspeedhq.com/docs/registers_closing.md) ## Tutorials: Sales - [Sales 101](https://x-series-api.lightspeedhq.com/docs/sales_101.md) - [Discounts](https://x-series-api.lightspeedhq.com/docs/sales_discounts.md) - [Editing Sales](https://x-series-api.lightspeedhq.com/docs/sales_editing_sales.md) - [Fulfillments](https://x-series-api.lightspeedhq.com/docs/sales_fulfillments.md) - [Returns](https://x-series-api.lightspeedhq.com/docs/sales_returns.md) - [Sales with Services](https://x-series-api.lightspeedhq.com/docs/sales_service_sales.md) - [States and attributes](https://x-series-api.lightspeedhq.com/docs/sales_states_and_attributes.md) - [Statuses](https://x-series-api.lightspeedhq.com/docs/sales_statuses.md) - [Delivery Sales with Customer Addresses](https://x-series-api.lightspeedhq.com/docs/sales_delivery_with_addresses.md) - [Migrating from v0.9 to date-based API](https://x-series-api.lightspeedhq.com/docs/sales_migration_guide.md) - [Decoding a Barcode to a Sale UUID](https://x-series-api.lightspeedhq.com/docs/sales_barcode_decode.md) ## Tutorials: Service Orders - [Introduction](https://x-series-api.lightspeedhq.com/docs/service_orders_introduction.md) ## Tutorials: Store Credit - [Store Credit](https://x-series-api.lightspeedhq.com/docs/store_credit.md) ## Tutorials: Webhooks - [Webhooks](https://x-series-api.lightspeedhq.com/docs/webhooks.md) - [Webhooks - Example Payloads](https://x-series-api.lightspeedhq.com/docs/webhooks_example_payloads.md) ## Tutorials: Workflows - [Business Rules](https://x-series-api.lightspeedhq.com/docs/workflows_business_rules.md) - [Custom Fields](https://x-series-api.lightspeedhq.com/docs/workflows_custom_fields.md) ## Tutorials: Redirect API - [Redirect API](https://x-series-api.lightspeedhq.com/docs/redirect_api.md) ## Tutorials: Client API - [Outlet Hooks](https://x-series-api.lightspeedhq.com/docs/client_api_outlet_hooks.md) - [Reference](https://x-series-api.lightspeedhq.com/docs/client_api_reference.md) - [Register Hooks](https://x-series-api.lightspeedhq.com/docs/client_api_register_hooks.md) - [Sale Hooks](https://x-series-api.lightspeedhq.com/docs/client_api_sale_hooks.md) ## Tutorials: Payments API - [Getting Started](https://x-series-api.lightspeedhq.com/docs/payments_api_getting_started.md) - [Pairing Flow](https://x-series-api.lightspeedhq.com/docs/payments_api_pairing_flow.md) - [Reference](https://x-series-api.lightspeedhq.com/docs/payments_api_reference.md) ## Tutorials: Third Party Billing - [Activating a Subscription](https://x-series-api.lightspeedhq.com/docs/third_party_billing_activating_a_subscription.md) - [Canceling a Subscription](https://x-series-api.lightspeedhq.com/docs/third_party_billing_canceling_a_subscription.md) - [Updating an Existing Subscription](https://x-series-api.lightspeedhq.com/docs/third_party_billing_updating_an_existing_subscription.md) ## Tutorials: Release notes - [2026-04](https://x-series-api.lightspeedhq.com/docs/2026-04-release-notes.md) - [2026-07](https://x-series-api.lightspeedhq.com/docs/2026-07-release-notes.md) ## API Reference: API 2026-07 - [List audit events](https://x-series-api.lightspeedhq.com/reference/getauditlogevents.md): This API returns a list of all the audit log events that match the given filters. **Note**: Not every single change in the system is audited. Currently the audited entities include: | Object |… - [List security events for current user](https://x-series-api.lightspeedhq.com/reference/get-security_events.md): This API returns a list of all the security log events **for the current user**. If you want a list of all the security events for all users please use the auditlog_events with filter type ==… - [List brands](https://x-series-api.lightspeedhq.com/reference/listbrands.md): Returns a paginated list of brands. πŸ”’ Requires: `products:read` scope - [Create brand](https://x-series-api.lightspeedhq.com/reference/createbrand.md): Creates a new brand. πŸ”’ Requires: `products:write` scope - [Delete a single brand](https://x-series-api.lightspeedhq.com/reference/deletebrandbyid.md): Deletes a brand. If there are products associated with the brand, the products will be disassociated from the brand. πŸ”’ Requires: `products:write` scope - [Get a single brand](https://x-series-api.lightspeedhq.com/reference/getbrandbyid.md): Returns a single brand with a requested ID πŸ”’ Requires: `products:read` scope - [Update a single brand](https://x-series-api.lightspeedhq.com/reference/updatebrandbyid.md): πŸ”’ Requires: `products:write` scope - [List request records](https://x-series-api.lightspeedhq.com/reference/listrequests.md): Returns a list of request log records. πŸ”’ Requires: `channels:read` scope - [Get a single request log](https://x-series-api.lightspeedhq.com/reference/getsinglerequest.md): Returns a single request log entry with a specific ID. πŸ”’ Requires: `channels:read` scope - [Get a single request log as text](https://x-series-api.lightspeedhq.com/reference/getsinglerequesttext.md): Returns a text representation of a single request log entry with a specific ID. πŸ”’ Requires: `channels:read` scope - [List channel records](https://x-series-api.lightspeedhq.com/reference/listchannels.md): Returns a list of configured channels. πŸ”’ Requires: `channels:read` scope - [Bulk update consignment products](https://x-series-api.lightspeedhq.com/reference/createorupdateconsignmentproducts.md): Add or update the products in a consignment in bulk. **Note**: Must include either count or received for each product. **Note**: It is not recommended to update more than 500 products at a time, as… - [List all products for a specific consignment](https://x-series-api.lightspeedhq.com/reference/listproductsbyconsignmentid.md): Returns a collection of consignment products associated with the specified consignment. πŸ”’ Requires: `consignments:read` scope - [Add a product to a consignment](https://x-series-api.lightspeedhq.com/reference/createconsignmentproduct.md): Add a product to the given consignment. If the type is SUPPLIER then: - Cannot add a product to a `RECEIVED` or `CANCELLED` order - Cannot add a composite product to the order - If a received value… - [Delete an item from a consignment](https://x-series-api.lightspeedhq.com/reference/deleteproductfromconsignment.md): Removes the specific product from the consignment. For `SUPPLIER` workflow: - Cannot delete a product from a consignment with a status of `DISPATCHED`, `RECEIVED` or `CANCELLED` For consignment… - [Update a product in a consignment](https://x-series-api.lightspeedhq.com/reference/updateproductinconsignment.md): Updates the specific product within the consignment. **Notes**: - If the type is SUPPLIER then: * If status is OPEN or SENT, the count value will be updated * If status is DISPATCHED, the… - [List consignments](https://x-series-api.lightspeedhq.com/reference/getconsignments.md): Return a paginated list of consignments. πŸ”’ Requires: `consignments:read` scope - [Create a consignment](https://x-series-api.lightspeedhq.com/reference/createconsignment.md): Creates a new consignment. The consignment type can be `SUPPLIER`, `OUTLET`, `STOCKTAKE` or `RETURN`. The workflows for these are: - `SUPPLIER` workflow: `OPEN` -> `SENT` -> `DISPATCHED` ->… - [Delete a consignment](https://x-series-api.lightspeedhq.com/reference/deleteconsignmentbyid.md): Deletes the consignment with the given ID. πŸ”’ Requires: One of the following scopes: - `consignments:write:stock_order` scope for `SUPPLIER` and `RETURN` consignments -… - [Get a single consignment](https://x-series-api.lightspeedhq.com/reference/getconsignmentbyid.md): Returns a single consignment with the requested ID. πŸ”’ Requires: `consignments:read` scope - [Update a consignment](https://x-series-api.lightspeedhq.com/reference/updateconsignmentbyid.md): Updates the given consignment. If the type is SUPPLIER then: - Cannot change from `SUPPLIER` to a different consignment type - `SUPPLIER` workflow: `OPEN` -> `SENT` -> `DISPATCHED` -> `RECEIVED` -… - [Get consignment totals](https://x-series-api.lightspeedhq.com/reference/listconsignmenttotals.md): Returns the count and cost for the given consignment. The consignment type can be `SUPPLIER`, `OUTLET` or `RETURN` (not `STOCKTAKE`). The status of the consignment will determine which values make… - [List all addresses for a customer](https://x-series-api.lightspeedhq.com/reference/listcustomeraddresses.md): Returns a list of all addresses associated with the specified customer. πŸ”’ Requires: `customers:read` scope - [Create a new address for a customer](https://x-series-api.lightspeedhq.com/reference/createcustomeraddress.md): Creates a new address for the specified customer. **Validation Rules:** - `country_code`: Required, must be a valid ISO 3166-1 alpha-2 code (e.g., US, NZ, AU) - `state_code`: Required for US and CA,… - [Delete an address](https://x-series-api.lightspeedhq.com/reference/deletecustomeraddress.md): Deletes an address for the specified customer. πŸ”’ Requires: `customers:write` scope - [Get a single address](https://x-series-api.lightspeedhq.com/reference/getcustomeraddress.md): Returns a single address by its ID for the specified customer. πŸ”’ Requires: `customers:read` scope - [Update an address](https://x-series-api.lightspeedhq.com/reference/updatecustomeraddress.md): Updates an existing address for the specified customer. **Validation Rules:** - `country_code`: Required, must be a valid ISO 3166-1 alpha-2 code (e.g., US, NZ, AU) - `state_code`: Required for US… - [List contact channels for a customer](https://x-series-api.lightspeedhq.com/reference/listcustomercontactchannels.md): Returns all contact channels of the specified customer, ordered by `sort_order` and then by `id`. πŸ”’ Requires: `customers:read` scope - [Create a contact channel for a customer](https://x-series-api.lightspeedhq.com/reference/createcustomercontactchannel.md): Creates a contact channel for the specified customer. A customer cannot have two channels with the same `type` and `value`. πŸ”’ Requires: `customers:write` scope - [Replace all contact channels of a customer](https://x-series-api.lightspeedhq.com/reference/setcustomercontactchannels.md): Replaces all contact channels of the specified customer with the list provided in `data`. Any existing channel that is not in `data` is deleted. Each item in `data` is matched to an existing channel… - [Set the default contact channel](https://x-series-api.lightspeedhq.com/reference/setdefaultcustomercontactchannel.md): Marks the specified contact channel as the default for its `type`. πŸ”’ Requires: `customers:write` scope - [Delete a contact channel](https://x-series-api.lightspeedhq.com/reference/deletecustomercontactchannel.md): Deletes a contact channel of the specified customer. πŸ”’ Requires: `customers:write` scope - [Get a contact channel](https://x-series-api.lightspeedhq.com/reference/getcustomercontactchannel.md): Returns a single contact channel of the specified customer. πŸ”’ Requires: `customers:read` scope - [Update a contact channel](https://x-series-api.lightspeedhq.com/reference/updatecustomercontactchannel.md): Updates a contact channel of the specified customer. The `type` of a channel that is currently the default cannot be changed. πŸ”’ Requires: `customers:write` scope - [List customer groups](https://x-series-api.lightspeedhq.com/reference/listcustomergroups.md): Return a list of Customer Groups πŸ”’ Requires: `customers:read` scope - [Create new customer group](https://x-series-api.lightspeedhq.com/reference/createcustomergroup.md): Create a new customer group πŸ”’ Requires: `customers:write` scope - [Get single customer group](https://x-series-api.lightspeedhq.com/reference/getcustomergroupbyid.md): Return given customer group πŸ”’ Requires: `customers:read` scope - [Update the given customer group](https://x-series-api.lightspeedhq.com/reference/updatecustomergroup.md): Update the given Customer Group πŸ”’ Requires: `customers:write` scope - [Delete customers from customer group](https://x-series-api.lightspeedhq.com/reference/deletecustomersfromcustomergroup.md): Deletes the given customers from the customer group. **Note**: Only the link is deleted, the customers are not. πŸ”’ Requires: `customers:write` scope - [Get customers for customer group](https://x-series-api.lightspeedhq.com/reference/getcustomergroupcustomers.md): Returns a list of customers for the given Customer Group πŸ”’ Requires: `customers:read` scope - [Add customers to customer group](https://x-series-api.lightspeedhq.com/reference/addcustomerstocustomergroup.md): Associates one or more customers with the given customer group πŸ”’ Requires: `customers:write` scope - [List customers](https://x-series-api.lightspeedhq.com/reference/listcustomers.md): Returns a paginated list of customers. To search for customers, please have a look at our [Search endpoint](/reference/search-1) on what is supported. πŸ”’ Requires: `customers:read` scope - [Create a new customer](https://x-series-api.lightspeedhq.com/reference/createcustomer.md): Creates a new customer. πŸ”’ Requires: `customers:write` scope - [Delete a customer](https://x-series-api.lightspeedhq.com/reference/deletecustomerbyid.md): Deletes the customer with the requested ID. πŸ”’ Requires: `customers:write` scope - [Get a single customer](https://x-series-api.lightspeedhq.com/reference/getcustomerbyid.md): Returns a single customer with a requested ID. πŸ”’ Requires: `customers:read` scope - [Update a customer](https://x-series-api.lightspeedhq.com/reference/updatecustomerbyid.md): Updates the customer with the requested ID. πŸ”’ Requires: `customers:write` scope - [List customer tax assignments](https://x-series-api.lightspeedhq.com/reference/listcustomertaxes.md): Returns a paginated list of customer tax assignments. πŸ”’ Requires: `customers:read` scope - [Bulk update customer tax assignments](https://x-series-api.lightspeedhq.com/reference/customertaxesbulkupdate.md): Updates tax assignments for multiple customers (up to 100) in a single request. This endpoint allows you to assign or remove tax IDs from customers in bulk operations. Set `tax_id` to `null` to… - [Get Fulfillments Summary](https://x-series-api.lightspeedhq.com/reference/getfulfillmentsummary.md): Retrieves a paginated list of fulfillment summary items with optional filtering - [Fulfill a Sale](https://x-series-api.lightspeedhq.com/reference/postfulfillsale.md): Completes all fulfillments for a given sale. This is an idempotent action. πŸ”’ Requires: `sales:write` scope - [Fulfill line items within a sale](https://x-series-api.lightspeedhq.com/reference/postfulfilllineitems.md): Fulfills line items for a given sale. Each line item may optionally include a `source_breakdown`, which specifies how a fulfillment quantity should be sourced. When provided, all three fields are… - [Get Fulfillment History](https://x-series-api.lightspeedhq.com/reference/getfulfillmenthistory.md): Retrieves the history ledger for a single fulfillment, showing all state-change events (e.g. created, picked, packed, fulfilled, voided, returned) for each line item. Results are ordered… - [Partial Pack line items within a sale](https://x-series-api.lightspeedhq.com/reference/postpacklineitems.md): Sets pack quantity for line items for a given sale. This is an idempotent action. Each line item may optionally include a `source_breakdown`, which specifies how a packing quantity should be… - [Partial Pick line items within a sale](https://x-series-api.lightspeedhq.com/reference/postpicklineitems.md): Sets pick quantity for line items for a given sale. This is an idempotent action. πŸ”’ Requires: `sales:write` scope - [List gift cards](https://x-series-api.lightspeedhq.com/reference/listgiftcards.md): Returns a paginated list of gift cards. πŸ”’ Requires: `gift_cards:read` scope - [Create gift card](https://x-series-api.lightspeedhq.com/reference/creategiftcard.md): Creates and activates a new gift card. The gift card will be created with one transaction with status "ACTIVATION" which contains the initial balance of the gift card. πŸ”’ Requires:… - [Void gift card by id](https://x-series-api.lightspeedhq.com/reference/voidgiftcardbyid.md): Voids the gift card with the given id. The gift card balance will be set to zero and its status changed to "VOIDED". πŸ”’ Requires: `gift_cards:write:issue` scope - [Find gift card by id](https://x-series-api.lightspeedhq.com/reference/findgiftcardbyid.md): Finds and returns the gift card with the given id. Returns a 404 if the card does not exist. Within the gift card structure returned is the field `gift_card_transactions` which contains a list of… - [Void gift card by number](https://x-series-api.lightspeedhq.com/reference/voidgiftcardbynumber.md): Voids the gift card with the given card number. The gift card balance will be set to zero and its status changed to "VOIDED". πŸ”’ Requires: `gift_cards:write:issue` scope - [Find gift card by number](https://x-series-api.lightspeedhq.com/reference/findgiftcardbynumber.md): Finds and returns the gift card with the given card number. Returns a 404 if the card does not exist. Within the gift card structure returned is the field `gift_card_transactions` which contains a… - [Reverse gift card transaction](https://x-series-api.lightspeedhq.com/reference/reversegiftcardtransaction.md): Reverses the given transaction on the gift card. If the reversal is successful, a new transaction will be added to the gift card transactions with the status "REVERSING". Only transactions of type… - [Find gift card by transaction id](https://x-series-api.lightspeedhq.com/reference/findgiftcardbytransactionid.md): Finds and returns the gift card associated with the given transaction id. Returns a 404 if the gift card with the given transaction id was not found. Supports an optional `system_id` query parameter… - [Create a gift card transaction](https://x-series-api.lightspeedhq.com/reference/creategiftcardtransaction.md): Creates a new gift card transaction on the specified gift card. The request body requires the `type`, `amount`, and `client_id` fields. The `type` determines what sort of transaction it is. *… - [Void gift card](https://x-series-api.lightspeedhq.com/reference/voidgiftcard.md): ** DEPRECATED ** Please use `DELETE /gift_cards/by_number/{card_number}` instead. Void the given gift card. πŸ”’ Requires: `gift_cards:write:issue` scope - [List custom inventory adjustment reasons](https://x-series-api.lightspeedhq.com/reference/listcustominventoryadjustmentreasons.md): Returns a paginated list of custom inventory adjustment reasons for the authenticated retailer. πŸ”’ Requires: `inventory:write` scope - [Create a custom inventory adjustment reason](https://x-series-api.lightspeedhq.com/reference/createcustominventoryadjustmentreason.md): Creates a new custom inventory adjustment reason for the authenticated retailer. πŸ”’ Requires: `inventory:write` scope - [Update a custom inventory adjustment reason](https://x-series-api.lightspeedhq.com/reference/updatecustominventoryadjustmentreason.md): Updates a custom inventory adjustment reason. πŸ”’ Requires: `inventory:write` scope - [List inventory records](https://x-series-api.lightspeedhq.com/reference/listinventoryrecords.md): Returns a paginated list of inventory records. πŸ”’ Requires: `inventory:read` scope - [Set reorder points](https://x-series-api.lightspeedhq.com/reference/setreorderpoints.md): Sets reorder points for one or more products at specific outlets. The method must be consistent across all outlets for a product and within the same variant family. πŸ”’ Requires: `inventory:write`… - [List inventory records for a single product](https://x-series-api.lightspeedhq.com/reference/listproductinventoryrecords.md): Returns inventory records for a single product at all outlets. πŸ”’ Requires: `inventory:read` scope - [List inventory levels](https://x-series-api.lightspeedhq.com/reference/listinventorylevels.md): Returns a paginated list of inventory levels. πŸ”’ Requires: `inventory:read` scope - [List inventory levels for a single product.](https://x-series-api.lightspeedhq.com/reference/listproductinventorylevels.md): Returns a paginated list of inventory levels for a single product. πŸ”’ Requires: `inventory:read` scope - [List stock adjustments](https://x-series-api.lightspeedhq.com/reference/liststockadjustments.md): Returns a paginated list of stock adjustments for the authenticated retailer. πŸ”’ Requires: `inventory:write` scope - [Create stock adjustments](https://x-series-api.lightspeedhq.com/reference/createstockadjustments.md): Creates one or more stock adjustments in a single batch (1–1000 items per request). πŸ”’ Requires: `inventory:write` scope - [List outlet product taxes](https://x-series-api.lightspeedhq.com/reference/listoutletproducttaxes.md): Returns a paginated list of outlet-product-tax records. πŸ”’ Requires: `outlets:read` scope - [List outlets](https://x-series-api.lightspeedhq.com/reference/listoutlets.md): Returns a collection of outlets. πŸ”’ Requires: `outlets:read` scope - [Get a single outlet](https://x-series-api.lightspeedhq.com/reference/getoutletbyid.md): Returns a single outlet with the requested ID. πŸ”’ Requires: `outlets:read` scope - [Render Packing Slip](https://x-series-api.lightspeedhq.com/reference/getpackingslip.md): Renders a packing slip for a fulfillment as an HTML document (which can be printed or converted to PDF). A packing slip lists the items to be packed and shipped for a fulfillment, along with the… - [Render Partial Packing Slip](https://x-series-api.lightspeedhq.com/reference/getpartialpackingslip.md): Renders a partial packing slip for a fulfillment as an HTML document (which can be printed or converted to PDF). Note: although the path parameter is named `fulfillment_id`, this value is the… - [List partner subscriptions](https://x-series-api.lightspeedhq.com/reference/partnersubscriptions.md): Returns list of partner's subscriptions of the retailer πŸ”’ Requires: `billing:partner_subscription:read` scope - [Get a partner subscription](https://x-series-api.lightspeedhq.com/reference/partnersubscription.md): Returns a specific partner subscription of the retailer πŸ”’ Requires: `billing:partner_subscription:read` scope - [Create a partner subscription token](https://x-series-api.lightspeedhq.com/reference/partnertoken.md): Creates a partner subscription token (called by partner using retailer's access token) πŸ”’ Requires: `billing:partner_subscription:write` scope - [Get subscription by token](https://x-series-api.lightspeedhq.com/reference/partnertokenget.md): Returns a subscription token data πŸ”’ Requires: `billing:partner_subscription:read` scope - [Create a partner update subscription token](https://x-series-api.lightspeedhq.com/reference/partnerupdatesubscriptiontoken.md): Creates a partner subscription token with the intention of updating a subscription (called by partner using retailer's access token) πŸ”’ Requires: `billing:partner_subscription:write` scope - [List payment types](https://x-series-api.lightspeedhq.com/reference/listpaymenttypes.md): Returns a paginated collection of payment types. πŸ”’ Requires: `payment_types:read` scope - [List price book products](https://x-series-api.lightspeedhq.com/reference/listpricebookproducts.md): Returns a paginated list of price book products. πŸ”’ Requires: `products:read:price_books` scope - [List price books](https://x-series-api.lightspeedhq.com/reference/listpricebooksv3.md): Returns a paginated list of price books. πŸ”’ Requires: `products:read:price_books` `customers:read` `outlets:read` scopes - [Create a single price book](https://x-series-api.lightspeedhq.com/reference/createpricebookv3.md): Create a price book πŸ”’ Requires: `products:write:price_books` `customers:read` scopes - [Get a single price book](https://x-series-api.lightspeedhq.com/reference/getpricebookbyidv3.md): Returns a single price book with a requested ID πŸ”’ Requires: `products:read:price_books` `customers:read` `outlets:read` scopes - [Update a single price book](https://x-series-api.lightspeedhq.com/reference/updatepricebookv3.md): Update a price book by ID πŸ”’ Requires: `products:write:price_books` `customers:read` scopes - [Delete some entries for a price book](https://x-series-api.lightspeedhq.com/reference/deletepricebookproducts.md): Delete price book product entries. > **Note**: You may not delete more than 100 price book products at a time. > **Note**: The request body params can be used within request headers. Header key… - [List price book products per price book](https://x-series-api.lightspeedhq.com/reference/getpricebookproductsforpricebook.md): Returns a list of price book products for a given price book. > **Note**: The returned retail price is the tax exclusive price of the product. πŸ”’ Requires: `products:read:price_books` scope - [Update the products in a price book](https://x-series-api.lightspeedhq.com/reference/updatepricebookproducts.md): Update price book products. > **Note**: When adding a product the retail price is the tax exclusive price of the product if your store is tax exclusive, and tax inclusive if your store is tax… - [Add the products to a price book](https://x-series-api.lightspeedhq.com/reference/addpricebookproducts.md): Create price book products. > **Note**: When adding a product the retail price is the tax exclusive price of the product if your store is tax exclusive, and tax inclusive if your store is tax… - [Update the products in a price book](https://x-series-api.lightspeedhq.com/reference/updatepricebookproductswithputop.md): Update price book products. > **Note**: When adding a product the retail price is the tax exclusive price of the product if your store is tax exclusive, and tax inclusive if your store is tax… - [List product categories](https://x-series-api.lightspeedhq.com/reference/listproductcategories.md): πŸ”’ Requires: `products:read` scope - [Delete a list of product categories](https://x-series-api.lightspeedhq.com/reference/deleteproductcategories.md): Delete a list of categories. If the category is a parent or root, the descendent categories also get deleted. Products associated to the deleted category are assigned to the parent, or if the deleted… - [Create and update a product category hierarchy](https://x-series-api.lightspeedhq.com/reference/createupdateproductcategories.md): πŸ”’ Requires: `products:write` scope - [Delete a product image](https://x-series-api.lightspeedhq.com/reference/deleteproductimagebyid.md): Deletes the product image with the requested ID. πŸ”’ Requires: `products:write` scope - [Get a single product image data](https://x-series-api.lightspeedhq.com/reference/getproductimagedatabyid.md): Returns the metadata for a single product image with a given ID. This method is useful for checking the status of an image after it was uploaded. πŸ”’ Requires: `products:read` scope - [Set image position](https://x-series-api.lightspeedhq.com/reference/setimageposition.md): Allows for changing the image position in the list πŸ”’ Requires: `products:write` scope - [List product types](https://x-series-api.lightspeedhq.com/reference/listproducttypes.md): **DEPRECATED** We recommend using the product_categories endpoint instead. Returns a paginated list of product types. πŸ”’ Requires: `products:read` scope - [Get a single product type](https://x-series-api.lightspeedhq.com/reference/getproducttypebyid.md): Returns a single product type with a given ID. πŸ”’ Requires: `products:read` scope - [List products](https://x-series-api.lightspeedhq.com/reference/listproducts.md): Returns a paginated list of products. To search for products, please have a look at our [Search endpoint](/reference/search-1) on what is supported. πŸ”’ Requires: `products:read` scope - [Create product](https://x-series-api.lightspeedhq.com/reference/createproduct.md): Creates a new product. πŸ”’ Requires: `products:write` scope - [Delete a single product](https://x-series-api.lightspeedhq.com/reference/deleteproduct.md): Deletes a single product. If a variant ID is provided, that single variant is removed. πŸ”’ Requires: `products:write` scope - [Get a single product](https://x-series-api.lightspeedhq.com/reference/getproductbyid.md): Returns a single product object with a given ID. πŸ”’ Requires: `products:read` scope - [Update a product](https://x-series-api.lightspeedhq.com/reference/updateproduct.md): Update an existing product. πŸ”’ Requires: `products:write` scope - [Upload an image](https://x-series-api.lightspeedhq.com/reference/uploadimage.md): Upload a binary file with an image to be used for a product. This request should be encoded as `multipart/form-data`. > **Please Note** If you are reading this on… - [Delete a product family](https://x-series-api.lightspeedhq.com/reference/deleteproductfamily.md): Deletes a product family. The /all suffix is provided to delete an entire variant family. πŸ”’ Requires: `products:write` scope - [Get a list of price books the given product is in](https://x-series-api.lightspeedhq.com/reference/getpricebooksforproduct.md): This endpoint returns the list of price books the given product is in. πŸ”’ Requires: `products:read:price_books` scope - [Apply discounts to a sale object](https://x-series-api.lightspeedhq.com/reference/applydiscount.md): This will find the best possible promotion to a sale, apply it and return the sale and the discount. * Despite its `POST` method, this endpoint does not modify any server-side state. * It is the… - [List promotions](https://x-series-api.lightspeedhq.com/reference/listpromotions.md): This endpoint lists all promotions for a retailer. There are optional query parameters that allow filtering promotions. They can't be combined: - `end_time_from` - only show promotions that have… - [Create a promotion](https://x-series-api.lightspeedhq.com/reference/createpromotion.md): This endpoint creates a new promotion. It responds with the newly-created promotion, including the promotion's ID. πŸ”’ Requires: `promotions:write` scope - [Search promotions](https://x-series-api.lightspeedhq.com/reference/searchpromotions.md): This endpoint can be used to find promotions matching specific criteria. πŸ”’ Requires: `promotions:read` scope - [Get a promotion by ID](https://x-series-api.lightspeedhq.com/reference/getpromotionbyid.md): This will retrieve a single promotion using the given ID. πŸ”’ Requires: `promotions:read` scope - [Update a promotion](https://x-series-api.lightspeedhq.com/reference/updatepromotion.md): This endpoint updates an existing promotion by ID. * All of a promotion's fields except its id may be updated. * There are no partial updates. * All fields must be specified in the update. * The… - [Get products for a promotion](https://x-series-api.lightspeedhq.com/reference/getpromotionproducts.md): Get a list of products applicable for this promotion, and their discount price. It takes in `page_size`, `offset` and `name` (use for searching product by product name) as query parameters. The… - [Get the promo codes for a promotion](https://x-series-api.lightspeedhq.com/reference/getpromotionpromocodes.md): Get the promo codes associated with this promotion. πŸ”’ Requires: `promotions:read` scope - [List purchase orders](https://x-series-api.lightspeedhq.com/reference/listpurchaseorders.md): Returns a paginated list of purchase orders using version-based cursor pagination. The response includes only purchase orders accessible to the authenticated user. Costs and discounts are included… - [Get purchase order by ID](https://x-series-api.lightspeedhq.com/reference/getpurchaseorderbyid.md): Returns a single purchase order with the requested ID. Cost fields require the `products:read:costs` scope. πŸ”’ Requires: `consignments:read` scope - [List purchase order deliveries](https://x-series-api.lightspeedhq.com/reference/listpurchaseorderdeliveries.md): Returns a paginated list of deliveries belonging to a purchase order using version-based cursor pagination. Cost fields require the `products:read:costs` scope. πŸ”’ Requires: `consignments:read` scope - [List purchase order delivery line items](https://x-series-api.lightspeedhq.com/reference/listpurchaseorderdeliverylineitems.md): Returns a paginated list of line items belonging to a purchase order delivery using version-based cursor pagination. Cost fields require the `products:read:costs` scope. πŸ”’ Requires:… - [List purchase order line items](https://x-series-api.lightspeedhq.com/reference/listpurchaseorderlineitems.md): Returns a paginated list of line items belonging to a purchase order using version-based cursor pagination. Cost fields require the `products:read:costs` scope. πŸ”’ Requires: `consignments:read` scope - [List Quotes](https://x-series-api.lightspeedhq.com/reference/get-quotes.md): Returns a paginated list of quotes. πŸ”’ Requires: `sales:read` scope - [Get Quote](https://x-series-api.lightspeedhq.com/reference/get-quote-quote_id.md): Returns a single quote with a given ID. πŸ”’ Requires: `sales:read` scope - [List button layouts](https://x-series-api.lightspeedhq.com/reference/listbuttonlayouts.md): Returns a versioned collection of button layouts for the authenticated retailer. Button layouts define the arrangement of quick key buttons on a register. πŸ”’ Requires: `registers:read` scope - [Get a single button layout](https://x-series-api.lightspeedhq.com/reference/getbuttonlayoutbyid.md): Returns a single button layout by id. Button layouts define the arrangement of quick key buttons on a register. πŸ”’ Requires: `registers:read` scope - [List registers](https://x-series-api.lightspeedhq.com/reference/listregisters.md): Returns a paginated list of registers. πŸ”’ Requires: `registers:read` scope - [Get a single register](https://x-series-api.lightspeedhq.com/reference/getregisterbyid.md): Returns a single register with the requested ID. πŸ”’ Requires: `registers:read` scope - [Close a single register](https://x-series-api.lightspeedhq.com/reference/closeregister.md): Closes a single register with the requested ID. πŸ”’ Requires: `register:close` `payment_types:read` scopes - [Open a single register](https://x-series-api.lightspeedhq.com/reference/openregister.md): Opens a single register with the requested ID. πŸ”’ Requires: `register:open` scope - [Get all the payments data associated with a single register.](https://x-series-api.lightspeedhq.com/reference/registerpaymentssummary.md): Returns a payload containing payment totals for all payments types defined in the account for a single register. πŸ”’ Requires: `payments:read` scope - [Get information about this retailer](https://x-series-api.lightspeedhq.com/reference/getretailer.md): This endpoint returns information about the retailer. πŸ”’ Requires: `retailer:read` `payment_types:read` scopes - [List Sales](https://x-series-api.lightspeedhq.com/reference/listsales.md): Returns a paginated list of sales. To search for sales, please have a look at our [Search endpoint](/reference/search-1) on what is supported. πŸ”’ Requires: `sales:read` scope - [Create a sale](https://x-series-api.lightspeedhq.com/reference/createsale.md): Create a sale. Returns the ID of the created sale. See [Sales 101](/docs/sales_101) for usage information. Migrating from `v0.9`? See the [migration guide](/docs/sales_migration_guide). πŸ”’ Requires:… - [Get a single sale](https://x-series-api.lightspeedhq.com/reference/getsalebyid.md): Returns a single sale with a given ID. πŸ”’ Requires: `sales:read` scope - [Update a sale](https://x-series-api.lightspeedhq.com/reference/updatesale.md): Update an existing sale by ID. πŸ”’ Requires: `sales:write` scope - [Return a sale](https://x-series-api.lightspeedhq.com/reference/initreturnsale.md): Initializes a return for an existing closed sale and returns the newly created SAVED return sale. Use this endpoint to start the return workflow before adding refund payments or finalizing the… - [Search for resources](https://x-series-api.lightspeedhq.com/reference/search-1.md): This endpoint allows integrators to search all of the most commonly used resources, **sales**, **products** and **customers**. Each type allowing search by a number of different parameters. ###… - [List serial numbers](https://x-series-api.lightspeedhq.com/reference/get-serialnumbers.md): Returns a paginated list of serial numbers. πŸ”’ Requires: `serial_numbers:read` scope - [Create a serial number](https://x-series-api.lightspeedhq.com/reference/create-serialnumber.md): Creates a serial number. πŸ”’ Requires: `serial_numbers:write` scope - [Delete a serial number](https://x-series-api.lightspeedhq.com/reference/delete-serialnumber.md): Deletes a serial number. πŸ”’ Requires: `serial_numbers:write` scope - [Get a single serial number](https://x-series-api.lightspeedhq.com/reference/get-serialnumber.md): Returns a single serial number. πŸ”’ Requires: `serial_numbers:read` scope - [List a customer's service items](https://x-series-api.lightspeedhq.com/reference/listserviceitems.md): Returns a paginated list of customer's service items. πŸ”’ Requires: `services:read` scope - [List service statuses](https://x-series-api.lightspeedhq.com/reference/listservicestatuses.md): Returns all service statuses for the retailer, including system defaults and custom ones. **Only available with the Service Orders module enabled.** πŸ”’ Requires: `services:read` scope - [Create a service status](https://x-series-api.lightspeedhq.com/reference/createservicestatus.md): Creates a new custom service status for the retailer. The new status is appended at the end of the display order. Use the PATCH endpoint to change its position after creation. **Only available with… - [Delete a service status](https://x-series-api.lightspeedhq.com/reference/deleteservicestatus.md): Deletes a custom service status. System default statuses cannot be deleted. A status cannot be deleted if it is still assigned to one or more service orders. **Only available with the Service… - [Get a service status](https://x-series-api.lightspeedhq.com/reference/getservicestatus.md): Returns a single service status by ID. **Only available with the Service Orders module enabled.** πŸ”’ Requires: `services:read` scope - [Update a service status](https://x-series-api.lightspeedhq.com/reference/updateservicestatus.md): Partially updates a custom service status. Only provided fields are updated. System default statuses cannot be modified. **Only available with the Service Orders module enabled.** πŸ”’ Requires:… - [List services](https://x-series-api.lightspeedhq.com/reference/listservices.md): Returns a paginated list of services. πŸ”’ Requires: `services:read` scope - [Create a service order](https://x-series-api.lightspeedhq.com/reference/createservice.md): **Only available with the Service Orders module enabled.** Creates a new service order. This endpoint allows you to create service orders with a customer, a service item, note and location. πŸ”’β€¦ - [Get service](https://x-series-api.lightspeedhq.com/reference/getservice.md): Get a single service order. πŸ”’ Requires: `services:read` scope - [Get services agenda by outlet](https://x-series-api.lightspeedhq.com/reference/get-agenda-outlet_id.md): Returns the service agenda for the specified outlet within the given time window. πŸ”’ Requires: `services:read` scope - [Get store credit usage for the store](https://x-series-api.lightspeedhq.com/reference/liststorecredit.md): Returns all the store credit customers in a store with their store credit balance and a list of last store credit transactions for each customer πŸ”’ Requires: `store_credits:read` scope - [Bulk Store Credit customers](https://x-series-api.lightspeedhq.com/reference/bulkstorecreditlist.md): Returns all the store credit customers in a store with their store credit balance and a list of last store credit transactions for each customer πŸ”’ Requires: `store_credits:read` scope - [Store credit report](https://x-series-api.lightspeedhq.com/reference/storecreditreport.md): Returns a report of store credits. πŸ”’ Requires: `store_credits:read` scope - [Store Credit operations and a balance of a customer](https://x-series-api.lightspeedhq.com/reference/liststorecreditforcustomer.md): Returns a balance and a history of store credit operations for the given customer id. πŸ”’ Requires: `store_credits:read` scope - [Create a store credit transaction](https://x-series-api.lightspeedhq.com/reference/createstorecredittransaction.md): Creates a new store credit transaction. The type determines what sort of transaction it is. * "REDEMPTION" - Use this type when you want to redeem a certain amount from the store credit balance. The… - [Bulk Store Credit customers balances](https://x-series-api.lightspeedhq.com/reference/bulkbalancesstorecreditlist.md): Returns all the store credit customers in a store with their store credit balance. πŸ”’ Requires: `store_credits:read` scope - [Store Credit balance of a customer](https://x-series-api.lightspeedhq.com/reference/storecreditbalanceforcustomer.md): Returns a balance for the given customer id. πŸ”’ Requires: `store_credits:read` scope - [Create a store credit HOLD transaction](https://x-series-api.lightspeedhq.com/reference/createstorecredithold.md): Creates a transaction that represents temporary store credit redemption meaning, that store credit points are spent on a Sale somewhere outside of X-Series. When that sale will be imported, X-Series… - [Reverse a store credit HOLD transaction](https://x-series-api.lightspeedhq.com/reference/reversestorecredithold.md): Creates a transaction reverting a HOLD operation. Might be used when: - a customer decided not to use store credit for their sale/order - a customer discarded/forgot/lost their sale/order - a… - [List suppliers](https://x-series-api.lightspeedhq.com/reference/listsuppliers.md): Returns a paginated list of suppliers. πŸ”’ Requires: `suppliers:read` scope - [Create new supplier](https://x-series-api.lightspeedhq.com/reference/createsupplier.md): Creates a new supplier. πŸ”’ Requires: `suppliers:write` scope - [Delete a single supplier](https://x-series-api.lightspeedhq.com/reference/deletesupplierbyid.md): Deletes a supplier. If there are products associated with the supplier, the products will be disassociated from the supplier. πŸ”’ Requires: `suppliers:write` scope - [Get a single supplier](https://x-series-api.lightspeedhq.com/reference/getsupplierbyid.md): Returns a single supplier with a given ID. πŸ”’ Requires: `suppliers:read` scope - [Update a supplier](https://x-series-api.lightspeedhq.com/reference/updatesupplierbyid.md): Updates a supplier. πŸ”’ Requires: `suppliers:write` scope - [List tags](https://x-series-api.lightspeedhq.com/reference/listtags.md): Returns a collection of tags. πŸ”’ Requires: `products:read` scope - [Create tag](https://x-series-api.lightspeedhq.com/reference/createtag.md): Creates a new tag. πŸ”’ Requires: `products:write` scope - [Delete a single tag](https://x-series-api.lightspeedhq.com/reference/deletetagbyid.md): Deletes a tag. If there are products associated with the tag, the products will be disassociated from the tag. πŸ”’ Requires: `products:write` scope - [Get a single tag](https://x-series-api.lightspeedhq.com/reference/gettagbyid.md): Returns a single tag with a given ID. πŸ”’ Requires: `products:read` scope - [Update a single tag](https://x-series-api.lightspeedhq.com/reference/updatetagbyid.md): Updates a tag. πŸ”’ Requires: `products:write` scope - [List taxes](https://x-series-api.lightspeedhq.com/reference/listtaxes.md): Returns a paginated list of taxes. πŸ”’ Requires: `taxes:read` scope - [Create tax](https://x-series-api.lightspeedhq.com/reference/createtax.md): Creates a new tax. πŸ”’ Requires: `taxes:write` scope - [Get a single tax](https://x-series-api.lightspeedhq.com/reference/gettaxbyid.md): Returns a single tax with a given ID. πŸ”’ Requires: `taxes:read` scope - [Get current user](https://x-series-api.lightspeedhq.com/reference/getuser.md): Returns the current user. πŸ”’ Requires: `users:read` scope - [List users](https://x-series-api.lightspeedhq.com/reference/listusers.md): Returns a paginated list of users. πŸ”’ Requires: `users:read` scope - [Get multiple users by id](https://x-series-api.lightspeedhq.com/reference/getusersbyid.md): Get multiple users by id. πŸ”’ Requires: `users:read` scope - [Delete a single user](https://x-series-api.lightspeedhq.com/reference/deleteuserbyid.md): Returns the user that has been deleted. - [Get a single user](https://x-series-api.lightspeedhq.com/reference/getuserbyid.md): Returns a single user with the requested ID. πŸ”’ Requires: `users:read` scope - [Get the sales totals for a single user](https://x-series-api.lightspeedhq.com/reference/getsalestotalsforuserbyid.md): Returns a single user's sales totals. - [Delete user sessions](https://x-series-api.lightspeedhq.com/reference/deletesessionsbyuserid.md): Deletes all sessions and personal tokens of the given user. πŸ”’ Requires: `users:write` scope - [List webhooks](https://x-series-api.lightspeedhq.com/reference/get-webhooks.md): List all webhooks. πŸ”’ Requires: `webhooks` scope - [Create Webhook](https://x-series-api.lightspeedhq.com/reference/post-webhooks.md): Create a webhook. πŸ”’ Requires: `webhooks` scope - [Delete Webhook](https://x-series-api.lightspeedhq.com/reference/delete-webhooks-webhookid.md): Delete a webhook πŸ”’ Requires: `webhooks` scope - [Get Webhook](https://x-series-api.lightspeedhq.com/reference/get-webhooks-id.md): Fetch a single webhook by its ID. πŸ”’ Requires: `webhooks` scope - [Update Webhook](https://x-series-api.lightspeedhq.com/reference/put-webhooks-id.md): Update an existing webhook πŸ”’ Requires: `webhooks` scope - [List custom field definitions](https://x-series-api.lightspeedhq.com/reference/getcustomfields.md): Returns the custom field definitions for a given entity type. πŸ”’ Requires: `custom_fields:read` scope - [Define a new custom field](https://x-series-api.lightspeedhq.com/reference/createcustomfield.md): Create a new custom field definition for a given entity type. πŸ”’ Requires: `custom_fields:write` scope - [List custom field values](https://x-series-api.lightspeedhq.com/reference/getcustomfieldvalues.md): Returns the custom field values for a given entity. πŸ”’ Requires: `custom_fields:read` scope - [Set new custom field values](https://x-series-api.lightspeedhq.com/reference/setcustomfieldvalues.md): Set new custom field values on a given entity. πŸ”’ Requires: `custom_fields:write` scope - [Delete a custom field](https://x-series-api.lightspeedhq.com/reference/delete-custom-field.md): Delete a custom field and all the values stored on that field. πŸ”’ Requires: `custom_fields:write` scope - [Update a custom field](https://x-series-api.lightspeedhq.com/reference/update-custom-field.md): Updates properties on a custom field. πŸ”’ Requires: `custom_fields:write` scope - [List remote rules](https://x-series-api.lightspeedhq.com/reference/get-remote-rules.md): Returns the remote business rules registered on the retailer. πŸ”’ Requires: `remote_rules:read` scope - [Create remote rule](https://x-series-api.lightspeedhq.com/reference/create-remote-rule.md): Register a new remote rule for the retailer. πŸ”’ Requires: `remote_rules:write` scope - [Delete a remote rule](https://x-series-api.lightspeedhq.com/reference/delete-remote-rule.md): Delete a remote business rule. πŸ”’ Requires: `remote_rules:write` scope - [List rules](https://x-series-api.lightspeedhq.com/reference/get-rules.md): Returns the business rules for the retailer. πŸ”’ Requires: `business_rules:read` scope - [Create rule](https://x-series-api.lightspeedhq.com/reference/create-rule.md): Create a rule for the retailer. πŸ”’ Requires: `business_rules:write` scope - [Delete a business rule](https://x-series-api.lightspeedhq.com/reference/delete-rule.md): Delete a business rule. πŸ”’ Requires: `business_rules:write` scope - [Perform a Loyalty Adjustment bulk operation](https://x-series-api.lightspeedhq.com/reference/post_loyalty-adjustments-bulk.md): Performs an operation which updates loyalty balance for multiple customers Requires the `loyalty.transaction.write` permission. - [Delete promo codes](https://x-series-api.lightspeedhq.com/reference/deletepromocodesbulk.md): Delete promo codes, by promocode IDs πŸ”’ Requires: `promotions:write` scope - [Get the active status of promo codes](https://x-series-api.lightspeedhq.com/reference/getactivepromocodesbulk.md): Get promo codes, with their associated promotions. πŸ”’ Requires: `promotions:read` scope - [List shifts](https://x-series-api.lightspeedhq.com/reference/listshifts.md): Returns a paginated list of shifts. - [Retrieve all Variant Attributes](https://x-series-api.lightspeedhq.com/reference/listvariantattributes.md): Retrieve all Variant Attributes. πŸ”’ Requires: `products:read` scope - [Create a Variant Attribute](https://x-series-api.lightspeedhq.com/reference/createvariantattribute.md): Variant Attributes are required when creating variants. They are used to specify what properties make a particular SKU different to another. e.g. You may have an attribute 'Size' that lets you… - [Delete a variant attribute](https://x-series-api.lightspeedhq.com/reference/deletevariantattribute.md): Note you can't delete a variant attribute that is currently being used by a family. πŸ”’ Requires: `products:write` scope - [Retrieve a single Variant Attribute](https://x-series-api.lightspeedhq.com/reference/getvariantattributes.md): Retrieves a single Variant Attribute with the given id. πŸ”’ Requires: `products:read` scope - [Update a Variant Attribute's](https://x-series-api.lightspeedhq.com/reference/updatevariantattribute.md): Updates a Variant Attribute's name. πŸ”’ Requires: `products:write` scope ## Changelog - [2026-04 Purchase Order Read API](https://x-series-api.lightspeedhq.com/changelog/2026-04-purchase-order-read-api.md) - [2026-07 Voiding of other parked returns](https://x-series-api.lightspeedhq.com/changelog/2026-07-void-other-parked-returns.md) - [2026-07 Prevent mixing of referenced and unreferenced returns](https://x-series-api.lightspeedhq.com/changelog/2026-07-prevent-mixing-of-referenced-and-unreferenced-returns.md) - [2026-07 Strict Postal Code Validation (40 Countries)](https://x-series-api.lightspeedhq.com/changelog/2026-07-extended-postal-code-validation.md) - [2026-01 Return Sale Endpoint Method Update](https://x-series-api.lightspeedhq.com/changelog/2026-06-return-sale-post-date-versioned-apis.md) - [2026-05 New Sales Search Filters and Sorting](https://x-series-api.lightspeedhq.com/changelog/2026-05-new-sales-search-filters.md) - [2026-04 Inventory Levels Reorder Method](https://x-series-api.lightspeedhq.com/changelog/2026-05-inventory-levels-reorder-method.md) - [2026-04 Deprecation of Sale Fulfillment Endpoints](https://x-series-api.lightspeedhq.com/changelog/2026-05-deprecate-sale-fulfillment-endpoints.md) - [2026-01 Adjustment APIs](https://x-series-api.lightspeedhq.com/changelog/2026-05-adjustment-apis-2026-01.md) - [2026-04 Reorder Points Support](https://x-series-api.lightspeedhq.com/changelog/2026-05-reorder-points-2026-04.md)