1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Variants

updateProductTypeVariant

put

/ccadmin/v1/productVariants/{id}

Update Product Type Variant. Update a variant. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the product type variant.
Header Parameters
X-CCAsset-Language
Type: string
Required: true
The asset language of the request
Body Parameter
Root Schema : updateProductTypeVariant_request
Nested Schema : values
Type: array
The enumerated variant options. Can also be a map with key being the original value, and value being the localized value for the given asset locale of the request.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateProductTypeVariant_response
Nested Schema : variants
Type: array
List of variants for user-defined product type.
Nested Schema : items
Type: object
Nested Schema : editableAttributes
Type: array
List of editable attributes
Nested Schema : values
Type: array
Values for variant.
Nested Schema : items
Type: object
Example application/json

{
    "count":4,
    "id":"MensApparel",
    "variants":[
        {
            "itemType":"sku-MensApparel",
            "localizedValues":{
                "Red":"Rojo",
                "Brown":"Marr??n",
                "Blue":"Azul",
                "Green":"Verde"
            },
            "hidden":false,
            "values":[
                "Blue",
                "Brown",
                "Green",
                "Red"
            ],
            "length":19,
            "variantBasedDisplay":"true",
            "wildcardSearchable":null,
            "label":"Color",
            "type":"enumerated",
            "required":false,
            "searchable":null,
            "writable":"true",
            "uiEditorType":null,
            "internalOnly":"false",
            "default":null,
            "listingVariant":"true",
            "textSearchable":null,
            "id":"color",
            "dimension":null,
            "editableAttributes":[
                "dimension",
                "multiSelect",
                "textSearchable",
                "default",
                "internalOnly",
                "order",
                "listingVariant",
                "hidden",
                "label",
                "required",
                "variantBasedDisplay",
                "wildcardSearchable",
                "searchable"
            ],
            "multiSelect":null,
            "order":null
        }
    ],
    "productTypeId":"MensApparel"
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |20112|Attempted to update property data without providing new property data| |20023|invalid listing and display variant combination| |20111|Attempt to update type of existing property| |20022|Product Type cannot have multiple display variants| |20021|Error while updating the listing variant| |20020|Error while updating the display variant| |20581|Could not find product type| |20019|Product Type cannot have multiple listing variants| |20017|Product Type Internal Error| |26041|Cannot set enumerated values to a non-array value| |26046|Could not determine asset locale while setting localized enumerated values| |20580|Get Product Type Internal Error| |20170|Create Product Type Internal Error| |20191|No product type id provided| |26070|Error while updating SKU with listing configurations| |26071|Error while creating the listing configurations|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{
  "listingVariant": true,
  "values": [
    "Blue",
    "Brown",
    "Green",
    "Red"
  ],
  "variantBasedDisplay": true,
  "id": "color",
  "label": "Color",
  "productTypeId": "MensApparel"
}

Sample Response Payload returned by endpoint:

{
  "count": 4,
  "id": "MensApparel",
  "variants": [{
    "itemType": "sku-MensApparel",
    "localizedValues": {
      "Red": "Rojo",
      "Brown": "Marr??n",
      "Blue": "Azul",
      "Green": "Verde"
    },
    "hidden": false,
    "values": [
      "Blue",
      "Brown",
      "Green",
      "Red"
    ],
    "length": 19,
    "variantBasedDisplay": "true",
    "wildcardSearchable": null,
    "label": "Color",
    "type": "enumerated",
    "required": false,
    "searchable": null,
    "writable": "true",
    "uiEditorType": null,
    "internalOnly": "false",
    "default": null,
    "listingVariant": "true",
    "textSearchable": null,
    "id": "color",
    "dimension": null,
    "editableAttributes": [
      "dimension",
      "multiSelect",
      "textSearchable",
      "default",
      "internalOnly",
      "order",
      "listingVariant",
      "hidden",
      "label",
      "required",
      "variantBasedDisplay",
      "wildcardSearchable",
      "searchable"
    ],
    "multiSelect": null,
    "order": null
  }],
  "productTypeId": "MensApparel"
}