Jump to

• Request
• Response

listPriceListGroups

get

/ccstore/v1/priceListGroups

List Price List Groups. Get a list of PriceListGroups.

Request

Supported Media Types

• application/json

Query Parameters

• defaultFirst(optional): boolean
  This for displaying default PriceListGroup first in the list
• limit(optional): integer
  The number of items to return.
• offset(optional): integer
  Index of the first element to return.
• siteId(optional): string
  Site ID of the site
• sort(optional): string
  Sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property the listing is sorted by.| |order|string|Sort order: asc or desc.|

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listPriceListGroups_response

Type: object

Show Source

• items(optional): array items
  List of PriceListGroups
• 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 PriceListGroups",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"display name of the PriceListGroup.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The ID of the PriceListGroup item.",
                        "type":"string"
                    },
                    "listPriceList":{
                        "description":"Price List for list prices",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID of the list prices.",
                                "type":"string"
                            }
                        }
                    },
                    "active":{
                        "description":"indicates if the PriceListGroup is activ.e",
                        "type":"boolean"
                    },
                    "salePriceList":{
                        "description":"Price List for sale prices.",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID of the sale prices.",
                                "type":"string"
                            }
                        }
                    },
                    "includeAllProducts":{
                        "description":"If true, and active flag is also set to true then list price is mandatory for all products.",
                        "type":"boolean"
                    },
                    "shippingSurchargePriceList":{
                        "description":"Price List for shipping surcharge prices.",
                        "type":"object",
                        "properties":{
                            "repositoryId":{
                                "description":"Repository ID of the shipping surcharge prices.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of PriceListGroups

Show Source

• Array of: object items

{
    "description":"List of PriceListGroups",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"display name of the PriceListGroup.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The ID of the PriceListGroup item.",
                "type":"string"
            },
            "listPriceList":{
                "description":"Price List for list prices",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of the list prices.",
                        "type":"string"
                    }
                }
            },
            "active":{
                "description":"indicates if the PriceListGroup is activ.e",
                "type":"boolean"
            },
            "salePriceList":{
                "description":"Price List for sale prices.",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of the sale prices.",
                        "type":"string"
                    }
                }
            },
            "includeAllProducts":{
                "description":"If true, and active flag is also set to true then list price is mandatory for all products.",
                "type":"boolean"
            },
            "shippingSurchargePriceList":{
                "description":"Price List for shipping surcharge prices.",
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of the shipping surcharge prices.",
                        "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

• active(optional): boolean
  indicates if the PriceListGroup is activ.e
• displayName(optional): string
  display name of the PriceListGroup.
• includeAllProducts(optional): boolean
  If true, and active flag is also set to true then list price is mandatory for all products.
• listPriceList(optional): object listPriceList
  Price List for list prices
• repositoryId(optional): string
  The ID of the PriceListGroup item.
• salePriceList(optional): object salePriceList
  Price List for sale prices.
• shippingSurchargePriceList(optional): object shippingSurchargePriceList
  Price List for shipping surcharge prices.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"display name of the PriceListGroup.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the PriceListGroup item.",
            "type":"string"
        },
        "listPriceList":{
            "description":"Price List for list prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID of the list prices.",
                    "type":"string"
                }
            }
        },
        "active":{
            "description":"indicates if the PriceListGroup is activ.e",
            "type":"boolean"
        },
        "salePriceList":{
            "description":"Price List for sale prices.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID of the sale prices.",
                    "type":"string"
                }
            }
        },
        "includeAllProducts":{
            "description":"If true, and active flag is also set to true then list price is mandatory for all products.",
            "type":"boolean"
        },
        "shippingSurchargePriceList":{
            "description":"Price List for shipping surcharge prices.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID of the shipping surcharge prices.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : listPriceList

Type: object

Price List for list prices

Show Source

• repositoryId(optional): string
  Repository ID of the list prices.

{
    "description":"Price List for list prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the list prices.",
            "type":"string"
        }
    }
}

Nested Schema : salePriceList

Type: object

Price List for sale prices.

Show Source

• repositoryId(optional): string
  Repository ID of the sale prices.

{
    "description":"Price List for sale prices.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the sale prices.",
            "type":"string"
        }
    }
}

Nested Schema : shippingSurchargePriceList

Type: object

Price List for shipping surcharge prices.

Show Source

• repositoryId(optional): string
  Repository ID of the shipping surcharge prices.

{
    "description":"Price List for shipping surcharge prices.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the shipping surcharge prices.",
            "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,
    "defaultPriceListGroup":{
        "displayName":"UsDollar",
        "listPriceList":{
            "repositoryId":"listPrices"
        },
        "repositoryId":"UsDollar",
        "active":false,
        "salePriceList":{
            "repositoryId":"salePrices"
        },
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"UsDollar",
        "locale":"en_US",
        "shippingSurchargePriceList":{
            "repositoryId":"shippingSurchargePrices"
        },
        "includeAllProducts":true
    },
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "displayName":null,
            "listPriceList":{
                "repositoryId":"listPrices"
            },
            "repositoryId":"UsDollar",
            "active":false,
            "salePriceList":{
                "repositoryId":"salePrices"
            },
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"en_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"840"
            },
            "id":"UsDollar",
            "locale":"en_US",
            "shippingSurchargePriceList":{
                "repositoryId":"shippingSurcharge"
            },
            "includeAllProducts":true
        },
        {
            "displayName":"CanadianDollar",
            "listPriceList":{
                "repositoryId":"CanadianDollar_listPrice"
            },
            "repositoryId":"CanadianDollar",
            "active":false,
            "salePriceList":{
                "repositoryId":"CanadianDollar_salePrice"
            },
            "id":"CanadianDollar",
            "locale":"en_CA",
            "shippingSurchargePriceList":{
                "repositoryId":"CanadianDollar_shippingSurchargePrice"
            },
            "includeAllProducts":false
        }
    ]
}

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| |------------------|------------------| |20185|There was an error fetching the PriceListGroup list.|

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