REST API for Oracle Commerce Cloud

updateSiteProperties

put

/ccstore/v1/profiles/current/siteProperties

Updates the site based properties for the current profile. Can be used to update multiple properties of multiple sites at the same time.

Request

Supported Media Types

application/json

Query Parameters

limit: integer

This is the field to specify the number of records to be fetched per REST call.
offset: integer

This field specifies the offset/starting index from which data to be fetched.

Header Parameters

X-CCAsset-Language: string

The asset language of the request.

Root Schema : updateSiteProperties_request

Type: object

Show Source

siteProperties: object siteProperties

The site related properties

{
    "properties":{
        "siteProperties":{
            "description":"The site related properties",
            "type":"object",
            "properties":{
                "site":{
                    "description":"The ID of the site.",
                    "type":"string"
                },
                "properties":{
                    "description":"The type of the site property.",
                    "type":"object",
                    "properties":{
                        "GDPRProfileP13nConsentGranted":{
                            "description":"Indicates whether the customer has given consent for his/her profile information to be used for personalization purposes. Can be true or false.",
                            "type":"boolean"
                        },
                        "repositoryId":{
                            "description":"The ID of the repository of site property.",
                            "type":"string"
                        },
                        "receiveEmail":{
                            "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    },
    "example":{
        "siteProperties":[
            {
                "site":{
                    "id":"SiteA"
                },
                "properties":{
                    "GDPRProfileP13nConsentGranted":true,
                    "receiveEmail":"yes"
                }
            }
        ]
    }
}

Example:

{
    "siteProperties":[
        {
            "site":{
                "id":"SiteA"
            },
            "properties":{
                "GDPRProfileP13nConsentGranted":true,
                "receiveEmail":"yes"
            }
        }
    ]
}

Nested Schema : siteProperties

Type: object

The site related properties

Show Source

properties: object properties

The type of the site property.
site: string

The ID of the site.

{
    "description":"The site related properties",
    "type":"object",
    "properties":{
        "site":{
            "description":"The ID of the site.",
            "type":"string"
        },
        "properties":{
            "description":"The type of the site property.",
            "type":"object",
            "properties":{
                "GDPRProfileP13nConsentGranted":{
                    "description":"Indicates whether the customer has given consent for his/her profile information to be used for personalization purposes. Can be true or false.",
                    "type":"boolean"
                },
                "repositoryId":{
                    "description":"The ID of the repository of site property.",
                    "type":"string"
                },
                "receiveEmail":{
                    "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

The type of the site property.

Show Source

GDPRProfileP13nConsentGranted: boolean

Indicates whether the customer has given consent for his/her profile information to be used for personalization purposes. Can be true or false.
receiveEmail: string

Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.
repositoryId: string

The ID of the repository of site property.

{
    "description":"The type of the site property.",
    "type":"object",
    "properties":{
        "GDPRProfileP13nConsentGranted":{
            "description":"Indicates whether the customer has given consent for his/her profile information to be used for personalization purposes. Can be true or false.",
            "type":"boolean"
        },
        "repositoryId":{
            "description":"The ID of the repository of site property.",
            "type":"string"
        },
        "receiveEmail":{
            "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : updateSiteProperties_response

Type: object

Show Source

items: array items

The site related properties
limit: integer

The batch size of the records to be fetched together.
offset: integer

The start index of the list of records to be fetched.
sort: string

Sorting format.

{
    "properties":{
        "offset":{
            "description":"The start index of the list of records to be fetched.",
            "type":"integer"
        },
        "limit":{
            "description":"The batch size of the  records to be fetched together.",
            "type":"integer"
        },
        "sort":{
            "description":"Sorting format.",
            "type":"string"
        },
        "items":{
            "description":"The site related properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "site":{
                        "description":"The site.",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The ID of the site.",
                                "type":"string"
                            }
                        }
                    },
                    "properties":{
                        "description":"The type of the site property.",
                        "type":"object",
                        "properties":{
                            "GDPRProfileP13nConsentDate":{
                                "description":"The date on which GDPR personalization consent was granted by the user.",
                                "type":"string"
                            },
                            "GDPRProfileP13nConsentGranted":{
                                "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                                "type":"boolean"
                            },
                            "repositoryId":{
                                "description":"The ID of the repository of site property.",
                                "type":"string"
                            },
                            "receiveEmail":{
                                "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
                                "type":"string"
                            },
                            "receiveEmailDate":{
                                "description":"The date on which the customer opted for receiving marketing emails.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The site related properties

Show Source

Array of: object items

{
    "description":"The site related properties",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "site":{
                "description":"The site.",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the site.",
                        "type":"string"
                    }
                }
            },
            "properties":{
                "description":"The type of the site property.",
                "type":"object",
                "properties":{
                    "GDPRProfileP13nConsentDate":{
                        "description":"The date on which GDPR personalization consent was granted by the user.",
                        "type":"string"
                    },
                    "GDPRProfileP13nConsentGranted":{
                        "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                        "type":"boolean"
                    },
                    "repositoryId":{
                        "description":"The ID of the repository of site property.",
                        "type":"string"
                    },
                    "receiveEmail":{
                        "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
                        "type":"string"
                    },
                    "receiveEmailDate":{
                        "description":"The date on which the customer opted for receiving marketing emails.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

properties: object properties

The type of the site property.
site: object site

The site.

{
    "type":"object",
    "properties":{
        "site":{
            "description":"The site.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The ID of the site.",
                    "type":"string"
                }
            }
        },
        "properties":{
            "description":"The type of the site property.",
            "type":"object",
            "properties":{
                "GDPRProfileP13nConsentDate":{
                    "description":"The date on which GDPR personalization consent was granted by the user.",
                    "type":"string"
                },
                "GDPRProfileP13nConsentGranted":{
                    "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                    "type":"boolean"
                },
                "repositoryId":{
                    "description":"The ID of the repository of site property.",
                    "type":"string"
                },
                "receiveEmail":{
                    "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
                    "type":"string"
                },
                "receiveEmailDate":{
                    "description":"The date on which the customer opted for receiving marketing emails.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

The type of the site property.

Show Source

GDPRProfileP13nConsentDate: string

The date on which GDPR personalization consent was granted by the user.
GDPRProfileP13nConsentGranted: boolean

Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.
receiveEmail: string

Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.
receiveEmailDate: string

The date on which the customer opted for receiving marketing emails.
repositoryId: string

The ID of the repository of site property.

{
    "description":"The type of the site property.",
    "type":"object",
    "properties":{
        "GDPRProfileP13nConsentDate":{
            "description":"The date on which GDPR personalization consent was granted by the user.",
            "type":"string"
        },
        "GDPRProfileP13nConsentGranted":{
            "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
            "type":"boolean"
        },
        "repositoryId":{
            "description":"The ID of the repository of site property.",
            "type":"string"
        },
        "receiveEmail":{
            "description":"Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.",
            "type":"string"
        },
        "receiveEmailDate":{
            "description":"The date on which the customer opted for receiving marketing emails.",
            "type":"string"
        }
    }
}

Nested Schema : site

Type: object

The site.

Show Source

id: string

The ID of the site.

{
    "description":"The site.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the site.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "totalResults":2,
    "endingIndex":250,
    "offset":0,
    "totalResultsParam":true,
    "count":2,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profiles/current/siteProperties"
        }
    ],
    "sort":null,
    "items":[
        {
            "site":{
                "repositoryId":"100001",
                "id":"100001"
            },
            "properties":{
                "GDPRProfileP13nConsentDate":"2018-02-26T06:07:49.237Z",
                "GDPRProfileP13nConsentGranted":true,
                "repositoryId":"100002",
                "receiveEmail":"no",
                "receiveEmailDate":"2018-02-26T06:07:49.237Z"
            }
        },
        {
            "site":{
                "id":"siteUS"
            },
            "properties":{
                "GDPRProfileP13nConsentDate":"2018-02-26T06:07:49.237Z",
                "GDPRProfileP13nConsentGranted":true,
                "receiveEmail":"yes",
                "receiveEmailDate":"2018-02-26T06:07:49.237Z"
            }
        }
    ],
    "listingRequest":{
        "endingIndex":250,
        "correctedView":null,
        "queryOptions":{
            "precachedPropertyNames":null,
            "doNotCacheQuery":false,
            "sortDirectives":null,
            "endingIndex":250,
            "ignoreDuplicates":false,
            "nthIndex":1,
            "uncachedItems":false,
            "uncachedItemsSet":false,
            "startingIndex":0
        },
        "rqlString":null,
        "QErrorCodeMap":null,
        "QPropertyAliasMap":null,
        "sort":null,
        "startingIndex":0,
        "QIgnoreCase":true,
        "QString":null,
        "filterProperties":[
            "displayName",
            "id"
        ],
        "includeRqlInQueryGeneration":true,
        "rqlStatement":null,
        "expanded":false,
        "scimParser":null,
        "useSCIMForQ":true,
        "limit":250,
        "siteId":"siteUS",
        "after":null,
        "calculateTotalAvailable":true
    },
    "startingIndex":0,
    "totalNumberOfItems":2
}

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| |------------------|------------------| |22031|Internal error during get profile properties.| |22032|Error occured due to invalid data| |22033|User is not logged in.| |22034|No site found| |22035|Error occured when site property not found.| |22036|Internal error during update profile properties.|

Root Schema : errorModel

Type: object

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
errors: array errors

An optional list of errors if multiple errors were encountered
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code
type: 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: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: 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"
        }
    }
}