Jump to

• Request
• Response

setPrice

put

/ccadmin/v1/prices/{id}

Set Price. Sets a price value to the product based on provided product ID, SKU ID and type of price.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID corresponding to the product whose price or whose SKU price is to be set.

Body ()

Root Schema : setPrice_request

Type: object

Show Source

• price: number
  Price value to be set to the product or SKU.
• skuId(optional): string
  SKU ID if we are setting the price of a SKU.
• type: string
  Type of price can be sale or list.
• voumePrice(optional): object voumePrice
  Volume price of the product/sku

{
    "properties":{
        "price":{
            "description":"Price value to be set to the product or SKU.",
            "type":"number"
        },
        "voumePrice":{
            "description":"Volume price of the product/sku",
            "type":"object",
            "properties":{
                "pricingScheme":{
                    "description":"Pricing scheme can be either tieredPrice or bulkPrice",
                    "type":"object",
                    "properties":{
                        "numLevels":{
                            "description":"Number of levels in the volume price",
                            "type":"number"
                        },
                        "levels":{
                            "description":"Price levels array for volume price",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "price":{
                                        "description":"price value for price level",
                                        "type":"number"
                                    },
                                    "levelMinimum":{
                                        "description":"minimum quantity for price level",
                                        "type":"number"
                                    },
                                    "levelMaximum":{
                                        "description":"minimum quantity for price level",
                                        "type":"number"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "type":{
            "description":"Type of price can be sale or list.",
            "type":"string"
        },
        "skuId":{
            "description":"SKU ID if we are setting the price of a SKU.",
            "type":"string"
        }
    },
    "required":[
        "price",
        "type"
    ],
    "example":{
        "price":9.7,
        "volumePrice":null,
        "type":"sale",
        "skuId":"xsku2535_1"
    }
}

Example:

{
    "price":9.7,
    "volumePrice":null,
    "type":"sale",
    "skuId":"xsku2535_1"
}

Nested Schema : voumePrice

Type: object

Volume price of the product/sku

Show Source

• pricingScheme(optional): object pricingScheme
  Pricing scheme can be either tieredPrice or bulkPrice

{
    "description":"Volume price of the product/sku",
    "type":"object",
    "properties":{
        "pricingScheme":{
            "description":"Pricing scheme can be either tieredPrice or bulkPrice",
            "type":"object",
            "properties":{
                "numLevels":{
                    "description":"Number of levels in the volume price",
                    "type":"number"
                },
                "levels":{
                    "description":"Price levels array for volume price",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "price":{
                                "description":"price value for price level",
                                "type":"number"
                            },
                            "levelMinimum":{
                                "description":"minimum quantity for price level",
                                "type":"number"
                            },
                            "levelMaximum":{
                                "description":"minimum quantity for price level",
                                "type":"number"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : pricingScheme

Type: object

Pricing 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

{
    "description":"Pricing scheme can be either tieredPrice or bulkPrice",
    "type":"object",
    "properties":{
        "numLevels":{
            "description":"Number of levels in the volume price",
            "type":"number"
        },
        "levels":{
            "description":"Price levels array for volume price",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "price":{
                        "description":"price value for price level",
                        "type":"number"
                    },
                    "levelMinimum":{
                        "description":"minimum quantity for price level",
                        "type":"number"
                    },
                    "levelMaximum":{
                        "description":"minimum quantity for price level",
                        "type":"number"
                    }
                }
            }
        }
    }
}

Nested Schema : levels

Type: array

Price levels array for volume price

Show Source

• Array of: object items

{
    "description":"Price levels array for volume price",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "price":{
                "description":"price value for price level",
                "type":"number"
            },
            "levelMinimum":{
                "description":"minimum quantity for price level",
                "type":"number"
            },
            "levelMaximum":{
                "description":"minimum quantity for price level",
                "type":"number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• levelMaximum(optional): number
  minimum quantity for price level
• levelMinimum(optional): number
  minimum quantity for price level
• price(optional): number
  price value for price level

{
    "type":"object",
    "properties":{
        "price":{
            "description":"price value for price level",
            "type":"number"
        },
        "levelMinimum":{
            "description":"minimum quantity for price level",
            "type":"number"
        },
        "levelMaximum":{
            "description":"minimum quantity for price level",
            "type":"number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

A 204 No Content response is returned when operation succeeds.

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top