PUT api/Products/SaveProduct
Update an existing Product based on the PLU or creates a new Product if not found.
Request Information
URI Parameters
None.
Body Parameters
The product object to be created or updated.
APIProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| PLU | string |
None. |
|
| ProductDescription | string |
None. |
|
| TicketDescription | string |
None. |
|
| GiftAidProduct | boolean |
None. |
|
| GiftAidPortion | decimal number |
None. |
|
| Adults | integer |
None. |
|
| Children | integer |
None. |
|
| CategoryCode | integer |
None. |
|
| CategoryName | string |
None. |
|
| SubCategory | string |
None. |
|
| Department | string |
None. |
|
| PriceDescription | string |
None. |
|
| Price | decimal number |
None. |
|
| OnHand | decimal number |
None. |
|
| ProductImage | string |
None. |
|
| Notes | string |
None. |
|
| IsKit | boolean |
None. |
|
| LowestKitItemPLU | string |
None. |
|
| Quantity | integer |
None. |
|
| SeatReservationID | integer |
None. |
|
| GiftVoucherReference | string |
None. |
|
| Donation | boolean |
None. |
|
| ProductUDFs | Collection of Object |
None. |
|
| TicketCapacity | integer |
None. |
|
| TicketAvailability | integer |
None. |
|
| Barcode | string |
None. |
|
| Diminishing | boolean |
None. |
|
| Discontinued | boolean |
None. |
|
| InActive | boolean |
None. |
|
| StockInUse | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{"ID":0,"PLU":"","ProductDescription":"","TicketDescription":"","GiftAidProduct":false,"GiftAidPortion":0.0,"Adults":0,"Children":0,"CategoryCode":0,"CategoryName":"","SubCategory":"","Department":"","PriceDescription":"","Price":0.0,"OnHand":0.0,"ProductImage":"","Notes":"","IsKit":false,"LowestKitItemPLU":"","Quantity":0,"SeatReservationID":0,"GiftVoucherReference":"","Donation":false,"ProductUDFs":null,"TicketCapacity":0,"TicketAvailability":0,"Barcode":"","Diminishing":true,"Discontinued":false,"InActive":false,"StockInUse":true}
application/xml, text/xml
Sample:
<?xml version="1.0" encoding="utf-16"?> <APIProduct xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ID>0</ID> <PLU /> <ProductDescription /> <TicketDescription /> <GiftAidProduct>false</GiftAidProduct> <GiftAidPortion>0</GiftAidPortion> <Adults>0</Adults> <Children>0</Children> <CategoryCode>0</CategoryCode> <CategoryName /> <SubCategory /> <Department /> <PriceDescription /> <Price>0</Price> <OnHand>0</OnHand> <ProductImage /> <Notes /> <IsKit>false</IsKit> <LowestKitItemPLU /> <Quantity>0</Quantity> <SeatReservationID>0</SeatReservationID> <GiftVoucherReference /> <Donation>false</Donation> <TicketCapacity>0</TicketCapacity> <TicketAvailability>0</TicketAvailability> <Barcode /> <Diminishing>true</Diminishing> <Discontinued>false</Discontinued> <InActive>false</InActive> <StockInUse>true</StockInUse> </APIProduct>
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{"Result":"SUCCESS","Message":"The Product: 0000001 Test Product was saved successfully!"}
application/xml, text/xml
Sample:
<?xml version="1.0" encoding="utf-16"?> <InformationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Result>SUCCESS</Result> <Message>The Product: 0000001 Test Product was saved successfully!</Message> </InformationResponse>