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

createSku

post

/ccadmin/v1/skus

Create Sku. Create a SKU for product based on the input request parameters. The request contains dynamic properties associated with product type. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types
  • application/json
Header Parameters
X-CCAsset-Language
Type: string
Required: true
The asset language of the request
Body Parameter
Root Schema : createSku_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 volumes.
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 : createSku_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":[
    ],
    "largeImage":null,
    "smallImage":null,
    "color":"Blue",
    "listVolumePrice":null,
    "nonreturnable":false,
    "displayName":"Sku One",
    "salePrices":{
        "defaultPriceGroup":null
    },
    "primaryFullImageURL":null,
    "listPrices":{
        "defaultPriceGroup":null
    },
    "productListingSku":null,
    "largeImageURLs":[
    ],
    "productLine":null,
    "listVolumePrices":{
        "defaultPriceGroup":null
    },
    "primaryLargeImageURL":null,
    "smallImageURLs":[
    ],
    "model":null,
    "thumbnailImage":null,
    "barcode":null,
    "saleVolumePrices":{
        "defaultPriceGroup":null
    },
    "salePriceEndDate":null,
    "saleVolumePrice":null,
    "salePriceStartDate":null,
    "images":[
    ],
    "quantity":null,
    "unitOfMeasure":null,
    "salePrice":null,
    "primaryMediumImageURL":null,
    "fullImageURLs":[
    ],
    "dynamicPropertyMapBigString":{
    },
    "active":true,
    "thumbImageURLs":[
    ],
    "mediumImageURLs":[
    ],
    "repositoryId":"sku1",
    "primarySourceImageURL":null,
    "primarySmallImageURL":null,
    "sourceImageURLs":[
    ],
    "listPrice":30,
    "configurable":false
}
Default Response
The error response
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,
  "salePriceStartDate": "2017-11-11T18:30:00.000Z",
  "quantity": 15,
  "productId": "xsku100234",
  "color": "Brown",
  "unitOfMeasure": null,
  "nonreturnable": false,
  "salePrice": "10",
  "displayName": "SKU One",
  "active": true,
  "listPrices": {"defaultPriceGroup": "20"},
  "salePrices": {"defaultPriceGroup": "10"},
  "productLine": null,
  "listVolumePrices": {"UsDollar": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }}},
  "size": "Small",
  "model": null,
  "id": "sku1",
  "barcode": null,
  "saleVolumePrices": {"UsDollar": {"bulkPrice": {
    "numLevels": 3,
    "levels": [
      {
        "price": 19,
        "levelMinimum": 1,
        "levelMaximum": 5
      },
      {
        "price": 12.35,
        "levelMinimum": 21,
        "levelMaximum": 30
      },
      {
        "price": 10.25,
        "levelMinimum": 31
      }
    ]
  }}},
  "configurable": "false",
  "listPrice": "20",
  "salePriceEndDate": "2018-03-11T18:30:00.000Z"
}

Sample Response Payload returned by endpoint:

{
  "productFamily": null,
  "dynamicPropertyMapLong": {"sku-MensApparel_color": 2},
  "primaryThumbImageURL": null,
  "bundleLinks": [],
  "largeImage": null,
  "smallImage": null,
  "color": "Blue",
  "listVolumePrice": null,
  "nonreturnable": false,
  "displayName": "Sku One",
  "salePrices": {"defaultPriceGroup": null},
  "primaryFullImageURL": null,
  "listPrices": {"defaultPriceGroup": null},
  "productListingSku": null,
  "largeImageURLs": [],
  "productLine": null,
  "listVolumePrices": {"defaultPriceGroup": null},
  "primaryLargeImageURL": null,
  "smallImageURLs": [],
  "model": null,
  "thumbnailImage": null,
  "barcode": null,
  "saleVolumePrices": {"defaultPriceGroup": null},
  "salePriceEndDate": null,
  "saleVolumePrice": null,
  "salePriceStartDate": null,
  "images": [],
  "quantity": null,
  "unitOfMeasure": null,
  "salePrice": null,
  "primaryMediumImageURL": null,
  "fullImageURLs": [],
  "dynamicPropertyMapBigString": {},
  "active": true,
  "thumbImageURLs": [],
  "mediumImageURLs": [],
  "repositoryId": "sku1",
  "primarySourceImageURL": null,
  "primarySmallImageURL": null,
  "sourceImageURLs": [],
  "listPrice": 30,
  "configurable": false
}