> 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/product-offerings.md).

# Product Offerings

Product pricing, variants, and availability.

## GET /pos/product-offerings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"PaginatedProductOfferingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingDto"}},"_total":{"type":"number"},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_pagination","_links"]},"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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/product-offerings":{"get":{"operationId":"ProductOfferingsController_find","parameters":[{"name":"regionId","required":false,"in":"query","schema":{"type":"string"}},{"name":"areaId","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"appAvailable","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"sort","required":false,"in":"query","description":"If not set, `sort` will be defaulted as `name` (ASC)","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"salesType","required":false,"in":"query","schema":{"enum":["PRODUCT","SERVICE"],"type":"string"}},{"name":"subcategoryId","required":false,"in":"query","schema":{"type":"string"}},{"name":"categoryId","required":false,"in":"query","schema":{"type":"string"}},{"name":"productId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `ProductOfferingCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProductOfferingCollectionDto"}}}},"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":["ProductOfferings"]}}}}
```

## POST /pos/product-offerings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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/product-offerings":{"post":{"operationId":"ProductOfferingsController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingDto"}}}},"responses":{"201":{"description":"Returns a `ProductOffering`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingDto"}}}},"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":["ProductOfferings"]}}}}
```

## PATCH /pos/product-offerings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingCollectionPatchableDto":{"type":"object","properties":{}},"ProductOfferingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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"]},"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/product-offerings":{"patch":{"operationId":"ProductOfferingsController_upsert","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingCollectionPatchableDto"}}}},"responses":{"201":{"description":"Returns a collection of `ProductOfferingCollectionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingCollectionDto"}}}},"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":["ProductOfferings"]}}}}
```

## GET /pos/product-offerings/feed

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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"]},"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/product-offerings/feed":{"get":{"operationId":"ProductOfferingsController_getFeed","parameters":[{"name":"areaId","required":false,"in":"query","schema":{"type":"string"}},{"name":"salesType","required":false,"in":"query","schema":{"enum":["PRODUCT","SERVICE"],"type":"string"}}],"responses":{"200":{"description":"Returns a `ProductOfferingCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingCollectionDto"}}}},"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":["ProductOfferings"]}}}}
```

## GET /pos/product-offerings/{productOfferingId}/settings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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/product-offerings/{productOfferingId}/settings":{"get":{"operationId":"ProductOfferingsController_getProductOfferingSettings","parameters":[{"name":"productOfferingId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `ProductOfferingSettings`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"}}}},"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 Offering not found"}},"tags":["ProductOfferings"]}}}}
```

## GET /pos/product-offerings/{productOfferingId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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/product-offerings/{productOfferingId}":{"get":{"operationId":"ProductOfferingsController_findById","parameters":[{"name":"productOfferingId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `ProductOffering`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingDto"}}}},"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 Offering not found"}},"tags":["ProductOfferings"]}}}}
```

## DELETE /pos/product-offerings/{productOfferingId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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/product-offerings/{productOfferingId}":{"delete":{"operationId":"ProductOfferingsController_delete","parameters":[{"name":"productOfferingId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Product Offering deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingDto"}}}},"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 Offering not found"}},"tags":["ProductOfferings"]}}}}
```

## PATCH /pos/product-offerings/{productOfferingId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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/product-offerings/{productOfferingId}":{"patch":{"operationId":"ProductOfferingsController_update","parameters":[{"name":"productOfferingId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingDto"}}}},"responses":{"200":{"description":"Returns a `ProductOffering`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingDto"}}}},"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 Offering not found"}},"tags":["ProductOfferings"]}}}}
```

## POST /pos/product-offerings/bulk-delete

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"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"]},"ProductOfferingCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"ProductOfferingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"product":{"$ref":"#/components/schemas/ItemRefDto"},"region":{"$ref":"#/components/schemas/ItemRefDto"},"area":{"$ref":"#/components/schemas/ItemRefDto"},"appAvailable":{"type":"boolean","default":false},"applyDiscounts":{"type":"boolean","default":false},"status":{"type":"array","items":{"type":"string","enum":["DRAFT","AVAILABLE","UNAVAILABLE"]}},"sku":{"type":"string"},"price":{"type":"number"},"priceCompare":{"type":"number"},"stock":{"type":"number","description":"Current stock quantity"},"lowStockAlert":{"type":"number","description":"Low stock alert threshold"},"taxCategory":{"$ref":"#/components/schemas/ItemRefDto"},"settings":{"$ref":"#/components/schemas/ProductOfferingSettingsDto"},"discount":{"readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductOfferingDiscountDto"}]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","product","region","area","status","sku","price","priceCompare","settings","discount","errors","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ProductOfferingSettingsDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"cost":{"type":"number"},"applyTaxes":{"type":"boolean","description":"A parameter to apply taxes or not"},"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},"_links":{"type":"object"}},"required":["id","applyTaxes","_links"]},"ProductOfferingDiscountDto":{"type":"object","properties":{"amount":{"type":"number"},"description":{"type":"string"}},"required":["amount"]},"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/product-offerings/bulk-delete":{"post":{"operationId":"ProductOfferingsController_bulkDelete","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemRefCollectionDto"}}}},"responses":{"200":{"description":"Returns a collection of `ProductOfferingCollectionDto`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingCollectionDto"}}}},"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":["ProductOfferings"]}}}}
```

## GET /pos/product-offerings/{productOfferingId}/stock-transactions/{stockTransactionId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingStockTransactionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"productOffering":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["IN","OUT"]},"quantity":{"type":"number"},"quantityAfter":{"type":"number","readOnly":true},"source":{"type":"string","enum":["INITIAL_STOCK","ORDER","MANUAL_ADJUSTMENT"],"readOnly":true},"reason":{"type":"string"},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","productOffering","order","createdAt","type","quantity","quantityAfter","source","reason","updatedBy","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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/product-offerings/{productOfferingId}/stock-transactions/{stockTransactionId}":{"get":{"operationId":"ProductOfferingStockTransactionsController_getStockTransactionById","parameters":[{"name":"productOfferingId","required":true,"in":"path","schema":{"type":"string"}},{"name":"stockTransactionId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `ProductOfferingStockTransaction`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingStockTransactionDto"}}}},"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":"Returns an `ErrorDto` in case the Product Offering or Stock Transaction is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["ProductOfferings"]}}}}
```

## GET /pos/product-offerings/{productOfferingId}/stock-transactions

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingStockTransactionsPaginatedCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOfferingStockTransactionDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_total":{"type":"number","deprecated":true},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_total","_links"]},"ProductOfferingStockTransactionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"productOffering":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["IN","OUT"]},"quantity":{"type":"number"},"quantityAfter":{"type":"number","readOnly":true},"source":{"type":"string","enum":["INITIAL_STOCK","ORDER","MANUAL_ADJUSTMENT"],"readOnly":true},"reason":{"type":"string"},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","productOffering","order","createdAt","type","quantity","quantityAfter","source","reason","updatedBy","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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/product-offerings/{productOfferingId}/stock-transactions":{"get":{"operationId":"ProductOfferingStockTransactionsController_getStockTransactionsByProductOffering","parameters":[{"name":"productOfferingId","required":true,"in":"path","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"Returns a `ProductOfferingStockTransactionsCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingStockTransactionsPaginatedCollectionDto"}}}},"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":"Returns an `ErrorDto` in case the Product Offering is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["ProductOfferings"]}}}}
```

## POST /pos/product-offerings/{productOfferingId}/stock-transactions

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"ProductOfferings","description":"Product pricing, variants, and availability."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ProductOfferingStockTransactionDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"productOffering":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"order":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"createdAt":{"format":"date-time","type":"string","readOnly":true},"type":{"type":"string","enum":["IN","OUT"]},"quantity":{"type":"number"},"quantityAfter":{"type":"number","readOnly":true},"source":{"type":"string","enum":["INITIAL_STOCK","ORDER","MANUAL_ADJUSTMENT"],"readOnly":true},"reason":{"type":"string"},"updatedBy":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"_links":{"type":"object"}},"required":["id","productOffering","order","createdAt","type","quantity","quantityAfter","source","reason","updatedBy","_links"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"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/product-offerings/{productOfferingId}/stock-transactions":{"post":{"operationId":"ProductOfferingStockTransactionsController_postStockTransactions","parameters":[{"name":"productOfferingId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingStockTransactionDto"}}}},"responses":{"201":{"description":"Returns a `ProductOfferingStockTransaction`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOfferingStockTransactionDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"500":{"description":"Returns an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}}},"tags":["ProductOfferings"]}}}}
```


---

# 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/product-offerings.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.