createProduct
post
                    /ccadmin/v1/products
Create Product. Creates a new product. **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: string
                        
                        The asset language of the request
Root Schema : createProduct_request
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            catalogId(optional): 
            string
            Catalog ID of the product to be created. If this field is not provided then the request will default to using the product catalog.
- 
            categoryId(optional): 
            string
            Category ID of the selected product. If this field is not provided or if it references a catalog root category then the request will instead place the product under the given catalog's default category for products, or create the product unassigned if the default category for products is not set for the catalog.
- 
            discountable(optional): 
            boolean
            Indicates whether the promotions should be applied to this SKU or not. If the value is true then promotion discounts can be applied to this SKU; else no promotions can be applied to this SKU. Default value is true
- 
            includePrices(optional): 
            boolean
            Boolean flag to determine whether to include price maps for the products in the response.
- 
            orphaned(optional): 
            boolean
            Set to true to ensure the product is created unassigned with no parents. This field is only valid if both catalogId and categoryId are not provided in the request.
- 
            priceListGroupId(optional): 
            string
            Price list group id for adding the prices to the product in the response.
- 
            productType(optional): 
            string
            Product type of the selected product. If product type is omitted, then base product type is used.
- 
            properties: 
            object  properties
            
            Properties of the product to be created.
Example:
    
    
{
    "catalogId":"cloudCatalog",
    "categoryId":"menswear",
    "productType":"MensApparel",
    "properties":{
        "longDescription":"This is a sample description.",
        "directCatalogs":[
            "cloudCatalog"
        ],
        "nonreturnable":false,
        "displayName":"Sample",
        "orderLimit":"100",
        "description":"A Cloud Lake Product.",
        "listPrices":{
            "CaDollar":120
        },
        "salePrices":{
            "CaDollar":100
        },
        "listVolumePrices":{
            "UsDollar":{
                "bulkPrice":{
                    "numLevels":3,
                    "levels":[
                        {
                            "price":19,
                            "levelMinimum":1,
                            "levelMaximum":5
                        },
                        {
                            "price":12.35,
                            "levelMinimum":21,
                            "levelMaximum":30
                        },
                        {
                            "price":10.25,
                            "levelMinimum":31
                        }
                    ]
                }
            }
        },
        "shippable":true,
        "addOnProducts":[
            {
                "addOnOptions":[
                    {
                        "product":"prod10005",
                        "sku":"sku30051"
                    },
                    {
                        "product":"prod10005",
                        "sku":"sku30053"
                    }
                ]
            }
        ],
        "shippingSurcharges":{
            "UsDollar":100,
            "CaDollar":12
        },
        "id":"xProd10213",
        "discountable":true,
        "brand":"SampleBrand",
        "notForIndividyalSale:":true,
        "saleVolumePrices":{
            "UsDollar":{
                "bulkPrice":{
                    "numLevels":3,
                    "levels":[
                        {
                            "price":19,
                            "levelMinimum":1,
                            "levelMaximum":5
                        },
                        {
                            "price":12.35,
                            "levelMinimum":21,
                            "levelMaximum":30
                        },
                        {
                            "price":10.25,
                            "levelMinimum":31
                        }
                    ]
                }
            }
        },
        "height":"20",
        "salePrice":80,
        "length":"20",
        "active":true,
        "weight":"20",
        "productNumber":"p1815",
        "taxCode":null,
        "arrivalDate":"2014-03-16T18:30:00.000Z",
        "width":"20",
        "shippingSurcharge":null,
        "listPrice":100
    }
}Nested Schema : properties
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectProperties of the product to be created.
    
    
    
    
        Show Source
        - 
            active(optional): 
            boolean
            Tells whether product is active.
- 
            addOnProducts(optional): 
            array  addOnProducts
            
            The array of add-on product groups
- 
            arrivalDate(optional): 
            string
            Arrival date of the product.
- 
            brand(optional): 
            string
            Brand of the product.
- 
            coreProduct(optional): 
            boolean
            Flag specifying if this is a core product that should automatically be a member of filtered view catalogs (unless specifically excluded)
- 
            CountryOfOrigin(optional): 
            string
            Country of origin of the product
- 
            description(optional): 
            string
            Description of the product.
- 
            directCatalogs(optional): 
            array  directCatalogs
            
            List of catalog IDs that this product is associated with through direct catalog linking.
- 
            displayName: 
            string
            Display name of the product.
- 
            filteredCatalogs(optional): 
            array  filteredCatalogs
            
            List of filtered view catalog Ids products will be included (if their core product is false) or excluded from (if their core product is true).
- 
            height(optional): 
            string
            Height of the product.
- 
            id: 
            string
            The id of the product to create.
- 
            length(optional): 
            string
            Length of the product.
- 
            listPrice(optional): 
            number
            List price of the product in the default price group. Required if listPrices does not set the price for the default price group.
- 
            listVolumePrices(optional): 
            object  listVolumePrices
            
            Object with price group IDs as keys and list prices as values
- 
            longDescription(optional): 
            string
            Long description of the product.
- 
            nonreturnable(optional): 
            boolean
            Indicates whether the product is returnable or not.
- 
            notForIndividualSale(optional): 
            boolean
            States whether not a product may be sold individually rather than, for example, as part of a configured product
- 
            orderLimit(optional): 
            string
            Order limit of the product.
- 
            parentCategory(optional): 
            string
            Repository id of the default parent category
- 
            parentCategoryScope(optional): 
            string
            Scope of update for parent category, one of: base, catalogSpecific, global or revertToBase. If this field is not provided then existing scope is used, i.e. if a catalog specific parent category is already set then it will be updated otherwise the base will be updated.
- 
            productNumber: 
            string
            Product number of the product.
- 
            salePrice(optional): 
            number
            Sale price of the product in the default price group.
- 
            saleVolumePrices(optional): 
            object  saleVolumePrices
            
            Object with price group IDs as keys and sale prices as values
- 
            shippable(optional): 
            boolean
            Indicates whether the product is goods(shippable=true) or services(shippable=false).
- 
            shippingSurcharge(optional): 
            number
            Extra handling costs while shipping the product, in the default price group.
- 
            taxCode: 
            string
            Tax code of the product.
- 
            weight(optional): 
            string
            Weight of the product.
- 
            width(optional): 
            string
            Width of the product.
Nested Schema : directCatalogs
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayList of catalog IDs that this product is associated with through direct catalog linking.
    
    
    
    
    
        Show Source
        - 
            Array of: 
                string
            
            ID of the catalog to which product will have direct linkage.
Nested Schema : filteredCatalogs
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayList of filtered view catalog Ids products will be included (if their core product is false) or excluded from (if their core product is true).
    
    
    
    
    
        Show Source
        - 
            Array of: 
                string
            
            List of filtered view catalog ids
Nested Schema : listVolumePrices
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectObject with price group IDs as keys and list prices as values
    
    
    
    
        Show Source
        - 
            priceGroupId1(optional): 
            object  priceGroupId1
            
            List price of the product in price group 1
- 
            priceGroupId2(optional): 
            object  priceGroupId2
            
            List price of the product in price group 1
Nested Schema : saleVolumePrices
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectObject with price group IDs as keys and sale prices as values
    
    
    
    
        Show Source
        - 
            priceGroupId1(optional): 
            object  priceGroupId1
            
            Sale price of the product in price group 1
- 
            priceGroupId2(optional): 
            object  priceGroupId2
            
            Sale price of the product in price group 1
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            product(optional): 
            string
            ID of the add-on product
- 
            sku(optional): 
            string
            Sku ID of the add-on product
Nested Schema : priceGroupId1
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectList price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectList price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : priceGroupId1
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSale price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSale price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Response
Supported Media Types
                - application/json
200 Response
Following model is returned when operation succeeds.
                
                
                    Root Schema : createProduct_response
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            addOnProducts(optional): 
            array  addOnProducts
            
            The array of add-on product groups.
- 
            avgCustRating(optional): 
            string
            Average customer rating of the product.
- 
            childSKUs(optional): 
            array  childSKUs
            
            Array having the properties of child SKU of the product.
- 
            coreProduct(optional): 
            boolean
            Flag specifying if this is a core product that should automatically be a member of filtered view catalogs (unless specifically excluded)
- 
            derivedListPriceFrom(optional): 
            string
            Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
- 
            derivedSalePriceFrom(optional): 
            string
            Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
- 
            derivedShippingSurchargeFrom(optional): 
            string
            Determines from which price list group, shipping surcharge is derived. It can be either current price list group or one of it's ancestors
- 
            description(optional): 
            string
            Description of the product.
- 
            discountable(optional): 
            boolean
            Indicates whether the promotions should be applied to this SKU or not. If the value is true then promotion discounts can be applied to this SKU; else no promotions can be applied to this SKU. Default value is true
- 
            displayName(optional): 
            string
            Display Name of the product.
- 
            fullImageURLs(optional): 
            array  fullImageURLs
            
            Full Image URLs.
- 
            id(optional): 
            string
            Product ID.
- 
            largeImage(optional): 
            object  largeImage
            
            Has repository Id and URL of the product.
- 
            largeImageURLs(optional): 
            array  largeImageURLs
            
            Large Image URLs of SKU.
- 
            listPrice(optional): 
            number
            List Price of the product in the default price group.
- 
            listVolumePrice(optional): 
            object  listVolumePrice
            
            list volume price of the product
- 
            listVolumePrices(optional): 
            object  listVolumePrices
            
            Object with price group IDs as keys and list prices as values
- 
            longDescription(optional): 
            string
            Long description of the product.
- 
            mediumImageURLs(optional): 
            array  mediumImageURLs
            
            Medium Image URLs.
- 
            notForIndividualSale(optional): 
            boolean
            States whether not a product may sold be individually rather than, for example, as part of a configured product
- 
            orderLimit(optional): 
            string
            Order limit of the product.
- 
            primaryFullImageURL(optional): 
            string
            Primary full image URL of the product.
- 
            primaryLargeImageURL(optional): 
            string
            Primary large image URL of the product.
- 
            primaryMediumImageURL(optional): 
            string
            Primary Medium Image URL.
- 
            primarySmallImageURL(optional): 
            string
            Primary Small Image URL of the product.
- 
            primarySourceImageURL(optional): 
            string
            Primary Source Image URL of the product.
- 
            primaryThumbImageURL(optional): 
            string
            Primary Thumb Image URL of the product.
- 
            productImages(optional): 
            array  productImages
            
            Array of product images.
- 
            repositoryId(optional): 
            string
            Repository Id of the product.
- 
            route(optional): 
            string
            Route of the product.
- 
            salePrice(optional): 
            number
            Sale Price of the product in the default price group.
- 
            saleVolumePrice(optional): 
            object  saleVolumePrice
            
            Sale volume price of the product
- 
            saleVolumePrices(optional): 
            object  saleVolumePrices
            
            Object with price group IDs as keys and sale prices as values
- 
            shippingSurcharge(optional): 
            number
            Extra handling costs while shipping the product, in the default price group.
- 
            smallImage(optional): 
            string
            Small image of product.
- 
            smallImageURLs(optional): 
            array  smallImageURLs
            
            Small image URLs of the product.
- 
            sourceImageURLs(optional): 
            array  sourceImageURLs
            
            Source Image URLs.
- 
            thumbImageURLs(optional): 
            array  thumbImageURLs
            
            Thumb Image URLs.
Nested Schema : childSKUs
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayArray having the properties of child SKU of the product.
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : largeImage
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectHas repository Id and URL of the product.
    
    
    
    
        Show Source
        - 
            id(optional): 
            string
            Repository ID
- 
            url(optional): 
            string
            Repository URL
Nested Schema : listVolumePrice
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectlist volume price of the product
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : listVolumePrices
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectObject with price group IDs as keys and list prices as values
    
    
    
    
        Show Source
        - 
            priceGroupId1(optional): 
            object  priceGroupId1
            
            List price of the product in price group 1
- 
            priceGroupId2(optional): 
            object  priceGroupId2
            
            List price of the product in price group 1
Nested Schema : saleVolumePrice
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSale volume price of the product
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrices
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectObject with price group IDs as keys and sale prices as values
    
    
    
    
        Show Source
        - 
            priceGroupId1(optional): 
            object  priceGroupId1
            
            Sale price of the product in price group 1
- 
            priceGroupId2(optional): 
            object  priceGroupId2
            
            Sale price of the product in price group 1
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            product(optional): 
            object  product
            
            The add-on product
- 
            repositoryId(optional): 
            string
            
- 
            sku(optional): 
            object  sku
            
            The add-on sku
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            active(optional): 
            boolean
            Indicates whether sku is active or inactive. Inactive SKUs will not appear on the storefront. This property value defaults to true.
- 
            derivedListPriceFrom(optional): 
            string
            Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
- 
            derivedSalePriceFrom(optional): 
            string
            Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
- 
            dynamicPropertyMapLong(optional): 
            string
            Dynamic Property MapLong of SKU.
- 
            fullImageURLs(optional): 
            array  fullImageURLs
            
            Full Image URLs of SKU.
- 
            largeImage(optional): 
            string
            Large Image of the SKU.
- 
            largeImageURLs(optional): 
            array  largeImageURLs
            
            Large Image URLs of SKU.
- 
            listPrice(optional): 
            number
            List Price of the product SKU.
- 
            listVolumePrice(optional): 
            object  listVolumePrice
            
            list volume price of the product
- 
            mediumImageURLs(optional): 
            array  mediumImageURLs
            
            Medium Image URLs SKU.
- 
            nonreturnable(optional): 
            boolean
            Indicates whether the SKU is returnable or not.
- 
            primaryLargeImageURL(optional): 
            string
            Primary Large Image URL of SKU.
- 
            primaryMediumImageURL(optional): 
            string
            Primary Medium Image URL ID of SKU.
- 
            primarySmallImageURL(optional): 
            string
            Primary Small Image URL of SKU.
- 
            primarySourceImageURL(optional): 
            string
            Primary Source Image URL of SKU.
- 
            primaryThumbImageURL(optional): 
            string
            Primary Source Image URL of SKU.
- 
            quantity(optional): 
            integer
            Quantity available of SKU.
- 
            repositoryId(optional): 
            string
            Repository Id of SKU.
- 
            salePrice(optional): 
            string
            Sale Price of SKU.
- 
            salePriceEndDate(optional): 
            string
            Sale Price End Date of the SKU.
- 
            salePriceStartDate(optional): 
            string
            Sale Price Start Date of SKU.
- 
            saleVolumePrice(optional): 
            object  saleVolumePrice
            
            Sale volume price of the product
- 
            shippingSurcharge(optional): 
            number
            Extra handling costs while shipping the product.
- 
            smallImage(optional): 
            string
            Small Image URL of SKU.
- 
            smallImageURLs(optional): 
            array  smallImageURLs
            
            Small Image URLs of SKU.
- 
            soldAsPackage(optional): 
            boolean
            Indicates whether the SKU as a single package otherwise consider the SKU where sub-items can be shipped/fulfilled separately.
- 
            sourceImageURLs(optional): 
            array  sourceImageURLs
            
            Source Image URLs of SKU.
- 
            thumbImageURLs(optional): 
            array  thumbImageURLs
            
            Thumb Image URLs of SKU.
- 
            thumbnailImage(optional): 
            string
            Thumbnail Image of SKU.
Nested Schema : listVolumePrice
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectlist volume price of the product
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrice
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSale volume price of the product
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : priceGroupId1
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectList price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectList price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : priceGroupId1
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSale price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : priceGroupId2
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectSale price of the product in price group 1
    
    
    
    
        Show Source
        - 
            pricingScheme(optional): 
            object  pricingScheme
            
            Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Nested Schema : pricingScheme
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectPricing scheme can be either tieredPrice or bulkPrice
    
    
    
    
        Show Source
        - 
            levels(optional): 
            array  levels
            
            Price levels array for volume price
- 
            numLevels(optional): 
            number
            Number of levels in the volume price
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            levelMaximum(optional): 
            number
            minimum quantity for price level
- 
            levelMinimum(optional): 
            number
            minimum quantity for price level
- 
            price(optional): 
            number
            price value for price level
Example Response (application/json)
                    {
    "longDescription":"This is a sample description.",
    "primaryThumbImageURL":null,
    "largeImage":null,
    "smallImage":null,
    "listVolumePrice":null,
    "displayName":"Sample",
    "orderLimit":100,
    "description":"A Cloud Lake Product.",
    "listPrices":{
        "UsDollar":100,
        "CaDollar":120
    },
    "primaryFullImageURL":null,
    "salePrices":{
        "UsDollar":80,
        "CaDollar":100
    },
    "largeImageURLs":[
    ],
    "coreProduct":false,
    "listVolumePrices":{
    },
    "primaryLargeImageURL":null,
    "addOnProducts":[
        {
            "repositoryId":"cp10001",
            "addOnOptions":[
                {
                    "product":{
                        "displayName":"Short Sleeve Plaid Button Down",
                        "repositoryId":"prod10005",
                        "active":true
                    },
                    "repositoryId":"co10001",
                    "sku":{
                        "displayName":"Short Sleeve Plaid Button Down",
                        "repositoryId":"sku30051",
                        "active":true
                    }
                },
                {
                    "product":{
                        "displayName":"Short Sleeve Plaid Button Down",
                        "repositoryId":"prod10005",
                        "active":true
                    },
                    "repositoryId":"co10002",
                    "sku":{
                        "displayName":"Short Sleeve Plaid Button Down",
                        "repositoryId":"sku30053",
                        "active":true
                    }
                }
            ]
        }
    ],
    "smallImageURLs":[
    ],
    "derivedShippingSurchargeFrom":"UsDollar",
    "derivedSalePriceFrom":"UsDollar",
    "shippingSurcharges":{
        "UsDollar":100,
        "CaDollar":12
    },
    "id":"xProd10213",
    "discountable":true,
    "saleVolumePrices":{
    },
    "childSKUs":[
        {
            "dynamicPropertyMapLong":{
            },
            "primaryThumbImageURL":null,
            "largeImage":null,
            "smallImage":null,
            "nonreturnable":false,
            "primaryFullImageURL":null,
            "productListingSku":null,
            "largeImageURLs":[
            ],
            "primaryLargeImageURL":null,
            "smallImageURLs":[
            ],
            "thumbnailImage":null,
            "salePriceEndDate":null,
            "salePriceStartDate":null,
            "images":[
            ],
            "quantity":null,
            "salePrice":null,
            "primaryMediumImageURL":null,
            "fullImageURLs":[
            ],
            "active":true,
            "thumbImageURLs":[
            ],
            "soldAsPackage":false,
            "mediumImageURLs":[
            ],
            "repositoryId":"sku60303",
            "shippingSurcharge":null,
            "primarySourceImageURL":null,
            "primarySmallImageURL":null,
            "sourceImageURLs":[
            ],
            "listPrice":null
        }
    ],
    "saleVolumePrice":null,
    "primaryMediumImageURL":null,
    "salePrice":80,
    "fullImageURLs":[
    ],
    "thumbImageURLs":null,
    "productImages":[
    ],
    "route":"/sample/product/xProd10213",
    "mediumImageURLs":[
    ],
    "repositoryId":"xProd10213",
    "derivedListPriceFrom":"UsDollar",
    "primarySourceImageURL":null,
    "shippingSurcharge":100,
    "primarySmallImageURL":null,
    "sourceImageURLs":[
    ],
    "avgCustRating":null,
    "listPrice":100
}Default Response
The error response.
 The following are the internal error codes thrown by this API when the request processing fails in Oracle CX Commerce:
|Error Code|Description|
|------------------|------------------|
|20001|Null Properties Type Internal Error|
|25011|List price must be a positive number or 0|
|25022|Prices are not present for some of the price list groups which are active and has the   flag include all products set to true|
|20000|create Product Type Internal Error|
|20141|Collection Id passed is null or empty|
|25001|Price is invalid|
|25015|set Property RepositoryItem Internal Error|
|25014|convert InputProperty Type Internal Error|
|10003|validate Create Item Type Internal Error|
|20018|Invalid product ID, Product ID may only contain alphanumeric characters|
|20006|{0} of a product must be unique. {1} is already in use|
|25009|Error Setting Price|
|200226|Operation on product is not allowed for the custom catalog|
|84001|The following input fields conflict with each other|
|200240|parentCategoryScope is not revertToBase but parentCategory is not in the request|
|200241|parentCategory is not a parent of the collection|
|200242|catalogSpecific or revertToBase parentCategoryScope but no catalog specified in the request|
|200243|parentCategoryScope invalid/unknown value|
|200244|catalogSpecific parentCategoryScope but parentCategory is not in the specified catalog|
|20026|One or more filtered catalogs are not linked to the catalog in context.|
|20027|Product (0) is not in a V2 catalog associated with all filtered catalogs|
|20182|Invalid value type for property
|20044|One or more direct catalogs does not exists.|
|20045|Direct catalogs must be a valid version 2 catalog.|
|20047|Direct catalogs passed must be an instance of list.|
                
                
                    Root Schema : errorModel
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            devMessage(optional): 
            string
            An optional non-localized message containing technical information for developers
- 
            errorCode(optional): 
            string
            The numerical code identifying the error
- 
            errors(optional): 
            array  errors
            
            An optional list of errors if multiple errors were encountered
- 
            message(optional): 
            string
            The localized message describing the error
- 
            moreInfo(optional): 
            string
            An optional non-localized message with more information
- 
            o:errorPath(optional): 
            string
            An optional machine readable description of where the error occurred
- 
            status(optional): 
            string
            The HTTP status code
- 
            type(optional): 
            string
            The URI to the HTTP state code definition
Nested Schema : errors
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayAn optional list of errors if multiple errors were encountered
    
    
    
    
    
        Show Source
        
        
    
    
    
    
    
    
Nested Schema : items
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        Show Source
        object- 
            devMessage(optional): 
            string
            An optional non-localized message containing technical information for developers
- 
            errorCode(optional): 
            string
            The numerical code identifying the error
- 
            message(optional): 
            string
            The localized message describing the error
- 
            moreInfo(optional): 
            string
            An optional non-localized message with more information
- 
            o:errorPath(optional): 
            string
            An optional machine readable description of where the error occurred
- 
            status(optional): 
            string
            The HTTP status code