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

createSkus

put

/ccadmin/v1/skus

Create Skus. Create skus for product 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
Header Parameters
X-CCAsset-Language
Type: string
Required: true
The asset language of the request
Body Parameter
Root Schema : createSkus_request
Nested Schema : variants
Type: array
Array of objects with dynamic properties. The properties change from one product type to another.
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : createSkus_response
Nested Schema : items
Type: array
the list of created skus
Nested Schema : items
Type: object
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,
        "largeImage":null,
        "smallImage":null,
        "color":"red",
        "nonreturnable":false,
        "listPrices":{
            "UsDollar":"200"
        },
        "salePrices":null,
        "primaryFullImageURL":null,
        "productListingSku":null,
        "largeImageURLs":[
        ],
        "productLine":null,
        "primaryLargeImageURL":null,
        "smallImageURLs":[
        ],
        "model":null,
        "thumbnailImage":null,
        "barcode":null,
        "salePriceEndDate":null,
        "salePriceStartDate":null,
        "images":[
        ],
        "quantity":null,
        "salePrice":null,
        "primaryMediumImageURL":null,
        "fullImageURLs":[
        ],
        "active":true,
        "thumbImageURLs":[
        ],
        "mediumImageURLs":[
        ],
        "repositoryId":"sku1",
        "primarySourceImageURL":null,
        "primarySmallImageURL":null,
        "sourceImageURLs":[
        ],
        "listPrice":"200",
        "configurable":"false"
    },
    {
        "productFamily":null,
        "dynamicPropertyMapLong":{
            "sku-MensApparel_color":3
        },
        "primaryThumbImageURL":null,
        "largeImage":null,
        "smallImage":null,
        "listVolumePrice":null,
        "color":"Blue",
        "nonreturnable":false,
        "listPrices":null,
        "salePrices":null,
        "primaryFullImageURL":null,
        "productListingSku":null,
        "largeImageURLs":[
        ],
        "productLine":null,
        "listVolumePrices":null,
        "primaryLargeImageURL":null,
        "smallImageURLs":[
        ],
        "model":null,
        "thumbnailImage":null,
        "saleVolumePrices":null,
        "barcode":null,
        "salePriceEndDate":null,
        "saleVolumePrice":null,
        "salePriceStartDate":null,
        "images":[
        ],
        "quantity":null,
        "salePrice":null,
        "primaryMediumImageURL":null,
        "fullImageURLs":[
        ],
        "active":true,
        "thumbImageURLs":[
        ],
        "mediumImageURLs":[
        ],
        "repositoryId":"sku2",
        "primarySourceImageURL":null,
        "primarySmallImageURL":null,
        "sourceImageURLs":[
        ],
        "listPrice":null,
        "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:

{
  "productId": "xprod12345",
  "variants": [
    {
      "color": "red",
      "id": "sku1",
      "listPrice": "200"
    },
    {
      "color": "blue",
      "id": "sku2"
    }
  ]
}

Sample Response Payload returned by endpoint:

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