1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Store
  4. ShareSettings

listShareSettings

get

/ccstore/v1/shareSettings

List ShareSettings. This operation is used to get the collection of share settings from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of share setting.

Request

Supported Media Types
Query Parameters
  • Query string built as per the SCIM standards that helps to search entered string across share settings properties like 'relativeTo'.
  • This field determines the sort order of the list to be fetched.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listShareSettings_response
Type: object
Show Source
Nested Schema : items
Type: array
list of share settings
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : account
Type: object
Account for in which the sharing should be valid.
Show Source
Nested Schema : sharedEmailConfigs
Type: array
Email configurations of the recipients with whom sharing is done using individual email addresses.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccstoreui/v1/shareSettings?q=sharedResourceType eq \"purchaseList\""
        }
    ],
    "items":[
        {
            "owner":{
                "firstName":"Leota",
                "lastName":"Dilliard",
                "id":"bb-100006",
                "email":"leota@example.com"
            },
            "organizationSharingEnabled":true,
            "sharedEmailConfigs":[
                {
                    "editEnabled":true,
                    "id":"gi10001",
                    "email":"newman@example.com"
                }
            ],
            "id":"100001",
            "sharedResourceType":"purchaseList",
            "defaultEditEnabled":false,
            "account":{
                "name":"National Discount Auto Parts",
                "id":"or-100001"
            }
        }
    ]
}

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| |------------------|------------------| |00001000|The user is not authenticated.
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top