REST API for Oracle Commerce Cloud 21B

listPrices

get

/ccadmin/v1/prices

List Prices. Returns a list of lisPrices, salePrices and shippingSurchargePrices for a specific priceListGroupId.

Request

Supported Media Types

application/json

Query Parameters

limit(optional): integer

The number of items to return.
offset(optional): integer

Index of the first element to return.
priceListGroupId: string

The price list group id for which the prices have to be returned.
sort(optional): string

Sorting criteria.

Response

Supported Media Types

application/json

200 Response

The following model is returned if the operation succeeds.

Root Schema : listPrices_response

Type: object

Show Source

items(optional): array items

List of Prices
limit(optional): integer

The number of items to return.
offset(optional): integer

Index of the first element to return.
sort(optional): array sort

Sorting criteria.
total(optional): integer

The total number of items. Deprecated.
totalResults(optional): integer

The total number of items.

{
    "properties":{
        "total":{
            "description":"The total number of items. Deprecated.",
            "type":"integer"
        },
        "totalResults":{
            "description":"The total number of items.",
            "type":"integer"
        },
        "offset":{
            "description":"Index of the first element to return.",
            "type":"integer"
        },
        "limit":{
            "description":"The number of items to return.",
            "type":"integer"
        },
        "sort":{
            "description":"Sorting criteria.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property the listing is sorted by.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Sort order: asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"List of Prices",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "productId":{
                        "description":"Product Id",
                        "type":"string"
                    },
                    "endDate":{
                        "description":"End date of a price",
                        "type":"string"
                    },
                    "pricingScheme":{
                        "description":"Pricing Scheme",
                        "type":"string"
                    },
                    "volumePrice":{
                        "description":"Volume price",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository Id",
                                "type":"string"
                            },
                            "levels":{
                                "description":"Levels",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "quantity":{
                                            "description":"Minimum Quantity for this level",
                                            "type":"integer"
                                        },
                                        "price":{
                                            "description":"Price for this level",
                                            "type":"number"
                                        },
                                        "repositoryId":{
                                            "description":"Repository Id",
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "repositoryId":{
                        "description":"Repository Id",
                        "type":"string"
                    },
                    "parentSkuId":{
                        "description":"Parent Sku Id",
                        "type":"string"
                    },
                    "startDate":{
                        "description":"Start date of a price",
                        "type":"string"
                    },
                    "listPrice":{
                        "description":"List price",
                        "type":"number"
                    },
                    "skuId":{
                        "description":"Sku Id",
                        "type":"string"
                    },
                    "priceList":{
                        "description":"The price list for this price",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of Prices

Show Source

Array of: object items

{
    "description":"List of Prices",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "productId":{
                "description":"Product Id",
                "type":"string"
            },
            "endDate":{
                "description":"End date of a price",
                "type":"string"
            },
            "pricingScheme":{
                "description":"Pricing Scheme",
                "type":"string"
            },
            "volumePrice":{
                "description":"Volume price",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository Id",
                        "type":"string"
                    },
                    "levels":{
                        "description":"Levels",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "quantity":{
                                    "description":"Minimum Quantity for this level",
                                    "type":"integer"
                                },
                                "price":{
                                    "description":"Price for this level",
                                    "type":"number"
                                },
                                "repositoryId":{
                                    "description":"Repository Id",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            },
            "repositoryId":{
                "description":"Repository Id",
                "type":"string"
            },
            "parentSkuId":{
                "description":"Parent Sku Id",
                "type":"string"
            },
            "startDate":{
                "description":"Start date of a price",
                "type":"string"
            },
            "listPrice":{
                "description":"List price",
                "type":"number"
            },
            "skuId":{
                "description":"Sku Id",
                "type":"string"
            },
            "priceList":{
                "description":"The price list for this price",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : sort

Type: array

Sorting criteria.

Show Source

Array of: object items

{
    "description":"Sorting criteria.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property the listing is sorted by.",
                "type":"string"
            },
            "order":{
                "description":"Sort order: asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

endDate(optional): string

End date of a price
listPrice(optional): number

List price
parentSkuId(optional): string

Parent Sku Id
priceList(optional): object priceList

The price list for this price
pricingScheme(optional): string

Pricing Scheme
productId(optional): string

Product Id
repositoryId(optional): string

Repository Id
skuId(optional): string

Sku Id
startDate(optional): string

Start date of a price
volumePrice(optional): object volumePrice

Volume price

{
    "type":"object",
    "properties":{
        "productId":{
            "description":"Product Id",
            "type":"string"
        },
        "endDate":{
            "description":"End date of a price",
            "type":"string"
        },
        "pricingScheme":{
            "description":"Pricing Scheme",
            "type":"string"
        },
        "volumePrice":{
            "description":"Volume price",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository Id",
                    "type":"string"
                },
                "levels":{
                    "description":"Levels",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "quantity":{
                                "description":"Minimum Quantity for this level",
                                "type":"integer"
                            },
                            "price":{
                                "description":"Price for this level",
                                "type":"number"
                            },
                            "repositoryId":{
                                "description":"Repository Id",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "repositoryId":{
            "description":"Repository Id",
            "type":"string"
        },
        "parentSkuId":{
            "description":"Parent Sku Id",
            "type":"string"
        },
        "startDate":{
            "description":"Start date of a price",
            "type":"string"
        },
        "listPrice":{
            "description":"List price",
            "type":"number"
        },
        "skuId":{
            "description":"Sku Id",
            "type":"string"
        },
        "priceList":{
            "description":"The price list for this price",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : priceList

Type: object

The price list for this price

Show Source

repositoryId(optional): string

Repository ID

{
    "description":"The price list for this price",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID",
            "type":"string"
        }
    }
}

Nested Schema : volumePrice

Type: object

Volume price

Show Source

levels(optional): array levels

Levels
repositoryId(optional): string

Repository Id

{
    "description":"Volume price",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository Id",
            "type":"string"
        },
        "levels":{
            "description":"Levels",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "quantity":{
                        "description":"Minimum Quantity for this level",
                        "type":"integer"
                    },
                    "price":{
                        "description":"Price for this level",
                        "type":"number"
                    },
                    "repositoryId":{
                        "description":"Repository Id",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : levels

Type: array

Levels

Show Source

Array of: object items

{
    "description":"Levels",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "quantity":{
                "description":"Minimum Quantity for this level",
                "type":"integer"
            },
            "price":{
                "description":"Price for this level",
                "type":"number"
            },
            "repositoryId":{
                "description":"Repository Id",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

price(optional): number

Price for this level
quantity(optional): integer

Minimum Quantity for this level
repositoryId(optional): string

Repository Id

{
    "type":"object",
    "properties":{
        "quantity":{
            "description":"Minimum Quantity for this level",
            "type":"integer"
        },
        "price":{
            "description":"Price for this level",
            "type":"number"
        },
        "repositoryId":{
            "description":"Repository Id",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

order(optional): string

Sort order: asc or desc.
property(optional): string

The property the listing is sorted by.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property the listing is sorted by.",
            "type":"string"
        },
        "order":{
            "description":"Sort order: asc or desc.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"priceList",
            "order":"asc"
        }
    ],
    "items":[
        {
            "productId":"Product_13CD",
            "endDate":null,
            "pricingScheme":"listPrice",
            "volumePrice":null,
            "repositoryId":"p121007",
            "parentSkuId":null,
            "startDate":null,
            "listPrice":2,
            "skuId":null,
            "priceList":{
                "repositoryId":"new1_listPrices"
            }
        },
        {
            "productId":"Product_13CD",
            "endDate":null,
            "pricingScheme":"bulkPrice",
            "volumePrice":{
                "repositoryId":"cxp10003",
                "levels":[
                    {
                        "quantity":1,
                        "price":25,
                        "repositoryId":"plvl10003"
                    },
                    {
                        "quantity":5,
                        "price":20,
                        "repositoryId":"plvl10004"
                    }
                ]
            },
            "repositoryId":"p141006",
            "parentSkuId":null,
            "startDate":null,
            "listPrice":null,
            "skuId":"Sku_13DE",
            "priceList":{
                "repositoryId":"new1_listPrices"
            }
        }
    ]
}

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| |------------------|------------------| |100177|Error getting prices.|

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"
        }
    }
}