assignProducts

post

/ccadmin/v1/collections/assignProducts

Assign Products. Move, link or unlink one or more products to one or more collections.

Request

Supported Media Types
Body ()
Root Schema : assignProducts_request
Type: object
Show Source
  • collections
    Collections to link/move/unlink the products to. Note, it is not allowed to move/link 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/link for that root category will be ignored.
  • Parent collection for move operation. If specified then all products must belong to this collection. If not specified then products are moved out of all their existing parent collections.
  • Operation to perform. Can be one of: move, link or unlink.
  • products
    Products to link/move/unlink.
Example:
{
    "properties":{
        "fromParent":"Electronics",
        "collections":[
            "CategoryA",
            "CategoryB"
        ],
        "operation":"move",
        "products":[
            "ProductX",
            "ProductY"
        ]
    }
}
Nested Schema : collections
Type: array
Collections to link/move/unlink the products to. Note, it is not allowed to move/link 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/link for that root category will be ignored.
Show Source
Nested Schema : products
Type: array
Products to link/move/unlink.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : assignProducts_response
Type: object
Show Source
Example Response (application/json)
{
    "success":true
}

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| |------------------|------------------| |20089|Organize Child Internal Error| |20085|Collection does not have parent collection| |20084|Invalid index provided. Index should be -1 or greater| |20083|Child collection cannot be assigned to parent collection because it would create a circular collection structure| |20071|Collection Id is invalid or non-existent| |20070|Collection Id passed is null or empty| |20081|Cannot find child collection| |20080|Child collection passed is null| |20079|It is not allowed to move a root category| |20082|Attempt to move child to its current location| |20086|Parent collection to link is null| |20087|Parent collection to update is null| |20088|Invalid operation|
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