Jump to

• Request
• Response

createProductAssignmentToCollections

post

/ccadmin/v1/products/{id}/addToCollections

Creates a request to assign product to multiple collections

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Body ()

Root Schema : createProductAssignmentToCollections_request

Type: object

Show Source

• collections: array collections
  List of collections IDs to assign a product to. Note, it is not allowed to move products to catalog root categories. Instead if the catalog's default category for products is set then it will be used or if it is not set then the move for that root category will be ignored.

{
    "properties":{
        "collections":{
            "description":"List of collections IDs to assign a product to. Note, it is not allowed to move products to catalog root categories.  Instead if the catalog's default category for products is set then it will be used or if it is not set then the move for that root category will be ignored.",
            "type":"array",
            "items":{
                "description":"List of collection ids",
                "type":"string"
            }
        }
    },
    "required":[
        "collections"
    ],
    "example":{
        "collections":[
            "camera_1001",
            "camera_1002"
        ]
    }
}

Example:

{
    "collections":[
        "camera_1001",
        "camera_1002"
    ]
}

Nested Schema : collections

Type: array

List of collections IDs to assign a product to. Note, it is not allowed to move products to catalog root categories. Instead if the catalog's default category for products is set then it will be used or if it is not set then the move for that root category will be ignored.

Show Source

• Array of: string
  List of collection ids

{
    "description":"List of collections IDs to assign a product to. Note, it is not allowed to move products to catalog root categories.  Instead if the catalog's default category for products is set then it will be used or if it is not set then the move for that root category will be ignored.",
    "type":"array",
    "items":{
        "description":"List of collection ids",
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createProductAssignmentToCollections_response

Type: object

Show Source

• id(optional): string
  Repository ID of the product.
• parentCategories(optional): array parentCategories
  Array having repository IDs of the collection.
• repositoryId(optional): string
  Repository ID of the product.

{
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the product.",
            "type":"string"
        },
        "id":{
            "description":"Repository ID of the product.",
            "type":"string"
        },
        "parentCategories":{
            "description":"Array having repository IDs of the collection.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of a collection.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : parentCategories

Type: array

Array having repository IDs of the collection.

Show Source

• Array of: object items

{
    "description":"Array having repository IDs of the collection.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository ID of a collection.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  Repository ID of a collection.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of a collection.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "repositoryId":"camera_1",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/products/camera_1/addToCollections"
        }
    ],
    "id":"camera_1",
    "parentCategories":[
        {
            "repositoryId":"cat40013"
        },
        {
            "repositoryId":"cat40017"
        }
    ]
}

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| |------------------|------------------| |20007|Error assigning product to collection| |20008|Missing "collections" property| |20090|Collection Id passed is null or empty| |20091|Collection Id cat4d0013 is invalid or non-existent| |200226|Operation on product is not allowed for the custom catalog|

Body ()

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

Back to Top