Jump to

• Request
• Response

moveCollection

put

/ccadmin/v1/collections

Move Collection. Update the links from a child collection to parent categories.

Request

Supported Media Types

• application/json

Body ()

Root Schema : moveCollection_request

Type: object

Show Source

• child: string
  Child category.
• fromParent(optional): string
  Source parent collection.
• index(optional): integer
  Index in parent collection.
• operation(optional): string
  Type of link operation being performed. One of link, unlink, move, reorder or unlink-all.
• parent(optional): string
  Target parent collection.

{
    "properties":{
        "parent":{
            "description":"Target parent collection.",
            "type":"string"
        },
        "fromParent":{
            "description":"Source parent collection.",
            "type":"string"
        },
        "index":{
            "description":"Index in parent collection.",
            "type":"integer"
        },
        "operation":{
            "description":"Type of link operation being performed. One of link, unlink, move, reorder or unlink-all.",
            "type":"string"
        },
        "child":{
            "description":"Child category.",
            "type":"string"
        }
    },
    "required":[
        "child"
    ],
    "example":{
        "parent":"catMen",
        "fromParent":"cat50001",
        "operation":"move",
        "child":"cat70004"
    }
}

Example:

{
    "parent":"catMen",
    "fromParent":"cat50001",
    "operation":"move",
    "child":"cat70004"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : moveCollection_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