# OpenAPIClient-php

Lightspeed Retail (X-Series) API.

For more information, please visit [https://developers.retail.lightspeed.app](https://developers.retail.lightspeed.app).

## Installation & Usage

### Requirements

PHP 8.1 and later.

### Composer

To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:

```json
{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/talisman/vend2.0.git"
    }
  ],
  "require": {
    "talisman/vend2.0": "*@dev"
  }
}
```

Then run `composer install`

### Manual Installation

Download the files and include `autoload.php`:

```php
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: bearerAuth
$config = Vend202601\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Vend202601\Api\AuditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_size = 'page_size_example'; // string | The size for a single page of results. By default 100 events will be returned.
$offset = 'offset_example'; // string | The number of objects to skip.
$from = 'from_example'; // string | The lower limit for the `occurred_at` attribute. to be included in the response. The date and time from needs to be in isoformat.
$to = 'to_example'; // string | The upper limit for the `occurred_at` attribute. to be included in the response. The date and time from needs to be in isoformat.
$order = 'order_example'; // string | The sorting order for the results. Sorting is done by the `occurred_at` parameter. The default order is descending.
$user_id = 'user_id_example'; // string | The `id` of the user to filter the events by.
$type = 'type_example'; // string | The `type` of the events to be filtered for the response.

try {
    $apiInstance->getAuditLogEvents($page_size, $offset, $from, $to, $order, $user_id, $type);
} catch (Exception $e) {
    echo 'Exception when calling AuditApi->getAuditLogEvents: ', $e->getMessage(), PHP_EOL;
}

```

## API Endpoints

All URIs are relative to *https://example.retail.lightspeed.app/api/2026-01*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuditApi* | [**getAuditLogEvents**](docs/Api/AuditApi.md#getauditlogevents) | **GET** /auditlog_events | List audit events
*AuditApi* | [**getSecurityEvents**](docs/Api/AuditApi.md#getsecurityevents) | **GET** /security_events | List security events for current user
*BrandsApi* | [**createBrand**](docs/Api/BrandsApi.md#createbrand) | **POST** /brands | Create brand
*BrandsApi* | [**deleteBrandByID**](docs/Api/BrandsApi.md#deletebrandbyid) | **DELETE** /brands/{brand_id} | Delete a single brand
*BrandsApi* | [**getBrandByID**](docs/Api/BrandsApi.md#getbrandbyid) | **GET** /brands/{brand_id} | Get a single brand
*BrandsApi* | [**listBrands**](docs/Api/BrandsApi.md#listbrands) | **GET** /brands | List brands
*BrandsApi* | [**updateBrandById**](docs/Api/BrandsApi.md#updatebrandbyid) | **PUT** /brands/{brand_id} | Update a single brand
*ChannelRequestLogApi* | [**getSingleRequest**](docs/Api/ChannelRequestLogApi.md#getsinglerequest) | **GET** /channel_requests/{request_log_id} | Get a single request log
*ChannelRequestLogApi* | [**getSingleRequestText**](docs/Api/ChannelRequestLogApi.md#getsinglerequesttext) | **GET** /channel_requests/{request_log_id}.txt | Get a single request log as text
*ChannelRequestLogApi* | [**listChannels**](docs/Api/ChannelRequestLogApi.md#listchannels) | **GET** /channels | List channel records
*ChannelRequestLogApi* | [**listRequests**](docs/Api/ChannelRequestLogApi.md#listrequests) | **GET** /channel_requests | List request records
*ConsignmentProductsApi* | [**createConsignmentProduct**](docs/Api/ConsignmentProductsApi.md#createconsignmentproduct) | **POST** /consignments/{consignment_id}/products | Add a product to a consignment
*ConsignmentProductsApi* | [**createOrUpdateConsignmentProducts**](docs/Api/ConsignmentProductsApi.md#createorupdateconsignmentproducts) | **POST** /consignments/{consignment_id}/bulk | Bulk update consignment products
*ConsignmentProductsApi* | [**deleteProductFromConsignment**](docs/Api/ConsignmentProductsApi.md#deleteproductfromconsignment) | **DELETE** /consignments/{consignment_id}/products/{product_id} | Delete an item from a consignment
*ConsignmentProductsApi* | [**listProductsByConsignmentID**](docs/Api/ConsignmentProductsApi.md#listproductsbyconsignmentid) | **GET** /consignments/{consignment_id}/products | List all products for a specific consignment
*ConsignmentProductsApi* | [**updateProductInConsignment**](docs/Api/ConsignmentProductsApi.md#updateproductinconsignment) | **PUT** /consignments/{consignment_id}/products/{product_id} | Update a product in a consignment
*ConsignmentsApi* | [**createConsignment**](docs/Api/ConsignmentsApi.md#createconsignment) | **POST** /consignments | Create a consignment
*ConsignmentsApi* | [**deleteConsignmentByID**](docs/Api/ConsignmentsApi.md#deleteconsignmentbyid) | **DELETE** /consignments/{consignment_id} | Delete a consignment
*ConsignmentsApi* | [**getConsignmentByID**](docs/Api/ConsignmentsApi.md#getconsignmentbyid) | **GET** /consignments/{consignment_id} | Get a single consignment
*ConsignmentsApi* | [**getConsignments**](docs/Api/ConsignmentsApi.md#getconsignments) | **GET** /consignments | List consignments
*ConsignmentsApi* | [**listConsignmentTotals**](docs/Api/ConsignmentsApi.md#listconsignmenttotals) | **GET** /consignments/{consignment_id}/totals | Get consignment totals
*ConsignmentsApi* | [**updateConsignmentByID**](docs/Api/ConsignmentsApi.md#updateconsignmentbyid) | **PUT** /consignments/{consignment_id} | Update a consignment
*CustomerAddressesApi* | [**createCustomerAddress**](docs/Api/CustomerAddressesApi.md#createcustomeraddress) | **POST** /customers/{customer_id}/addresses | Create a new address for a customer
*CustomerAddressesApi* | [**deleteCustomerAddress**](docs/Api/CustomerAddressesApi.md#deletecustomeraddress) | **DELETE** /customers/{customer_id}/addresses/{address_id} | Delete an address
*CustomerAddressesApi* | [**getCustomerAddress**](docs/Api/CustomerAddressesApi.md#getcustomeraddress) | **GET** /customers/{customer_id}/addresses/{address_id} | Get a single address
*CustomerAddressesApi* | [**listCustomerAddresses**](docs/Api/CustomerAddressesApi.md#listcustomeraddresses) | **GET** /customers/{customer_id}/addresses | List all addresses for a customer
*CustomerAddressesApi* | [**updateCustomerAddress**](docs/Api/CustomerAddressesApi.md#updatecustomeraddress) | **PUT** /customers/{customer_id}/addresses/{address_id} | Update an address
*CustomerGroupsApi* | [**addCustomersToCustomerGroup**](docs/Api/CustomerGroupsApi.md#addcustomerstocustomergroup) | **POST** /customer_groups/{customer_group_id}/customers | Add customers to customer group
*CustomerGroupsApi* | [**createCustomerGroup**](docs/Api/CustomerGroupsApi.md#createcustomergroup) | **POST** /customer_groups | Create new customer group
*CustomerGroupsApi* | [**deleteCustomersFromCustomerGroup**](docs/Api/CustomerGroupsApi.md#deletecustomersfromcustomergroup) | **DELETE** /customer_groups/{customer_group_id}/customers | Delete customers from customer group
*CustomerGroupsApi* | [**getCustomerGroupById**](docs/Api/CustomerGroupsApi.md#getcustomergroupbyid) | **GET** /customer_groups/{customer_group_id} | Get single customer group
*CustomerGroupsApi* | [**getCustomerGroupCustomers**](docs/Api/CustomerGroupsApi.md#getcustomergroupcustomers) | **GET** /customer_groups/{customer_group_id}/customers | Get customers for customer group
*CustomerGroupsApi* | [**listCustomerGroups**](docs/Api/CustomerGroupsApi.md#listcustomergroups) | **GET** /customer_groups | List customer groups
*CustomerGroupsApi* | [**updateCustomerGroup**](docs/Api/CustomerGroupsApi.md#updatecustomergroup) | **PUT** /customer_groups/{customer_group_id} | Update the given customer group
*CustomersApi* | [**createCustomer**](docs/Api/CustomersApi.md#createcustomer) | **POST** /customers | Create a new customer
*CustomersApi* | [**deleteCustomerByID**](docs/Api/CustomersApi.md#deletecustomerbyid) | **DELETE** /customers/{customer_id} | Delete a customer
*CustomersApi* | [**getCustomerByID**](docs/Api/CustomersApi.md#getcustomerbyid) | **GET** /customers/{customer_id} | Get a single customer
*CustomersApi* | [**listCustomers**](docs/Api/CustomersApi.md#listcustomers) | **GET** /customers | List customers
*CustomersApi* | [**updateCustomerByID**](docs/Api/CustomersApi.md#updatecustomerbyid) | **PUT** /customers/{customer_id} | Update a customer
*FulfillmentsApi* | [**fulfillSale**](docs/Api/FulfillmentsApi.md#fulfillsale) | **POST** /sales/{sale_id}/fulfill | Fulfil a sale
*FulfillmentsApi* | [**getFulfillmentSummary**](docs/Api/FulfillmentsApi.md#getfulfillmentsummary) | **GET** /fulfillments | Get Fulfillments Summary
*FulfillmentsApi* | [**getFulfillmentsBySaleID**](docs/Api/FulfillmentsApi.md#getfulfillmentsbysaleid) | **GET** /sales/{sale_id}/fulfillments | List Sale Fulfillments
*FulfillmentsApi* | [**postFulfillLineItems**](docs/Api/FulfillmentsApi.md#postfulfilllineitems) | **POST** /fulfillments/{fulfillment_id}/fulfill | Fulfill line items within a sale
*FulfillmentsApi* | [**postFulfillSale**](docs/Api/FulfillmentsApi.md#postfulfillsale) | **POST** /fulfillments/fulfill | Fulfill a Sale
*FulfillmentsApi* | [**postPackLineItems**](docs/Api/FulfillmentsApi.md#postpacklineitems) | **POST** /fulfillments/{fulfillment_id}/pack | Partial Pack line items within a sale
*FulfillmentsApi* | [**postPickLineItems**](docs/Api/FulfillmentsApi.md#postpicklineitems) | **POST** /fulfillments/{fulfillment_id}/pick | Partial Pick line items within a sale
*GiftCardsApi* | [**createGiftCard**](docs/Api/GiftCardsApi.md#creategiftcard) | **POST** /gift_cards | Create gift card
*GiftCardsApi* | [**createGiftCardTransaction**](docs/Api/GiftCardsApi.md#creategiftcardtransaction) | **POST** /gift_cards/{number}/transactions | Create a gift card transaction
*GiftCardsApi* | [**findGiftCard**](docs/Api/GiftCardsApi.md#findgiftcard) | **GET** /gift_cards/{number} | Find gift card
*GiftCardsApi* | [**findGiftCardById**](docs/Api/GiftCardsApi.md#findgiftcardbyid) | **GET** /gift_cards/by_id/{id} | Find gift card by id
*GiftCardsApi* | [**findGiftCardByNumber**](docs/Api/GiftCardsApi.md#findgiftcardbynumber) | **GET** /gift_cards/by_number/{card_number} | Find gift card by number
*GiftCardsApi* | [**findGiftCardByTransactionId**](docs/Api/GiftCardsApi.md#findgiftcardbytransactionid) | **GET** /gift_cards/transactions/{transactionId} | Find gift card by transaction id
*GiftCardsApi* | [**listGiftCards**](docs/Api/GiftCardsApi.md#listgiftcards) | **GET** /gift_cards | List gift cards
*GiftCardsApi* | [**reverseGiftCardTransaction**](docs/Api/GiftCardsApi.md#reversegiftcardtransaction) | **DELETE** /gift_cards/transactions/{transactionId} | Reverse gift card transaction
*GiftCardsApi* | [**voidGiftCard**](docs/Api/GiftCardsApi.md#voidgiftcard) | **DELETE** /gift_cards/{number} | Void gift card
*InventoryApi* | [**listInventoryLevels**](docs/Api/InventoryApi.md#listinventorylevels) | **POST** /inventory_levels | List inventory levels
*InventoryApi* | [**listInventoryRecords**](docs/Api/InventoryApi.md#listinventoryrecords) | **GET** /inventory | List inventory records
*InventoryApi* | [**listProductInventoryLevels**](docs/Api/InventoryApi.md#listproductinventorylevels) | **GET** /inventory_levels/{product_id} | List inventory levels for a single product.
*InventoryApi* | [**listProductInventoryRecords**](docs/Api/InventoryApi.md#listproductinventoryrecords) | **GET** /inventory/{product_id} | List inventory records for a single product
*OutletProductTaxesApi* | [**listOutletProductTaxes**](docs/Api/OutletProductTaxesApi.md#listoutletproducttaxes) | **GET** /outlet_taxes | List outlet product taxes
*OutletsApi* | [**getOutletByID**](docs/Api/OutletsApi.md#getoutletbyid) | **GET** /outlets/{outlet_id} | Get a single outlet
*OutletsApi* | [**listOutlets**](docs/Api/OutletsApi.md#listoutlets) | **GET** /outlets | List outlets
*PartnerBillingApi* | [**partnerSubscription**](docs/Api/PartnerBillingApi.md#partnersubscription) | **GET** /partner/billing/subscriptions/{subscription_id} | Get a partner subscription
*PartnerBillingApi* | [**partnerSubscriptions**](docs/Api/PartnerBillingApi.md#partnersubscriptions) | **GET** /partner/billing/subscriptions | List partner subscriptions
*PartnerBillingApi* | [**partnerToken**](docs/Api/PartnerBillingApi.md#partnertoken) | **POST** /partner/billing/token | Create a partner subscription token
*PartnerBillingApi* | [**partnerTokenGet**](docs/Api/PartnerBillingApi.md#partnertokenget) | **GET** /partner/billing/token/{partner_subscription_token} | Get subscription by token
*PartnerBillingApi* | [**partnerUpdateSubscriptionToken**](docs/Api/PartnerBillingApi.md#partnerupdatesubscriptiontoken) | **POST** /partner/billing/update-subscription/token | Create a partner update subscription token
*PaymentTypesApi* | [**listPaymentTypes**](docs/Api/PaymentTypesApi.md#listpaymenttypes) | **GET** /payment_types | List payment types
*PickListsApi* | [**getPickListsBySaleID**](docs/Api/PickListsApi.md#getpicklistsbysaleid) | **GET** /sales/{sale_id}/pick_lists | List Sale Pick Lists
*PriceBooksApi* | [**addPriceBookProducts**](docs/Api/PriceBooksApi.md#addpricebookproducts) | **POST** /price_books/{price_book_id}/products | Add the products to a price book
*PriceBooksApi* | [**createPriceBookV3**](docs/Api/PriceBooksApi.md#createpricebookv3) | **POST** /price_books | Create a single price book
*PriceBooksApi* | [**deletePriceBookProducts**](docs/Api/PriceBooksApi.md#deletepricebookproducts) | **DELETE** /price_books/{price_book_id}/products | Delete some entries for a price book
*PriceBooksApi* | [**getPriceBookByIDV3**](docs/Api/PriceBooksApi.md#getpricebookbyidv3) | **GET** /price_books/{id} | Get a single price book
*PriceBooksApi* | [**getPriceBookProductsForPriceBook**](docs/Api/PriceBooksApi.md#getpricebookproductsforpricebook) | **GET** /price_books/{price_book_id}/products | List price book products per price book
*PriceBooksApi* | [**listPriceBookProducts**](docs/Api/PriceBooksApi.md#listpricebookproducts) | **GET** /price_book_products | List price book products
*PriceBooksApi* | [**listPriceBooksV3**](docs/Api/PriceBooksApi.md#listpricebooksv3) | **GET** /price_books | List price books
*PriceBooksApi* | [**updatePriceBookProducts**](docs/Api/PriceBooksApi.md#updatepricebookproducts) | **PATCH** /price_books/{price_book_id}/products | Update the products in a price book
*PriceBooksApi* | [**updatePriceBookProductsWithPutOp**](docs/Api/PriceBooksApi.md#updatepricebookproductswithputop) | **PUT** /price_books/{price_book_id}/products | Update the products in a price book
*PriceBooksApi* | [**updatePriceBookV3**](docs/Api/PriceBooksApi.md#updatepricebookv3) | **PUT** /price_books/{id} | Update a single price book
*ProductCategoriesApi* | [**createUpdateProductCategories**](docs/Api/ProductCategoriesApi.md#createupdateproductcategories) | **POST** /product_categories/bulk | Create and update a product category hierarchy
*ProductCategoriesApi* | [**deleteProductCategories**](docs/Api/ProductCategoriesApi.md#deleteproductcategories) | **DELETE** /product_categories/bulk | Delete a list of product categories
*ProductCategoriesApi* | [**listProductCategories**](docs/Api/ProductCategoriesApi.md#listproductcategories) | **GET** /product_categories | List product categories
*ProductImagesApi* | [**deleteProductImageByID**](docs/Api/ProductImagesApi.md#deleteproductimagebyid) | **DELETE** /product_images/{product_image_id} | Delete a product image
*ProductImagesApi* | [**getProductImageDataByID**](docs/Api/ProductImagesApi.md#getproductimagedatabyid) | **GET** /product_images/{product_image_id} | Get a single product image data
*ProductImagesApi* | [**setImagePosition**](docs/Api/ProductImagesApi.md#setimageposition) | **PUT** /product_images/{product_image_id} | Set image position
*ProductTypesApi* | [**getProductTypeByID**](docs/Api/ProductTypesApi.md#getproducttypebyid) | **GET** /product_types/{product_type_id} | Get a single product type
*ProductTypesApi* | [**listProductTypes**](docs/Api/ProductTypesApi.md#listproducttypes) | **GET** /product_types | List product types
*ProductsApi* | [**createProduct**](docs/Api/ProductsApi.md#createproduct) | **POST** /products | Create product
*ProductsApi* | [**deleteProduct**](docs/Api/ProductsApi.md#deleteproduct) | **DELETE** /products/{product_id} | Delete a single product
*ProductsApi* | [**deleteProductFamily**](docs/Api/ProductsApi.md#deleteproductfamily) | **DELETE** /products/{product_id}/all | Delete a product family
*ProductsApi* | [**getInventoryByProductID**](docs/Api/ProductsApi.md#getinventorybyproductid) | **GET** /products/{product_id}/inventory | Get inventory data for a single product
*ProductsApi* | [**getPriceBooksForProduct**](docs/Api/ProductsApi.md#getpricebooksforproduct) | **GET** /products/{product_id}/price_book_products | Get a list of price books the given product is in
*ProductsApi* | [**getProductByID**](docs/Api/ProductsApi.md#getproductbyid) | **GET** /products/{product_id} | Get a single product
*ProductsApi* | [**listProducts**](docs/Api/ProductsApi.md#listproducts) | **GET** /products | List products
*ProductsApi* | [**updateProduct**](docs/Api/ProductsApi.md#updateproduct) | **PUT** /products/{product_id} | Update a product
*ProductsApi* | [**uploadImage**](docs/Api/ProductsApi.md#uploadimage) | **POST** /products/{product_id}/actions/image_upload | Upload an image
*PromoCodeApi* | [**deletePromoCodesBulk**](docs/Api/PromoCodeApi.md#deletepromocodesbulk) | **DELETE** /promocode/bulk | Delete promo codes
*PromoCodeApi* | [**getActivePromoCodesBulk**](docs/Api/PromoCodeApi.md#getactivepromocodesbulk) | **POST** /promocode/bulk/active | Get the active status of promo codes
*PromotionsApi* | [**applyDiscount**](docs/Api/PromotionsApi.md#applydiscount) | **POST** /discount | Apply discounts to a sale object
*PromotionsApi* | [**createPromotion**](docs/Api/PromotionsApi.md#createpromotion) | **POST** /promotions | Create a promotion
*PromotionsApi* | [**getPromotionByID**](docs/Api/PromotionsApi.md#getpromotionbyid) | **GET** /promotions/{promotion_id} | Get a promotion by ID
*PromotionsApi* | [**getPromotionProducts**](docs/Api/PromotionsApi.md#getpromotionproducts) | **GET** /promotions/{promotion_id}/products | Get products for a promotion
*PromotionsApi* | [**getPromotionPromoCodes**](docs/Api/PromotionsApi.md#getpromotionpromocodes) | **GET** /promotions/{promotion_id}/promocodes | Get the promo codes for a promotion
*PromotionsApi* | [**listPromotions**](docs/Api/PromotionsApi.md#listpromotions) | **GET** /promotions | List promotions
*PromotionsApi* | [**searchPromotions**](docs/Api/PromotionsApi.md#searchpromotions) | **GET** /promotions/search | Search promotions
*PromotionsApi* | [**updatePromotion**](docs/Api/PromotionsApi.md#updatepromotion) | **PUT** /promotions/{promotion_id} | Update a promotion
*QuotesApi* | [**getQuoteQuoteId**](docs/Api/QuotesApi.md#getquotequoteid) | **GET** /quotes/{quote_id} | Get Quote
*QuotesApi* | [**getQuotes**](docs/Api/QuotesApi.md#getquotes) | **GET** /quotes | List Quotes
*RegistersApi* | [**closeRegister**](docs/Api/RegistersApi.md#closeregister) | **PUT** /registers/{register_id}/actions/close | Close a single register
*RegistersApi* | [**getButtonLayoutById**](docs/Api/RegistersApi.md#getbuttonlayoutbyid) | **GET** /button_layouts/{button_layout_id} | Get a single button layout
*RegistersApi* | [**getRegisterByID**](docs/Api/RegistersApi.md#getregisterbyid) | **GET** /registers/{register_id} | Get a single register
*RegistersApi* | [**listButtonLayouts**](docs/Api/RegistersApi.md#listbuttonlayouts) | **GET** /button_layouts | List button layouts
*RegistersApi* | [**listRegisters**](docs/Api/RegistersApi.md#listregisters) | **GET** /registers | List registers
*RegistersApi* | [**openRegister**](docs/Api/RegistersApi.md#openregister) | **PUT** /registers/{register_id}/actions/open | Open a single register
*RegistersApi* | [**registerPaymentsSummary**](docs/Api/RegistersApi.md#registerpaymentssummary) | **GET** /registers/{register_id}/payments_summary | Get all the payments data associated with a single register.
*RetailersApi* | [**getRetailer**](docs/Api/RetailersApi.md#getretailer) | **GET** /retailer | Get information about this retailer
*SalesApi* | [**createSale**](docs/Api/SalesApi.md#createsale) | **POST** /register_sales | Create a sale
*SalesApi* | [**getSaleByID**](docs/Api/SalesApi.md#getsalebyid) | **GET** /sales/{sale_id} | Get a single sale
*SalesApi* | [**initReturnSale**](docs/Api/SalesApi.md#initreturnsale) | **PUT** /sales/{sale_id}/actions/return | Return a sale
*SalesApi* | [**listSales**](docs/Api/SalesApi.md#listsales) | **GET** /sales | List Sales
*SalesApi* | [**updateSale**](docs/Api/SalesApi.md#updatesale) | **PUT** /register_sales | Update a sale
*SearchApi* | [**search**](docs/Api/SearchApi.md#search) | **GET** /search | Search for resources
*SerialNumbersApi* | [**createSerialnumber**](docs/Api/SerialNumbersApi.md#createserialnumber) | **POST** /serialnumbers | Create a serial number
*SerialNumbersApi* | [**deleteSerialnumber**](docs/Api/SerialNumbersApi.md#deleteserialnumber) | **DELETE** /serialnumbers/{serialnumber_id} | Delete a serial number
*SerialNumbersApi* | [**getSerialnumber**](docs/Api/SerialNumbersApi.md#getserialnumber) | **GET** /serialnumbers/{serialnumber_id} | Get a single serial number
*SerialNumbersApi* | [**getSerialnumbers**](docs/Api/SerialNumbersApi.md#getserialnumbers) | **GET** /serialnumbers | List serial numbers
*ServiceOrdersApi* | [**createService**](docs/Api/ServiceOrdersApi.md#createservice) | **POST** /services | Create a service order
*ServiceOrdersApi* | [**getAgendaOutletId**](docs/Api/ServiceOrdersApi.md#getagendaoutletid) | **GET** /services_agenda/outlet/{outlet_id} | Get services agenda by outlet
*ServiceOrdersApi* | [**getService**](docs/Api/ServiceOrdersApi.md#getservice) | **GET** /services/{service_id} | Get service
*ServiceOrdersApi* | [**listServiceItems**](docs/Api/ServiceOrdersApi.md#listserviceitems) | **GET** /service_items/customer/{customer_id} | List a customer&#39;s service items
*ServiceOrdersApi* | [**listServices**](docs/Api/ServiceOrdersApi.md#listservices) | **GET** /services | List services
*ShiftsApi* | [**listShifts**](docs/Api/ShiftsApi.md#listshifts) | **GET** /shifts | List shifts
*StoreCreditsApi* | [**bulkStoreCreditList**](docs/Api/StoreCreditsApi.md#bulkstorecreditlist) | **POST** /store_credits/bulk | Store credit bulk list
*StoreCreditsApi* | [**createStoreCreditTransaction**](docs/Api/StoreCreditsApi.md#createstorecredittransaction) | **POST** /store_credits/{customerId}/transactions | Create a store credit transaction
*StoreCreditsApi* | [**listStoreCredit**](docs/Api/StoreCreditsApi.md#liststorecredit) | **GET** /store_credits | Store credit list
*StoreCreditsApi* | [**listStoreCreditForCustomer**](docs/Api/StoreCreditsApi.md#liststorecreditforcustomer) | **GET** /store_credits/{customerId} | Store credit list for the given customer id
*StoreCreditsApi* | [**storeCreditReport**](docs/Api/StoreCreditsApi.md#storecreditreport) | **GET** /store_credits/report | Store credit report
*SuppliersApi* | [**createSupplier**](docs/Api/SuppliersApi.md#createsupplier) | **POST** /suppliers | Create new supplier
*SuppliersApi* | [**deleteSupplierById**](docs/Api/SuppliersApi.md#deletesupplierbyid) | **DELETE** /suppliers/{supplier_id} | Delete a single supplier
*SuppliersApi* | [**getSupplierByID**](docs/Api/SuppliersApi.md#getsupplierbyid) | **GET** /suppliers/{supplier_id} | Get a single supplier
*SuppliersApi* | [**listSuppliers**](docs/Api/SuppliersApi.md#listsuppliers) | **GET** /suppliers | List suppliers
*SuppliersApi* | [**updateSupplierByID**](docs/Api/SuppliersApi.md#updatesupplierbyid) | **PUT** /suppliers/{supplier_id} | Update a supplier
*TagsApi* | [**createTag**](docs/Api/TagsApi.md#createtag) | **POST** /tags | Create tag
*TagsApi* | [**deleteTagByID**](docs/Api/TagsApi.md#deletetagbyid) | **DELETE** /tags/{tag_id} | Delete a single tag
*TagsApi* | [**getTagByID**](docs/Api/TagsApi.md#gettagbyid) | **GET** /tags/{tag_id} | Get a single tag
*TagsApi* | [**listTags**](docs/Api/TagsApi.md#listtags) | **GET** /tags | List tags
*TagsApi* | [**updateTagByID**](docs/Api/TagsApi.md#updatetagbyid) | **PUT** /tags/{tag_id} | Update a single tag
*TaxesApi* | [**createTax**](docs/Api/TaxesApi.md#createtax) | **POST** /taxes | Create tax
*TaxesApi* | [**getTaxByID**](docs/Api/TaxesApi.md#gettaxbyid) | **GET** /taxes/{tax_id} | Get a single tax
*TaxesApi* | [**listTaxes**](docs/Api/TaxesApi.md#listtaxes) | **GET** /taxes | List taxes
*UsersApi* | [**deleteSessionsByUserID**](docs/Api/UsersApi.md#deletesessionsbyuserid) | **DELETE** /users/{user_id}/sessions | Delete user sessions
*UsersApi* | [**deleteUserByID**](docs/Api/UsersApi.md#deleteuserbyid) | **DELETE** /users/{user_id} | Delete a single user
*UsersApi* | [**getSalesTotalsForUserByID**](docs/Api/UsersApi.md#getsalestotalsforuserbyid) | **GET** /users/{user_id}/sale_totals | Get the sales totals for a single user
*UsersApi* | [**getUser**](docs/Api/UsersApi.md#getuser) | **GET** /user | Get current user
*UsersApi* | [**getUserByID**](docs/Api/UsersApi.md#getuserbyid) | **GET** /users/{user_id} | Get a single user
*UsersApi* | [**getUsersById**](docs/Api/UsersApi.md#getusersbyid) | **POST** /users/bulk | Get multiple users by id
*UsersApi* | [**listUsers**](docs/Api/UsersApi.md#listusers) | **GET** /users | List users
*VariantAttributesApi* | [**createVariantAttribute**](docs/Api/VariantAttributesApi.md#createvariantattribute) | **POST** /variant_attributes | Create a Variant Attribute
*VariantAttributesApi* | [**deleteVariantAttribute**](docs/Api/VariantAttributesApi.md#deletevariantattribute) | **DELETE** /variant_attributes/{attribute-id} | Delete a variant attribute
*VariantAttributesApi* | [**getVariantAttributes**](docs/Api/VariantAttributesApi.md#getvariantattributes) | **GET** /variant_attributes/{attribute-id} | Retrieve a single Variant Attribute
*VariantAttributesApi* | [**listVariantAttributes**](docs/Api/VariantAttributesApi.md#listvariantattributes) | **GET** /variant_attributes | Retrieve all Variant Attributes
*VariantAttributesApi* | [**updateVariantAttribute**](docs/Api/VariantAttributesApi.md#updatevariantattribute) | **PUT** /variant_attributes/{attribute-id} | Update a Variant Attribute&#39;s
*WebhooksApi* | [**deleteWebhooksWebhookId**](docs/Api/WebhooksApi.md#deletewebhookswebhookid) | **DELETE** /webhooks/{webhookId} | Delete Webhook
*WebhooksApi* | [**getWebhooks**](docs/Api/WebhooksApi.md#getwebhooks) | **GET** /webhooks | List webhooks
*WebhooksApi* | [**getWebhooksId**](docs/Api/WebhooksApi.md#getwebhooksid) | **GET** /webhooks/{webhookId} | Get Webhook
*WebhooksApi* | [**postWebhooks**](docs/Api/WebhooksApi.md#postwebhooks) | **POST** /webhooks | Create Webhook
*WebhooksApi* | [**putWebhooksId**](docs/Api/WebhooksApi.md#putwebhooksid) | **PUT** /webhooks/{webhookId} | Update Webhook
*WorkflowsApi* | [**createCustomField**](docs/Api/WorkflowsApi.md#createcustomfield) | **POST** /workflows/custom_fields | Define a new custom field
*WorkflowsApi* | [**createRemoteRule**](docs/Api/WorkflowsApi.md#createremoterule) | **POST** /workflows/remote_rules | Create remote rule
*WorkflowsApi* | [**createRule**](docs/Api/WorkflowsApi.md#createrule) | **POST** /workflows/rules | Create rule
*WorkflowsApi* | [**deleteCustomField**](docs/Api/WorkflowsApi.md#deletecustomfield) | **DELETE** /workflows/custom_fields/{customFieldId} | Delete a custom field
*WorkflowsApi* | [**deleteRemoteRule**](docs/Api/WorkflowsApi.md#deleteremoterule) | **DELETE** /workflows/remote_rules/{remoteRuleId} | Delete a remote rule
*WorkflowsApi* | [**deleteRule**](docs/Api/WorkflowsApi.md#deleterule) | **DELETE** /workflows/rules/{ruleId} | Delete a business rule
*WorkflowsApi* | [**getCustomFieldValues**](docs/Api/WorkflowsApi.md#getcustomfieldvalues) | **GET** /workflows/custom_fields/values | List custom field values
*WorkflowsApi* | [**getCustomFields**](docs/Api/WorkflowsApi.md#getcustomfields) | **GET** /workflows/custom_fields | List custom field definitions
*WorkflowsApi* | [**getRemoteRules**](docs/Api/WorkflowsApi.md#getremoterules) | **GET** /workflows/remote_rules | List remote rules
*WorkflowsApi* | [**getRules**](docs/Api/WorkflowsApi.md#getrules) | **GET** /workflows/rules | List rules
*WorkflowsApi* | [**setCustomFieldValues**](docs/Api/WorkflowsApi.md#setcustomfieldvalues) | **POST** /workflows/custom_fields/values | Set new custom field values
*WorkflowsApi* | [**updateCustomField**](docs/Api/WorkflowsApi.md#updatecustomfield) | **PUT** /workflows/custom_fields/{customFieldId} | Update a custom field

## Models

- [Action](docs/Model/Action.md)
- [AddCustomersToCustomerGroupRequest](docs/Model/AddCustomersToCustomerGroupRequest.md)
- [Adjustment](docs/Model/Adjustment.md)
- [Attribute](docs/Model/Attribute.md)
- [AuditLogEvent](docs/Model/AuditLogEvent.md)
- [AuditLogEventData](docs/Model/AuditLogEventData.md)
- [BaseSupplier](docs/Model/BaseSupplier.md)
- [BaseSupplierContact](docs/Model/BaseSupplierContact.md)
- [Brand](docs/Model/Brand.md)
- [BrandBase](docs/Model/BrandBase.md)
- [BrandCollection](docs/Model/BrandCollection.md)
- [BrandResponse](docs/Model/BrandResponse.md)
- [BrandSample](docs/Model/BrandSample.md)
- [BusinessRule](docs/Model/BusinessRule.md)
- [BusinessRuleParams](docs/Model/BusinessRuleParams.md)
- [ButtonLayout](docs/Model/ButtonLayout.md)
- [ButtonLayoutCollection](docs/Model/ButtonLayoutCollection.md)
- [ButtonLayoutNode](docs/Model/ButtonLayoutNode.md)
- [ButtonLayoutNodeAttribute](docs/Model/ButtonLayoutNodeAttribute.md)
- [Channel](docs/Model/Channel.md)
- [ChannelCollectionResponse](docs/Model/ChannelCollectionResponse.md)
- [Composite](docs/Model/Composite.md)
- [Condition](docs/Model/Condition.md)
- [Consignment](docs/Model/Consignment.md)
- [ConsignmentProduct](docs/Model/ConsignmentProduct.md)
- [ConsignmentProductCollection](docs/Model/ConsignmentProductCollection.md)
- [ConsignmentProductRequest](docs/Model/ConsignmentProductRequest.md)
- [ConsignmentProductResponse](docs/Model/ConsignmentProductResponse.md)
- [ConsignmentRequest](docs/Model/ConsignmentRequest.md)
- [ConsignmentResponse](docs/Model/ConsignmentResponse.md)
- [ConsignmentTotalsResponse](docs/Model/ConsignmentTotalsResponse.md)
- [ConsignmentTotalsResponseDataInner](docs/Model/ConsignmentTotalsResponseDataInner.md)
- [CreateBrand200Response](docs/Model/CreateBrand200Response.md)
- [CreateCustomField200Response](docs/Model/CreateCustomField200Response.md)
- [CreateOrUpdateConsignmentProducts200Response](docs/Model/CreateOrUpdateConsignmentProducts200Response.md)
- [CreateOrUpdateConsignmentProducts200ResponseData](docs/Model/CreateOrUpdateConsignmentProducts200ResponseData.md)
- [CreateOrUpdateConsignmentProducts200ResponseDataProductId](docs/Model/CreateOrUpdateConsignmentProducts200ResponseDataProductId.md)
- [CreateProduct200Response](docs/Model/CreateProduct200Response.md)
- [CreateRemoteRule200Response](docs/Model/CreateRemoteRule200Response.md)
- [CreateRule200Response](docs/Model/CreateRule200Response.md)
- [CreateService400Response](docs/Model/CreateService400Response.md)
- [CreateService401Response](docs/Model/CreateService401Response.md)
- [CreateService403Response](docs/Model/CreateService403Response.md)
- [CreateSupplier200Response](docs/Model/CreateSupplier200Response.md)
- [CreateSupplierRequest](docs/Model/CreateSupplierRequest.md)
- [CreateTag200Response](docs/Model/CreateTag200Response.md)
- [CreateTagRequest](docs/Model/CreateTagRequest.md)
- [CreateTaxRequest](docs/Model/CreateTaxRequest.md)
- [CreateUpdateProductCategories200Response](docs/Model/CreateUpdateProductCategories200Response.md)
- [CreateUpdateProductCategories200ResponseDataInner](docs/Model/CreateUpdateProductCategories200ResponseDataInner.md)
- [CreateUpdateProductCategoriesRequest](docs/Model/CreateUpdateProductCategoriesRequest.md)
- [CreateUpdateProductCategoriesRequestCategoriesInner](docs/Model/CreateUpdateProductCategoriesRequestCategoriesInner.md)
- [CustomFieldDefinition](docs/Model/CustomFieldDefinition.md)
- [CustomFieldDefinitionCollection](docs/Model/CustomFieldDefinitionCollection.md)
- [CustomFieldDefinitionParams](docs/Model/CustomFieldDefinitionParams.md)
- [CustomFieldValue](docs/Model/CustomFieldValue.md)
- [CustomFieldValueCollection](docs/Model/CustomFieldValueCollection.md)
- [CustomFieldValuesParams](docs/Model/CustomFieldValuesParams.md)
- [CustomFieldValuesParamsValuesInner](docs/Model/CustomFieldValuesParamsValuesInner.md)
- [Customer](docs/Model/Customer.md)
- [CustomerAddress](docs/Model/CustomerAddress.md)
- [CustomerAddressBase](docs/Model/CustomerAddressBase.md)
- [CustomerAddressCollection](docs/Model/CustomerAddressCollection.md)
- [CustomerAddressCreateResponse](docs/Model/CustomerAddressCreateResponse.md)
- [CustomerAddressCreateResponseData](docs/Model/CustomerAddressCreateResponseData.md)
- [CustomerAddressResponse](docs/Model/CustomerAddressResponse.md)
- [CustomerBase](docs/Model/CustomerBase.md)
- [CustomerCollection](docs/Model/CustomerCollection.md)
- [CustomerGroup](docs/Model/CustomerGroup.md)
- [CustomerGroupCollection](docs/Model/CustomerGroupCollection.md)
- [CustomerGroupResponse](docs/Model/CustomerGroupResponse.md)
- [CustomerResponse](docs/Model/CustomerResponse.md)
- [DailyAgenda](docs/Model/DailyAgenda.md)
- [DeleteBrandByID200Response](docs/Model/DeleteBrandByID200Response.md)
- [DeleteBrandByID200ResponsePayload](docs/Model/DeleteBrandByID200ResponsePayload.md)
- [DeleteBrandByID200ResponsePayloadData](docs/Model/DeleteBrandByID200ResponsePayloadData.md)
- [DeleteCustomersFromCustomerGroupRequest](docs/Model/DeleteCustomersFromCustomerGroupRequest.md)
- [DeleteProductCategories200Response](docs/Model/DeleteProductCategories200Response.md)
- [DeleteProductCategories200ResponseData](docs/Model/DeleteProductCategories200ResponseData.md)
- [DeleteProductCategories200ResponseDataCategoriesInner](docs/Model/DeleteProductCategories200ResponseDataCategoriesInner.md)
- [DeleteProductCategoriesRequest](docs/Model/DeleteProductCategoriesRequest.md)
- [DeleteSupplierById200Response](docs/Model/DeleteSupplierById200Response.md)
- [DeleteSupplierById200ResponseData](docs/Model/DeleteSupplierById200ResponseData.md)
- [DeleteTagByID200Response](docs/Model/DeleteTagByID200Response.md)
- [DeleteTagByID200ResponseData](docs/Model/DeleteTagByID200ResponseData.md)
- [DetailedService](docs/Model/DetailedService.md)
- [DiscountCustomerParam](docs/Model/DiscountCustomerParam.md)
- [DiscountLineItem](docs/Model/DiscountLineItem.md)
- [DiscountParam](docs/Model/DiscountParam.md)
- [DiscountResponse](docs/Model/DiscountResponse.md)
- [DiscountResponseParam](docs/Model/DiscountResponseParam.md)
- [DiscountSaleParam](docs/Model/DiscountSaleParam.md)
- [EcomCustomCharge](docs/Model/EcomCustomCharge.md)
- [EcomCustomChargeTaxComponent](docs/Model/EcomCustomChargeTaxComponent.md)
- [EcomCustomCharges](docs/Model/EcomCustomCharges.md)
- [Filter](docs/Model/Filter.md)
- [FulfillLineItemsRequest](docs/Model/FulfillLineItemsRequest.md)
- [FulfillLineItemsResponse](docs/Model/FulfillLineItemsResponse.md)
- [FulfillSaleRequest](docs/Model/FulfillSaleRequest.md)
- [FulfillSaleResponse](docs/Model/FulfillSaleResponse.md)
- [Fulfillment](docs/Model/Fulfillment.md)
- [FulfillmentLineItem](docs/Model/FulfillmentLineItem.md)
- [FulfillmentLineItemRequest](docs/Model/FulfillmentLineItemRequest.md)
- [FulfillmentResponse](docs/Model/FulfillmentResponse.md)
- [FulfillmentSummaryItem](docs/Model/FulfillmentSummaryItem.md)
- [FulfillmentSummaryLineItem](docs/Model/FulfillmentSummaryLineItem.md)
- [FulfillmentSummaryResponse](docs/Model/FulfillmentSummaryResponse.md)
- [FulfillmentsResponse](docs/Model/FulfillmentsResponse.md)
- [GetAuditLogEvents200Response](docs/Model/GetAuditLogEvents200Response.md)
- [GetRemoteRules200Response](docs/Model/GetRemoteRules200Response.md)
- [GetRules200Response](docs/Model/GetRules200Response.md)
- [GetSecurityEvents200Response](docs/Model/GetSecurityEvents200Response.md)
- [GetUsersByIdsRequest](docs/Model/GetUsersByIdsRequest.md)
- [GetWebhooks200Response](docs/Model/GetWebhooks200Response.md)
- [GiftCard](docs/Model/GiftCard.md)
- [GiftCardActivationParams](docs/Model/GiftCardActivationParams.md)
- [GiftCardCollection](docs/Model/GiftCardCollection.md)
- [GiftCardTransaction](docs/Model/GiftCardTransaction.md)
- [GiftCardTransactionParams](docs/Model/GiftCardTransactionParams.md)
- [Image](docs/Model/Image.md)
- [ImagePosition](docs/Model/ImagePosition.md)
- [ImageResponse](docs/Model/ImageResponse.md)
- [ImageSample](docs/Model/ImageSample.md)
- [Inventory](docs/Model/Inventory.md)
- [InventoryCollection](docs/Model/InventoryCollection.md)
- [InventoryCountItem](docs/Model/InventoryCountItem.md)
- [InventoryCountItemResponse](docs/Model/InventoryCountItemResponse.md)
- [InventoryLevel](docs/Model/InventoryLevel.md)
- [InventoryLevelLevels](docs/Model/InventoryLevelLevels.md)
- [InventoryLevelsRequest](docs/Model/InventoryLevelsRequest.md)
- [ItemDetails](docs/Model/ItemDetails.md)
- [LineItem](docs/Model/LineItem.md)
- [LineItemSurcharge](docs/Model/LineItemSurcharge.md)
- [LineItemTaxComponent](docs/Model/LineItemTaxComponent.md)
- [ListInventoryLevels200Response](docs/Model/ListInventoryLevels200Response.md)
- [ListProductCategories200Response](docs/Model/ListProductCategories200Response.md)
- [ListProductCategories200ResponseData](docs/Model/ListProductCategories200ResponseData.md)
- [ListProductCategories200ResponsePageInfo](docs/Model/ListProductCategories200ResponsePageInfo.md)
- [ListProductInventoryLevels200Response](docs/Model/ListProductInventoryLevels200Response.md)
- [ListProductInventoryLevels200ResponseTotals](docs/Model/ListProductInventoryLevels200ResponseTotals.md)
- [ListServiceItems200Response](docs/Model/ListServiceItems200Response.md)
- [ListServiceItems200ResponseJobItemsInner](docs/Model/ListServiceItems200ResponseJobItemsInner.md)
- [ListServiceItems200ResponseJobItemsInnerItemDetails](docs/Model/ListServiceItems200ResponseJobItemsInnerItemDetails.md)
- [ListServices200Response](docs/Model/ListServices200Response.md)
- [ListServices200ResponseJobsInner](docs/Model/ListServices200ResponseJobsInner.md)
- [Outlet](docs/Model/Outlet.md)
- [OutletCollection](docs/Model/OutletCollection.md)
- [OutletResponse](docs/Model/OutletResponse.md)
- [OutletTax](docs/Model/OutletTax.md)
- [OutletTaxCollection](docs/Model/OutletTaxCollection.md)
- [PackLineItemRequest](docs/Model/PackLineItemRequest.md)
- [PackLineItemsRequest](docs/Model/PackLineItemsRequest.md)
- [PackLineItemsResponse](docs/Model/PackLineItemsResponse.md)
- [PackLineItemsResponseData](docs/Model/PackLineItemsResponseData.md)
- [PaginationMetadata](docs/Model/PaginationMetadata.md)
- [PartnerSubscription](docs/Model/PartnerSubscription.md)
- [PartnerSubscription200Response](docs/Model/PartnerSubscription200Response.md)
- [PartnerSubscriptionInfo](docs/Model/PartnerSubscriptionInfo.md)
- [PartnerSubscriptionToken](docs/Model/PartnerSubscriptionToken.md)
- [PartnerSubscriptionTokenComponent](docs/Model/PartnerSubscriptionTokenComponent.md)
- [PartnerSubscriptionTokenRequest](docs/Model/PartnerSubscriptionTokenRequest.md)
- [PartnerSubscriptionTokenResponse](docs/Model/PartnerSubscriptionTokenResponse.md)
- [PartnerSubscriptions200Response](docs/Model/PartnerSubscriptions200Response.md)
- [PartnerToken200Response](docs/Model/PartnerToken200Response.md)
- [PartnerTokenGet200Response](docs/Model/PartnerTokenGet200Response.md)
- [PartnerUpdateSubscriptionTokenComponent](docs/Model/PartnerUpdateSubscriptionTokenComponent.md)
- [PartnerUpdateSubscriptionTokenRequest](docs/Model/PartnerUpdateSubscriptionTokenRequest.md)
- [Payment](docs/Model/Payment.md)
- [PaymentType](docs/Model/PaymentType.md)
- [PaymentTypeCollection](docs/Model/PaymentTypeCollection.md)
- [PickLineItemRequest](docs/Model/PickLineItemRequest.md)
- [PickLineItemsRequest](docs/Model/PickLineItemsRequest.md)
- [PickLineItemsResponse](docs/Model/PickLineItemsResponse.md)
- [PickList](docs/Model/PickList.md)
- [PickListLineItem](docs/Model/PickListLineItem.md)
- [PickListsResponse](docs/Model/PickListsResponse.md)
- [PostWebhooks201Response](docs/Model/PostWebhooks201Response.md)
- [PostWebhooks409Response](docs/Model/PostWebhooks409Response.md)
- [PriceBook](docs/Model/PriceBook.md)
- [PriceBookCollection](docs/Model/PriceBookCollection.md)
- [PriceBookCreateRequest](docs/Model/PriceBookCreateRequest.md)
- [PriceBookCreateResponse](docs/Model/PriceBookCreateResponse.md)
- [PriceBookCreateResponseData](docs/Model/PriceBookCreateResponseData.md)
- [PriceBookProduct](docs/Model/PriceBookProduct.md)
- [PriceBookProductCollection](docs/Model/PriceBookProductCollection.md)
- [PriceBookProductIdCollection](docs/Model/PriceBookProductIdCollection.md)
- [PriceBookProductIdCollectionData](docs/Model/PriceBookProductIdCollectionData.md)
- [PriceBookProductsUpdateResponse](docs/Model/PriceBookProductsUpdateResponse.md)
- [PriceBookProductsUpdateResponseData](docs/Model/PriceBookProductsUpdateResponseData.md)
- [PriceBookResponse](docs/Model/PriceBookResponse.md)
- [PriceBookUpdateRequest](docs/Model/PriceBookUpdateRequest.md)
- [Product](docs/Model/Product.md)
- [ProductAddImage](docs/Model/ProductAddImage.md)
- [ProductAddInventoryPayload](docs/Model/ProductAddInventoryPayload.md)
- [ProductAddOutletTax](docs/Model/ProductAddOutletTax.md)
- [ProductAddVariantPayload](docs/Model/ProductAddVariantPayload.md)
- [ProductAddVariantPayloadAllOutletsTax](docs/Model/ProductAddVariantPayloadAllOutletsTax.md)
- [ProductCategory](docs/Model/ProductCategory.md)
- [ProductCategoryPath](docs/Model/ProductCategoryPath.md)
- [ProductCode](docs/Model/ProductCode.md)
- [ProductCollection](docs/Model/ProductCollection.md)
- [ProductCreateBody](docs/Model/ProductCreateBody.md)
- [ProductInfoComponent](docs/Model/ProductInfoComponent.md)
- [ProductResponse](docs/Model/ProductResponse.md)
- [ProductSupplier](docs/Model/ProductSupplier.md)
- [ProductType](docs/Model/ProductType.md)
- [ProductTypeCollection](docs/Model/ProductTypeCollection.md)
- [ProductTypeResponse](docs/Model/ProductTypeResponse.md)
- [ProductTypeSample](docs/Model/ProductTypeSample.md)
- [ProductUpdate21Request](docs/Model/ProductUpdate21Request.md)
- [ProductUpdate21RequestCommon](docs/Model/ProductUpdate21RequestCommon.md)
- [ProductUpdate21RequestCommonVariantAttributesInner](docs/Model/ProductUpdate21RequestCommonVariantAttributesInner.md)
- [ProductUpdate21RequestDetails](docs/Model/ProductUpdate21RequestDetails.md)
- [ProductUpdate21RequestDetailsAllOutletsTax](docs/Model/ProductUpdate21RequestDetailsAllOutletsTax.md)
- [ProductUpdate21RequestDetailsCompositeComponentsInner](docs/Model/ProductUpdate21RequestDetailsCompositeComponentsInner.md)
- [ProductUpdate21RequestDetailsInventoryInner](docs/Model/ProductUpdate21RequestDetailsInventoryInner.md)
- [ProductUpdate21RequestDetailsOutletTaxesInner](docs/Model/ProductUpdate21RequestDetailsOutletTaxesInner.md)
- [ProductUpdate21RequestDetailsPackagingInner](docs/Model/ProductUpdate21RequestDetailsPackagingInner.md)
- [ProductUpdate21RequestDetailsProductCodesInner](docs/Model/ProductUpdate21RequestDetailsProductCodesInner.md)
- [ProductUpdate21RequestDetailsVariantAttributeValuesInner](docs/Model/ProductUpdate21RequestDetailsVariantAttributeValuesInner.md)
- [ProductUpdate21Supplier](docs/Model/ProductUpdate21Supplier.md)
- [PromoCode](docs/Model/PromoCode.md)
- [PromoCodeValidation](docs/Model/PromoCodeValidation.md)
- [Promotion](docs/Model/Promotion.md)
- [PromotionActivePromoCodesResponse](docs/Model/PromotionActivePromoCodesResponse.md)
- [PromotionCollection](docs/Model/PromotionCollection.md)
- [PromotionDescription](docs/Model/PromotionDescription.md)
- [PromotionProductsResponse](docs/Model/PromotionProductsResponse.md)
- [PromotionProductsResponseData](docs/Model/PromotionProductsResponseData.md)
- [PromotionPromoCodeSummary](docs/Model/PromotionPromoCodeSummary.md)
- [PromotionPromoCodesResponse](docs/Model/PromotionPromoCodesResponse.md)
- [PromotionPromoCodesResponseDataInner](docs/Model/PromotionPromoCodesResponseDataInner.md)
- [PromotionResponse](docs/Model/PromotionResponse.md)
- [Quote](docs/Model/Quote.md)
- [QuoteProduct](docs/Model/QuoteProduct.md)
- [QuotesCollection](docs/Model/QuotesCollection.md)
- [QuotesProductsTaxComponents](docs/Model/QuotesProductsTaxComponents.md)
- [RateRule](docs/Model/RateRule.md)
- [RecurringPromotion](docs/Model/RecurringPromotion.md)
- [RecurringPromotionOccurrence](docs/Model/RecurringPromotionOccurrence.md)
- [Register](docs/Model/Register.md)
- [RegisterClosePaymentType](docs/Model/RegisterClosePaymentType.md)
- [RegisterCloseRequest](docs/Model/RegisterCloseRequest.md)
- [RegisterCollection](docs/Model/RegisterCollection.md)
- [RegisterOpenRequest](docs/Model/RegisterOpenRequest.md)
- [RegisterPaymentSummaryPaymentType](docs/Model/RegisterPaymentSummaryPaymentType.md)
- [RegisterPaymentsSummary](docs/Model/RegisterPaymentsSummary.md)
- [RegisterPaymentsSummaryResponse](docs/Model/RegisterPaymentsSummaryResponse.md)
- [RegisterResponse](docs/Model/RegisterResponse.md)
- [RemoteBusinessRule](docs/Model/RemoteBusinessRule.md)
- [RemoteBusinessRuleParams](docs/Model/RemoteBusinessRuleParams.md)
- [RequestCollectionResponse](docs/Model/RequestCollectionResponse.md)
- [RequestLog](docs/Model/RequestLog.md)
- [RequestSingleResponse](docs/Model/RequestSingleResponse.md)
- [Retailer](docs/Model/Retailer.md)
- [RetailerCurrency](docs/Model/RetailerCurrency.md)
- [RetailerGiftCards](docs/Model/RetailerGiftCards.md)
- [RetailerLoyalty](docs/Model/RetailerLoyalty.md)
- [RetailerResponse](docs/Model/RetailerResponse.md)
- [RetailerSkuSequence](docs/Model/RetailerSkuSequence.md)
- [Role](docs/Model/Role.md)
- [Sale](docs/Model/Sale.md)
- [SaleCollection](docs/Model/SaleCollection.md)
- [SaleResponse](docs/Model/SaleResponse.md)
- [SaleSurcharge](docs/Model/SaleSurcharge.md)
- [SaleTax](docs/Model/SaleTax.md)
- [SearchResponse](docs/Model/SearchResponse.md)
- [SerialNumber](docs/Model/SerialNumber.md)
- [SerialNumberCollection](docs/Model/SerialNumberCollection.md)
- [SerialNumberRequest](docs/Model/SerialNumberRequest.md)
- [SerialNumberResponse](docs/Model/SerialNumberResponse.md)
- [ServiceItems](docs/Model/ServiceItems.md)
- [ServiceNote](docs/Model/ServiceNote.md)
- [ServiceOrder](docs/Model/ServiceOrder.md)
- [ServiceOrderLineItemsInner](docs/Model/ServiceOrderLineItemsInner.md)
- [ServiceOrderRequest](docs/Model/ServiceOrderRequest.md)
- [ServiceOrderRequestExtraFields](docs/Model/ServiceOrderRequestExtraFields.md)
- [ServiceOrderRequestItem](docs/Model/ServiceOrderRequestItem.md)
- [ServiceOrderRequestNotesInner](docs/Model/ServiceOrderRequestNotesInner.md)
- [ServiceOrderTotals](docs/Model/ServiceOrderTotals.md)
- [Shift](docs/Model/Shift.md)
- [ShiftCollection](docs/Model/ShiftCollection.md)
- [StoreCreditBulkResponse](docs/Model/StoreCreditBulkResponse.md)
- [StoreCreditCustomer](docs/Model/StoreCreditCustomer.md)
- [StoreCreditReport](docs/Model/StoreCreditReport.md)
- [StoreCreditTransaction](docs/Model/StoreCreditTransaction.md)
- [StoreCreditTransactionParams](docs/Model/StoreCreditTransactionParams.md)
- [Supplier](docs/Model/Supplier.md)
- [SupplierCollection](docs/Model/SupplierCollection.md)
- [SupplierResponse](docs/Model/SupplierResponse.md)
- [SupplierSample](docs/Model/SupplierSample.md)
- [Tag](docs/Model/Tag.md)
- [TagCollection](docs/Model/TagCollection.md)
- [TagResponse](docs/Model/TagResponse.md)
- [Tax](docs/Model/Tax.md)
- [TaxCollection](docs/Model/TaxCollection.md)
- [TaxRate](docs/Model/TaxRate.md)
- [TaxResponse](docs/Model/TaxResponse.md)
- [UpdateBrandById200Response](docs/Model/UpdateBrandById200Response.md)
- [UpdateBrandById200ResponseData](docs/Model/UpdateBrandById200ResponseData.md)
- [UpdateCustomFieldParams](docs/Model/UpdateCustomFieldParams.md)
- [UpdateSupplierByID200Response](docs/Model/UpdateSupplierByID200Response.md)
- [UpdateTagByID200Response](docs/Model/UpdateTagByID200Response.md)
- [UploadImageRequest](docs/Model/UploadImageRequest.md)
- [User](docs/Model/User.md)
- [UserCollection](docs/Model/UserCollection.md)
- [UserImages](docs/Model/UserImages.md)
- [UserResponse](docs/Model/UserResponse.md)
- [UserSaleTotalCollection](docs/Model/UserSaleTotalCollection.md)
- [UserSaleTotalResponse](docs/Model/UserSaleTotalResponse.md)
- [VariantAttribute](docs/Model/VariantAttribute.md)
- [VariantAttributeCreateResponse](docs/Model/VariantAttributeCreateResponse.md)
- [VariantAttributeCreateResponseData](docs/Model/VariantAttributeCreateResponseData.md)
- [VariantAttributeCreateUpdateBody](docs/Model/VariantAttributeCreateUpdateBody.md)
- [VariantAttributeDeleteResponse](docs/Model/VariantAttributeDeleteResponse.md)
- [VariantAttributeDeleteResponseData](docs/Model/VariantAttributeDeleteResponseData.md)
- [VariantAttributeResponse](docs/Model/VariantAttributeResponse.md)
- [VariantAttributeUpdateResponse](docs/Model/VariantAttributeUpdateResponse.md)
- [VariantAttributeUpdateResponseData](docs/Model/VariantAttributeUpdateResponseData.md)
- [VariantAttributesListResponse](docs/Model/VariantAttributesListResponse.md)
- [VariantOption](docs/Model/VariantOption.md)
- [Version](docs/Model/Version.md)
- [VersionMetadata](docs/Model/VersionMetadata.md)
- [Webhook](docs/Model/Webhook.md)
- [WebhookRequest](docs/Model/WebhookRequest.md)

## Authorization

Authentication schemes defined for the API:
### bearerAuth

- **Type**: Bearer authentication

## Tests

To run the tests, use:

```bash
composer install
vendor/bin/phpunit
```

## Author

x-series.api@lightspeedhq.com

## About this package

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `2026-01`
    - Package version: `2026-01`
    - Generator version: `7.20.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
