REST API for Oracle Commerce Cloud 22A

updateSiteProperties

put

/ccappagent/v1/profiles/{id}/siteProperties

Update site properties for specific customer. Example: Update receive email property with yes or no for specic site

Request

Supported Media Types

application/json

Path Parameters

id: string

The customer profile id.

Root Schema : updateSiteProperties_request

Type: object

Show Source

siteProperties(optional): array siteProperties

The site related properties

{
    "properties":{
        "siteProperties":{
            "description":"The site related properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "site":{
                        "description":"The site data",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The id of the site",
                                "type":"string"
                            }
                        }
                    },
                    "properties":{
                        "description":"The site related properties to be updated for the profile",
                        "type":"object",
                        "properties":{
                            "GDPRProfileP13nConsentGranted":{
                                "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                                "type":"boolean"
                            },
                            "receiveEmail":{
                                "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    },
    "example":{
        "siteProperties":[
            {
                "site":{
                    "id":"100001"
                },
                "properties":{
                    "GDPRProfileP13nConsentGranted":false,
                    "receiveEmail":"no"
                }
            },
            {
                "site":{
                    "id":"siteUS"
                },
                "properties":{
                    "GDPRProfileP13nConsentGranted":false,
                    "receiveEmail":"yes"
                }
            }
        ]
    }
}

Example:

{
    "siteProperties":[
        {
            "site":{
                "id":"100001"
            },
            "properties":{
                "GDPRProfileP13nConsentGranted":false,
                "receiveEmail":"no"
            }
        },
        {
            "site":{
                "id":"siteUS"
            },
            "properties":{
                "GDPRProfileP13nConsentGranted":false,
                "receiveEmail":"yes"
            }
        }
    ]
}

Nested Schema : siteProperties

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 data",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The id of the site",
                        "type":"string"
                    }
                }
            },
            "properties":{
                "description":"The site related properties to be updated for the profile",
                "type":"object",
                "properties":{
                    "GDPRProfileP13nConsentGranted":{
                        "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                        "type":"boolean"
                    },
                    "receiveEmail":{
                        "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

properties(optional): object properties

The site related properties to be updated for the profile
site(optional): object site

The site data

{
    "type":"object",
    "properties":{
        "site":{
            "description":"The site data",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The id of the site",
                    "type":"string"
                }
            }
        },
        "properties":{
            "description":"The site related properties to be updated for the profile",
            "type":"object",
            "properties":{
                "GDPRProfileP13nConsentGranted":{
                    "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                    "type":"boolean"
                },
                "receiveEmail":{
                    "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

The site related properties to be updated for the profile

Show Source

GDPRProfileP13nConsentGranted(optional): boolean

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

Indicates whether the user should receive marketing emails on the current site. Can be yes or no.

{
    "description":"The site related properties to be updated for the profile",
    "type":"object",
    "properties":{
        "GDPRProfileP13nConsentGranted":{
            "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
            "type":"boolean"
        },
        "receiveEmail":{
            "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
            "type":"string"
        }
    }
}

Nested Schema : site

Type: object

The site data

Show Source

id(optional): string

The id of the site

{
    "description":"The site data",
    "type":"object",
    "properties":{
        "id":{
            "description":"The id of the site",
            "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(optional): array items

The list of site related properties for the profile
offset(optional): integer

The start index of the list of records to be fetched
sort(optional): string

Sorting format

{
    "properties":{
        "offset":{
            "description":"The start index of the list of records to be fetched",
            "type":"integer"
        },
        "sort":{
            "description":"Sorting format",
            "type":"string"
        },
        "items":{
            "description":"The list of site related properties for the profile",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "site":{
                        "description":"The site data",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The id of the site",
                                "type":"string"
                            }
                        }
                    },
                    "properties":{
                        "description":"The site related properties for the profile",
                        "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"
                            },
                            "receiveEmail":{
                                "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                                "type":"string"
                            },
                            "receiveEmailDate":{
                                "description":"The date on which email marketing consent was granted by the user.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of site related properties for the profile

Show Source

Array of: object items

{
    "description":"The list of site related properties for the profile",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "site":{
                "description":"The site data",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The id of the site",
                        "type":"string"
                    }
                }
            },
            "properties":{
                "description":"The site related properties for the profile",
                "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"
                    },
                    "receiveEmail":{
                        "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                        "type":"string"
                    },
                    "receiveEmailDate":{
                        "description":"The date on which email marketing consent was granted by the user.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

properties(optional): object properties

The site related properties for the profile
site(optional): object site

The site data

{
    "type":"object",
    "properties":{
        "site":{
            "description":"The site data",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The id of the site",
                    "type":"string"
                }
            }
        },
        "properties":{
            "description":"The site related properties for the profile",
            "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"
                },
                "receiveEmail":{
                    "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                    "type":"string"
                },
                "receiveEmailDate":{
                    "description":"The date on which email marketing consent was granted by the user.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

The site related properties for the profile

Show Source

GDPRProfileP13nConsentDate(optional): string

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

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

Indicates whether the user should receive marketing emails on the current site. Can be yes or no.
receiveEmailDate(optional): string

The date on which email marketing consent was granted by the user.

{
    "description":"The site related properties for the profile",
    "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"
        },
        "receiveEmail":{
            "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
            "type":"string"
        },
        "receiveEmailDate":{
            "description":"The date on which email marketing consent was granted by the user.",
            "type":"string"
        }
    }
}

Nested Schema : site

Type: object

The site data

Show Source

id(optional): string

The id of the site

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

Example Response (application/json)

{
    "totalResults":1,
    "endingIndex":250,
    "offset":0,
    "totalResultsParam":true,
    "count":1,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/profiles/se-570031/siteProperties"
        }
    ],
    "sort":null,
    "items":[
        {
            "site":{
                "id":"SiteA"
            },
            "properties":{
                "GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z",
                "GDPRProfileP13nConsentGranted":true,
                "receiveEmail":"yes",
                "receiveEmailDate":"2018-03-21T13:10:08.463Z"
            }
        }
    ],
    "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":null,
        "after":null,
        "calculateTotalAvailable":true
    },
    "startingIndex":0,
    "totalNumberOfItems":1
}

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| |------------------|------------------| |200012|please provide valid input| |23010|City not specified in shipping address| |23011|Address line 1 not specified in shipping address| |22000|The profile id passes is null or empty.| |23012|No last name specified in shipping address| |22001|Internal error while getting the profile.| |23013|No first name specified in shipping address| |22002|No profile found with the given id.| |23015|Phone number not specified in shipping address| |23005|Invalid phone number in shipping address| |23007|No country specified in shipping address| |23008|Postal code not specified in shipping address| |22024|{0}({1}) must be a String|

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