Updates a product entity using JSON merge patch (). This means that only included fields will be changed: null values removes the field on the target entity, and other values updates the field. Conditional updates are supported through the HttpHeaders.IF_MATCH header. If the conditional prerequisite is fullfilled, the product is updated: otherwise a 412 (precondition failed) will be returned with an empty body.
643 matches
29 actions
Product Library
29 actions
- Create a discountPOSTv1.0.0
- Create a new categoryPOSTv1.0.0
- Create a new productPOSTv1.0.0
- Create a product identifierPOSTv1.0.0
- Create new tax ratesPOSTv1.0.0
- Delete a categoryDELETEv1.0.0
- Delete a list of productsDELETEv1.0.0
- Delete a single discount DELETEv1.0.0
- Delete a single productDELETEv1.0.0
- Delete a single tax rateDELETEv1.0.0
- Get a single tax rateGETv1.0.0
- Get all available tax ratesGETv1.0.0
- Get all tax rates and a count of products associated with eachGETv1.0.0
- Get the organization tax settings GETv1.0.0
- Rename a categoryPATCHv1.0.0
- Retrieve a single discountGETv1.0.0
- Retrieve a single productGETv1.0.0
- Retrieve all categoriesGETv1.0.0
- Retrieve all discountsGETv1.0.0
- Retrieve all library item imagesGETv1.0.0
- Retrieve all products visible in POSGETv1.0.0
- Retrieve all products visible in POS – v2GETv1.0.0
- Retrieve an aggregate of active Options in the libraryGETv1.0.0
- Retrieve the count of existing productsGETv1.0.0
- Retrieve the entire libraryGETv1.0.0
- Update a single discountPUTv1.0.0
- Update a single productPUTv1.0.0
- Update a single tax ratePUTv1.0.0
- Update the organization tax settingsPUTv1.0.0
E-commerce/Product Library
Update a single product
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
- 463
- 464
- 465
- 466
- 467
- 468
- 469
- 470
- 471
- 472
- 473
- 474
- 475
- 476
- 477
- 478
- 479
- 480
- 481
- 482
- 483
- 484
- 485
- 486
- 487
- 488
- 489
- 490
- 491
- 492
- 493
- 494
- 495
- 496
- 497
- 498
- 499
- 500
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
- 512
- 513
- 514
- 515
- 516
- 517
- 518
- 519
- 520
- 521
- 522
- 523
- 524
- 525
- 526
- 527
- 528
- 529
- 530
- 531
- 532
- 533
- 534
- 535
- 536
- 537
- 538
- 539
- 540
- 541
- 542
- 543
- 544
- 545
- 546
- 547
- 548
- 549
- 550
- 551
- 552
- 553
- 554
- 555
- 556
- 557
- 558
- 559
- 560
- 561
- 562
- 563
- 564
- 565
- 566
- 567
- 568
- 569
- 570
- 571
- 572
- 573
- 574
- 575
- 576
- 577
- 578
- 579
- 580
- 581
- 582
- 583
- 584
- 585
- 586
- 587
- 588
- 589
- 590
- 591
- 592
- 593
- 594
- 595
- 596
- 597
- 598
- 599
- 600
- 601
- 602
- 603
- 604
- 605
- 606
- 607
- 608
- 609
- 610
- 611
- 612
- 613
- 614
- 615
- 616
- 617
- 618
- 619
- 620
- 621
- 622
- 623
- 624
- 625
- 626
- 627
- 628
- 629
- 630
- 631
- 632
- 633
- 634
- 635
- 636
- 637
- 638
- 639
- 640
- 641
- 642
- 643
- 644
- 645
- 646
- 647
- 648
- 649
- 650
- 651
- 652
- 653
- 654
- 655
- 656
- 657
- 658
- 659
- 660
- 661
- 662
- 663
- 664
- 665
- 666
- 667
- 668
- 669
- 670
- 671
- 672
- 673
- 674
- 675
- 676
- 677
- 678
- 679
- 680
- 681
- 682
- 683
- 684
- 685
- 686
- 687
- 688
- 689
- 690
- 691
- 692
- 693
- 694
- 695
- 696
- 697
- 698
- 699
- 700
- 701
- 702
- 703
- 704
- 705
- 706
- 707
- 708
- 709
- 710
- 711
- 712
- 713
- 714
- 715
- 716
- 717
- 718
- 719
- 720
- 721
- 722
{
"type": "object",
"properties": {
"If-Match": {
"type": "string"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"type": "object",
"required": [
"name",
"uuid"
],
"properties": {
"name": {
"type": "string"
},
"uuid": {
"type": "string",
"format": "uuid"
}
}
},
"description": {
"type": "string"
},
"externalReference": {
"type": "string"
},
"imageLookupKeys": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object",
"required": [
"inPos"
],
"properties": {
"inPos": {
"type": "boolean"
},
"source": {
"type": "object",
"properties": {
"external": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
}
}
},
"name": {
"type": "string"
},
"online": {
"type": "object",
"required": [
"status"
],
"properties": {
"description": {
"type": "string"
},
"presentation": {
"type": "object",
"properties": {
"additionalImageUrls": {
"type": "array",
"items": {
"type": "string",
"format": "url"
}
},
"displayImageUrl": {
"type": "string",
"format": "url"
},
"mediaUrls": {
"type": "array",
"items": {
"type": "string",
"format": "url"
}
}
}
},
"seo": {
"type": "object",
"properties": {
"metaDescription": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
}
}
},
"shipping": {
"type": "object",
"properties": {
"shippingPricingModel": {
"type": "string",
"enum": [
"FREE",
"STANDARD"
]
},
"weight": {
"type": "object",
"required": [
"unit",
"weight"
],
"properties": {
"unit": {
"type": "string",
"enum": [
"kg",
"g",
"oz",
"lb"
]
},
"weight": {
"type": "number"
}
}
},
"weightInGrams": {
"type": "integer",
"format": "int64"
}
}
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"HIDDEN"
]
},
"title": {
"type": "string"
}
}
},
"organizationUuid": {
"type": "string",
"format": "uuid"
},
"presentation": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"textColor": {
"type": "string"
}
}
},
"productUuid": {
"type": "string",
"format": "uuid"
},
"taxCode": {
"type": "string"
},
"taxExempt": {
"type": "boolean"
},
"taxRates": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"unitName": {
"type": "string"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"variantOptionDefinitions": {
"type": "object",
"required": [
"definitions"
],
"properties": {
"definitions": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"properties"
],
"properties": {
"name": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"imageUrl": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
}
}
},
"variants": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid"
],
"properties": {
"barcode": {
"type": "string"
},
"costPrice": {
"type": "object",
"required": [
"amount",
"currencyId"
],
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"currencyId": {
"type": "string",
"enum": [
"AED",
"AFA",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZM",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CSD",
"CUC",
"CUP",
"CVE",
"CYP",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHC",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MTL",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZM",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDD",
"SDG",
"SEK",
"SGD",
"SHP",
"SIT",
"SKK",
"SLL",
"SOS",
"SPL",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMM",
"TMT",
"TND",
"TOP",
"TRL",
"TRY",
"TTD",
"TVD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEB",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWD",
"ZWL"
]
}
}
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"presentation": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"textColor": {
"type": "string"
}
}
},
"price": {
"type": "object",
"required": [
"amount",
"currencyId"
],
"properties": {
"amount": {
"type": "integer",
"format": "int64"
},
"currencyId": {
"type": "string",
"enum": [
"AED",
"AFA",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZM",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CSD",
"CUC",
"CUP",
"CVE",
"CYP",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHC",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MTL",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZM",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDD",
"SDG",
"SEK",
"SGD",
"SHP",
"SIT",
"SKK",
"SLL",
"SOS",
"SPL",
"SRD",
"SSP",
"STD",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMM",
"TMT",
"TND",
"TOP",
"TRL",
"TRY",
"TTD",
"TVD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEB",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"YER",
"ZAR",
"ZMK",
"ZMW",
"ZWD",
"ZWL"
]
}
}
},
"sku": {
"type": "string"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"vatPercentage": {
"type": "number"
}
}
}
},
"vatPercentage": {
"type": "number"
}
},
"required": [
"name",
"organizationUuid",
"productUuid",
"uuid"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}