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

listPromotionFolders

get

/ccadmin/v1/promotionFolders

List Promotion Folders. Get a list of promotion folders including support for pagination and sorting.

Request

Supported Media Types
  • application/json
Query Parameters
limit
Type: integer
The number of items to return.
offset
Type: integer
Index of the first element to return.
q
Type: string
A SCIM filter string for selecting a subset of all promotion folders. See [https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format. Example: Get all promotion folders whose name contains holiday: q=name co "holiday" name is the only relevant property on promotion folder that can be used with q parameter filtering. Text, date and time values appearing in SCIM filters should be quoted, with date and time values using ISO-8601 format. Numeric and boolean values should not be quoted.
sort
Type: 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.|
total
Type: integer
The total number of items.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listPromotionFolders_response
Nested Schema : items
Type: array
The items returned by the listing.
Nested Schema : sort
Type: array
Sorting criteria.
Nested Schema : items
Type: object
Nested Schema : parentFolder
Type: object
Parent Folder object of the current folder.
Nested Schema : items
Type: object
Example application/json

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":2,
    "sort":[
        {
            "property":"path",
            "order":"asc"
        }
    ],
    "items":[
        {
            "path":"Holiday Discount",
            "parentFolder":null,
            "repositoryId":"promoFolder100001",
            "name":"Holiday Discount"
        },
        {
            "path":"Holiday Discount/Winter Discount",
            "parentFolder":{
                "repositoryId":"promoFolder100001"
            },
            "repositoryId":"promoFolder100002",
            "name":"Winter Discount"
        }
    ]
}
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "total": 2,
  "totalResults": 2,
  "offset": 0,
  "limit": 2,
  "sort": [{
    "property": "path",
    "order": "asc"
  }],
  "items": [
    {
      "path": "Holiday Discount",
      "parentFolder": null,
      "repositoryId": "promoFolder100001",
      "name": "Holiday Discount"
    },
    {
      "path": "Holiday Discount/Winter Discount",
      "parentFolder": {"repositoryId": "promoFolder100001"},
      "repositoryId": "promoFolder100002",
      "name": "Winter Discount"
    }
  ]
}