> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/point-of-sale/products.md).

# Products

Product catalog and inventory management.

## GET /pos/products

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Products","description":"Product catalog and inventory management."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaginatedProductCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"ProductDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"brandName":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"sku":{"type":"string"},"upc":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"price":{"type":"number"},"cost":{"type":"number"},"salesType":{"type":"string","enum":["PRODUCT","SERVICE"]},"category":{"$ref":"#/components/schemas/ItemRefDto"},"subcategory":{"$ref":"#/components/schemas/ItemRefDto"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"offerings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","sku","status","salesType","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/pos/products":{"get":{"operationId":"ProductsController_find","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"sort","required":false,"in":"query","description":"If not set, `sort` will be defaulted as `name` (ASC)","schema":{"type":"string"}},{"name":"salesType","required":false,"in":"query","schema":{"enum":["PRODUCT","SERVICE"],"type":"string"}},{"name":"upc","required":false,"in":"query","schema":{"type":"string"}},{"name":"sku","required":false,"in":"query","schema":{"type":"string"}},{"name":"includeOfferingsFromAreaId","required":false,"in":"query","schema":{"type":"string"}},{"name":"excludeAreaIds","required":false,"in":"query","schema":{"type":"array","items":{}}},{"name":"subcategoryId","required":false,"in":"query","schema":{"type":"string"}},{"name":"categoryId","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `PaginatedProductCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProductCollectionDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Products"]}}}}
```

## POST /pos/products

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Products","description":"Product catalog and inventory management."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"brandName":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"sku":{"type":"string"},"upc":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"price":{"type":"number"},"cost":{"type":"number"},"salesType":{"type":"string","enum":["PRODUCT","SERVICE"]},"category":{"$ref":"#/components/schemas/ItemRefDto"},"subcategory":{"$ref":"#/components/schemas/ItemRefDto"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"offerings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","sku","status","salesType","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/pos/products":{"post":{"operationId":"ProductsController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"responses":{"201":{"description":"Returns a `Product`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"422":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Products"]}}}}
```

## POST /pos/products/export

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Products","description":"Product catalog and inventory management."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/pos/products/export":{"post":{"operationId":"ProductsController_export","parameters":[],"responses":{"200":{"description":"Returns a streamable file"},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"text/csv":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Products"]}}}}
```

## GET /pos/products/{productId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Products","description":"Product catalog and inventory management."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"brandName":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"sku":{"type":"string"},"upc":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"price":{"type":"number"},"cost":{"type":"number"},"salesType":{"type":"string","enum":["PRODUCT","SERVICE"]},"category":{"$ref":"#/components/schemas/ItemRefDto"},"subcategory":{"$ref":"#/components/schemas/ItemRefDto"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"offerings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","sku","status","salesType","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/pos/products/{productId}":{"get":{"operationId":"ProductsController_findById","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `Product`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"Product not found"}},"tags":["Products"]}}}}
```

## DELETE /pos/products/{productId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Products","description":"Product catalog and inventory management."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/pos/products/{productId}":{"delete":{"operationId":"ProductsController_delete","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Product deleted successfully"},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"Product not found"}},"tags":["Products"]}}}}
```

## PATCH /pos/products/{productId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Products","description":"Product catalog and inventory management."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"brandName":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"sku":{"type":"string"},"upc":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"price":{"type":"number"},"cost":{"type":"number"},"salesType":{"type":"string","enum":["PRODUCT","SERVICE"]},"category":{"$ref":"#/components/schemas/ItemRefDto"},"subcategory":{"$ref":"#/components/schemas/ItemRefDto"},"picture":{"$ref":"#/components/schemas/ItemRefDto"},"createdBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"updatedAt":{"format":"date-time","type":"string","readOnly":true},"offerings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CollectionRefDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","name","sku","status","salesType","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"CollectionRefDto":{"type":"object","properties":{"_total":{"type":"number","description":"The total amount of elements in this collection"}}},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/pos/products/{productId}":{"patch":{"operationId":"ProductsController_update","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"responses":{"200":{"description":"Returns a `Product`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"Product not found"}},"tags":["Products"]}}}}
```

## POST /pos/products/import

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Products","description":"Product catalog and inventory management."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductImportSummaryDto":{"type":"object","properties":{"imported":{"type":"number"},"updated":{"type":"number"},"failed":{"type":"number"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["imported","updated","failed","errors"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/pos/products/import":{"post":{"operationId":"ProductsController_import","parameters":[],"requestBody":{"required":true,"description":"File upload","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"$ref":"#/components/schemas/"}}}},"responses":{"201":{"description":"Returns a `ProductImportSummary`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductImportSummaryDto"}}}},"400":{"description":"Returns an `ErrorDto` if the file is not a valid CSV","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"422":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["Products"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/point-of-sale/products.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.