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

updateSku

put

/ccadmin/v1/skus/{id}

Update Sku. Updates a SKU based on the input request parameters. **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
SKU ID corresponding to the SKU to be updated.
Header Parameters
X-CCAsset-Language
Type: string
Required: true
The asset language of the request
Body Parameter
Root Schema : updateSku_request
Nested Schema : images
Type: array
Array of images to be associated to the SKU.
Nested Schema : listVolumePrices
Type: object
Object with price group IDs as keys and list prices as values
Nested Schema : saleVolumePrices
Type: object
Object with price group IDs as keys and sale prices as values
Nested Schema : items
Type: object
Nested Schema : metadata
Type: object
Seo meta info.
Nested Schema : PriceGroupID1
Type: object
List price of the product in price group 1
Nested Schema : PriceGroupID2
Type: object
List price of the product in price group 2
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : PriceGroupID1
Type: object
Sale price of the product in price group 1
Nested Schema : PriceGroupID2
Type: object
Sale price of the product in price group 2
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateSku_response
Nested Schema : fullImageURLs
Type: array
Full Image URLs of SKU.
Nested Schema : images
Type: array
Array of images for the SKU.
Nested Schema : largeImageURLs
Type: array
Large Image URLs of SKU.
Nested Schema : listVolumePrice
Type: object
List volume price of the SKU.
Nested Schema : listVolumePrices
Type: object
Object with price group IDs as keys and list prices as values.
Nested Schema : mediumImageURLs
Type: array
Medium Image URLs SKU.
Nested Schema : saleVolumePrice
Type: object
Sale volume price of the SKU.
Nested Schema : saleVolumePrices
Type: object
Object with price group IDs as keys and sale prices as values.
Nested Schema : smallImageURLs
Type: array
Small Image URLs of SKU.
Nested Schema : sourceImageURLs
Type: array
Source Image URLs of SKU.
Nested Schema : thumbImageURLs
Type: array
Thumb Image URLs of SKU.
Nested Schema : items
Type: object
Nested Schema : metadata
Type: object
Seo meta info.
Nested Schema : tags
Type: array
Tags for the image.
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : PriceGroupID1
Type: object
List price of the SKU in price group 1
Nested Schema : PriceGroupID2
Type: object
List price of the SKU in price group 2
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : PriceGroupID1
Type: object
Sale price of the Sku in price group 1
Nested Schema : PriceGroupID2
Type: object
Sale price of the SKU in price group 2
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : levels
Type: array
Price levels array for volume price
Nested Schema : items
Type: object
Example application/json

{
    "productFamily":null,
    "dynamicPropertyMapLong":{
        "sku-MensApparel_color":2
    },
    "primaryThumbImageURL":null,
    "bundleLinks":[
        {
            "item":{
                "displayName":"Blue T Shirt",
                "repositoryId":"sku30001"
            },
            "quantity":1,
            "repositoryId":"skul10001"
        },
        {
            "item":{
                "displayName":"Red T Shirt",
                "repositoryId":"sku30002"
            },
            "quantity":1,
            "repositoryId":"skul10002"
        }
    ],
    "largeImage":null,
    "smallImage":null,
    "color":"Blue",
    "listVolumePrice":{
        "bulkPrice":{
            "numLevels":3,
            "levels":[
                {
                    "price":19,
                    "levelMinimum":1,
                    "levelMaximum":5
                },
                {
                    "price":12.35,
                    "levelMinimum":21,
                    "levelMaximum":30
                },
                {
                    "price":10.25,
                    "levelMinimum":31
                }
            ]
        }
    },
    "nonreturnable":false,
    "displayName":"sku One",
    "salePrices":{
        "UsDollar":"300"
    },
    "primaryFullImageURL":null,
    "listPrices":{
        "UsDollar":"500"
    },
    "productListingSku":null,
    "largeImageURLs":[
    ],
    "productLine":null,
    "listVolumePrices":{
        "CaDollar":{
            "bulkPrice":{
                "numLevels":3,
                "levels":[
                    {
                        "price":19,
                        "levelMinimum":1,
                        "levelMaximum":5
                    },
                    {
                        "price":12.35,
                        "levelMinimum":21,
                        "levelMaximum":30
                    },
                    {
                        "price":10.25,
                        "levelMinimum":31
                    }
                ]
            }
        }
    },
    "primaryLargeImageURL":null,
    "smallImageURLs":[
    ],
    "model":null,
    "thumbnailImage":null,
    "barcode":null,
    "saleVolumePrices":{
        "CaDollar":{
            "bulkPrice":{
                "numLevels":3,
                "levels":[
                    {
                        "price":19,
                        "levelMinimum":1,
                        "levelMaximum":5
                    },
                    {
                        "price":12.35,
                        "levelMinimum":21,
                        "levelMaximum":30
                    },
                    {
                        "price":10.25,
                        "levelMinimum":31
                    }
                ]
            }
        }
    },
    "salePriceEndDate":null,
    "saleVolumePrice":{
        "bulkPrice":{
            "numLevels":3,
            "levels":[
                {
                    "price":19,
                    "levelMinimum":1,
                    "levelMaximum":5
                },
                {
                    "price":12.35,
                    "levelMinimum":21,
                    "levelMaximum":30
                },
                {
                    "price":10.25,
                    "levelMinimum":31
                }
            ]
        }
    },
    "salePriceStartDate":null,
    "images":[
    ],
    "quantity":null,
    "unitOfMeasure":null,
    "salePrice":"300",
    "primaryMediumImageURL":null,
    "fullImageURLs":[
    ],
    "dynamicPropertyMapBigString":{
    },
    "active":false,
    "thumbImageURLs":[
    ],
    "mediumImageURLs":[
    ],
    "repositoryId":"sku1",
    "primarySourceImageURL":null,
    "primarySmallImageURL":null,
    "sourceImageURLs":[
    ],
    "listPrice":"500",
    "configurable":"false"
}
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| |------------------|------------------| |26041|attempt to set or query property {0} with invalid enumeration value {1}.| |26051|Active property value can only be a Boolean.| |26300|The SKU {0} is already part of a SKU bundle| |26048|Missing variant property for item: {0}, {1}| |26301|Item is required for BundleLinks.| |26304|The SKU {0} is already a SKU bundle.| |26303|{0} is an invalid SKU ID.| |26306|Internal Error| |26305|The ID for the SKU bundle cannot be the same as the ID for one of its bundle links.| |26307|Invalid Quantity Value.|
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:

{
  "productFamily": null,
  "bundleLinks": [
    {
      "item": {"repositoryId": "sku30001"},
      "quantity": 1
    },
    {
      "item": {"repositoryId": "sku30002"},
      "quantity": 2
    }
  ],
  "salePrice": "300",
  "nonreturnable": false,
  "displayName": "SKU One",
  "active": false,
  "listPrices": {"UsDollar": "500"},
  "salePrices": {"UsDollar": "300"},
  "productLine": null,
  "listVolumePrices": {"CaDollar": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }}},
  "model": null,
  "saleVolumePrices": {"CaDollar": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }}},
  "barcode": null,
  "listPrice": "500",
  "configurable": "false"
}

Sample Response Payload returned by endpoint:

{
  "productFamily": null,
  "dynamicPropertyMapLong": {"sku-MensApparel_color": 2},
  "primaryThumbImageURL": null,
  "bundleLinks": [
    {
      "item": {
        "displayName": "Blue T Shirt",
        "repositoryId": "sku30001"
      },
      "quantity": 1,
      "repositoryId": "skul10001"
    },
    {
      "item": {
        "displayName": "Red T Shirt",
        "repositoryId": "sku30002"
      },
      "quantity": 1,
      "repositoryId": "skul10002"
    }
  ],
  "largeImage": null,
  "smallImage": null,
  "color": "Blue",
  "listVolumePrice": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }},
  "nonreturnable": false,
  "displayName": "sku One",
  "salePrices": {"UsDollar": "300"},
  "primaryFullImageURL": null,
  "listPrices": {"UsDollar": "500"},
  "productListingSku": null,
  "largeImageURLs": [],
  "productLine": null,
  "listVolumePrices": {"CaDollar": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }}},
  "primaryLargeImageURL": null,
  "smallImageURLs": [],
  "model": null,
  "thumbnailImage": null,
  "barcode": null,
  "saleVolumePrices": {"CaDollar": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }}},
  "salePriceEndDate": null,
  "saleVolumePrice": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }},
  "salePriceStartDate": null,
  "images": [],
  "quantity": null,
  "unitOfMeasure": null,
  "salePrice": "300",
  "primaryMediumImageURL": null,
  "fullImageURLs": [],
  "dynamicPropertyMapBigString": {},
  "active": false,
  "thumbImageURLs": [],
  "mediumImageURLs": [],
  "repositoryId": "sku1",
  "primarySourceImageURL": null,
  "primarySmallImageURL": null,
  "sourceImageURLs": [],
  "listPrice": "500",
  "configurable": "false"
}