Jump to

• Request
• Response

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

• application/json

Body ()

Root Schema : assignProducts_request

Type: object

Show Source

• collections: array 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.
• fromParent(optional): string
  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(optional): string
  Operation to perform. Can be one of: move, link or unlink. If unspecified, default value is move
• products: array products
  Products to link/move/unlink.

{
    "properties":{
        "fromParent":{
            "description":"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.",
            "type":"string"
        },
        "collections":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "operation":{
            "description":"Operation to perform. Can be one of: move, link or unlink. If unspecified, default value is move",
            "type":"string"
        },
        "products":{
            "description":"Products to link/move/unlink.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "collections",
        "products"
    ],
    "example":{
        "fromParent":"cat40010",
        "collections":[
            "giftCards",
            "topLeaf"
        ],
        "operation":"move",
        "products":[
            "Product_13C",
            "Product_1Cii"
        ]
    }
}

Example:

{
    "fromParent":"cat40010",
    "collections":[
        "giftCards",
        "topLeaf"
    ],
    "operation":"move",
    "products":[
        "Product_13C",
        "Product_1Cii"
    ]
}

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

• Array of: string

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : products

Type: array

Products to link/move/unlink.

Show Source

• Array of: string

{
    "description":"Products to link/move/unlink.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : assignProducts_response

Type: object

Show Source

• success(optional): boolean
  true if the move operation was successful

{
    "properties":{
        "success":{
            "description":"true if the move operation was successful",
            "type":"boolean"
        }
    }
}

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

• 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