updateProductMembership
post
/ccadmin/v1/products/membership
Updates product membership to filtered view catalogs.
Request
Supported Media Types
- application/json
Root Schema : updateProductMembership_request
Type:
Show Source
object
-
catalogId(optional):
Optional catalog to put into context. If a catalog is in context then only filtered view catalog changes linked to the catalog context are possible.
-
coreProduct(optional):
boolean
true to ensure the given products will be core products that by default are automatically members of linked filtered view catalogs.
-
directCatalogs(optional):
array directCatalogs
List of catalog IDs that this product is associated with through direct catalog linking.
-
enableMembership(optional):
boolean
true/false to enable/disable the given products as members of the given filtered view catalogs. If not provided then filteredCatalogs specified in the request will explicitly replace existing values and will be treated as inclusive or exclusive depending on whether or not a product is a core product. If a catalog is in context then only the filtered view catalogs linked to the catalog context are replaced, other filtered view catalogs on the product remain unchanged.
-
filteredCatalogs(optional):
array filteredCatalogs
List of filtered view catalog Ids products will be included (if their core product is false) or excluded from (if their core product is true).
-
products:
array products
List of products Ids whose membership will be updated.
Example:
{
"directCatalogs":[
"catalog1",
"catalog2"
],
"filteredCatalogs":[
"myFilteredView1",
"myFilteredView3"
],
"enableMembership":true,
"products":[
"camera_1",
"camcorder_1"
],
"coreProduct":false
}
Nested Schema : directCatalogs
Type:
array
List of catalog IDs that this product is associated with through direct catalog linking.
Show Source
-
Array of:
string
IDs of the catalog to which these products will have direct linkage.
Nested Schema : filteredCatalogs
Type:
array
List of filtered view catalog Ids products will be included (if their core product is false) or excluded from (if their core product is true).
Show Source
-
Array of:
string
List of filtered view catalog ids
Nested Schema : products
Type:
array
List of products Ids whose membership will be updated.
Show Source
-
Array of:
string
List of product ids
Response
Supported Media Types
- application/json
200 Response
No response when operation succeeds.
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle CX Commerce:
|Error Code|Description|
|------------------|------------------|
|20026|One or more filtered catalogs are not linked to the catalog in context.|
|20027|Product (0) is not in a V2 catalog associated with all filtered catalogs|
|20028|No products to be updated|
|10004|Attempt to set a boolean property enableMembership with a non boolean value.|
|20182|Invalid value type for property|
|20043|Direct catalog must be same as the current catalog in context.|
|20044|One or more direct catalogs does not exists.|
|20045|Direct catalogs must be a valid version 2 catalog.|
|20046|Internal error occurred while fetching direct catalogs for product.|
|20047|Direct catalogs passed must be an instance of list.|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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