Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Excerpt |
---|
This method allows you to update an existing product in Komet Sales. |
Request
https://api.kometsales.com/api/product.update
- Method: POST
- Content-Type: application/json
Input Parameters:
- authenticationToken (required)(string:50): Komet Sales security token.
- productId (required)(integer:20): Komet Sales internal ID of the product that you want to update. You can obtain this value from the product.list API method.
- category (required)(string:200): name of the product category.
- color (optional)(string:100): product color.
- variety (optional)(string:100): product variety.
- grade (optional)(string:100): product grade.
- code (optional)(string:20): product code.
- active (optional)(boolean:1): 1 if the product is active, 0 if the product is not active.
- regionsOfOrigin (optional)(array): list of regions where the product comes from.
- productRollUpCode (optional) (string:20): Code of the roll-up product. When this item is transferred to the unit's inventory it will be changed to the roll-up item specified here.
- defaultUnitType (optional(string:10): Default unit type of the product. Stem or Bunch.
- tags (optional)(string:200): Tags associated with the product separated by a comma.
Note: At least one of these fields is required: Variety, Color, Grade.
Code Block | theme | Confluence|||||||||
---|---|---|---|---|---|---|---|---|---|---|
Elite soft json viewer | ||||||||||
| ||||||||||
{
"authenticationToken": "token_info_goes_here",
"productId": 234234,
"category": "Rose",
"color": "Red",
"variety": "Freedom",
"grade": "50 cm",
"code": "RS50",
"tags": "standard,x-mas",
"regionsOfOrigin" : [ "Africa","Quito" ],
"active": 1
} |
Response
Output:
- status (integer:1): transaction status. 1 for success or 0 for failure.
- message (string:500): description of the status of the transaction.
- productId (integer:20): product internal ID that was just updated.
Code Block | theme | Confluence|||||||||
---|---|---|---|---|---|---|---|---|---|---|
Elite soft json viewer | ||||||||||
| ||||||||||
{ "status": "1", "message": "The product was successfully saved.", "productId": 234234 } |
Panel | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|