Jump to

• Request
• Response

updateStackingRule

put

/ccadmin/v1/stackingRules/{id}

Update Stacking Rule. Update an existing stacking rule. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID corresponding to the stacking rule to udpate.

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request

Body ()

Root Schema : updateStackingRule_request

Type: object

Show Source

• displayName: string
  The display name of the stacking rule.
• excludedStackingRules(optional): array excludedStackingRules
  The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules
• maxPromotions: integer
  The maximum number of promotions allowed per stacking rule. Default is -1 indicates unlimited.
• promotions(optional): array promotions
  The promotion's repository id/s that we want to set the stacking rule on.

{
    "properties":{
        "promotions":{
            "description":"The promotion's repository id/s that we want to set the stacking rule on.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The promotion's repository id",
                        "type":"string"
                    }
                }
            }
        },
        "maxPromotions":{
            "description":"The maximum number of promotions allowed per stacking rule. Default is -1 indicates unlimited.",
            "type":"integer"
        },
        "displayName":{
            "description":"The display name of the stacking rule.",
            "type":"string"
        },
        "excludedStackingRules":{
            "description":"The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The stacking rules's repository id",
                        "type":"string"
                    }
                }
            }
        }
    },
    "required":[
        "maxPromotions",
        "displayName"
    ],
    "example":{
        "promotions":[
            {
                "repositoryId":"promo10001"
            },
            {
                "repositoryId":"promo10002"
            }
        ],
        "maxPromotions":10,
        "displayName":"10% Off Orders Over $100 stacking rule",
        "excludedStackingRules":[
            {
                "repositoryId":"stack10001"
            },
            {
                "repositoryId":"stack10002"
            }
        ]
    }
}

Example:

{
    "promotions":[
        {
            "repositoryId":"promo10001"
        },
        {
            "repositoryId":"promo10002"
        }
    ],
    "maxPromotions":10,
    "displayName":"10% Off Orders Over $100 stacking rule",
    "excludedStackingRules":[
        {
            "repositoryId":"stack10001"
        },
        {
            "repositoryId":"stack10002"
        }
    ]
}

Nested Schema : excludedStackingRules

Type: array

The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules

Show Source

• Array of: object items

{
    "description":"The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The stacking rules's repository id",
                "type":"string"
            }
        }
    }
}

Nested Schema : promotions

Type: array

The promotion's repository id/s that we want to set the stacking rule on.

Show Source

• Array of: object items

{
    "description":"The promotion's repository id/s that we want to set the stacking rule on.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The promotion's repository id",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  The stacking rules's repository id

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The stacking rules's repository id",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  The promotion's repository id

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The promotion's repository id",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateStackingRule_response

Type: object

Show Source

• displayName(optional): string
  The display name of the stacking rule.
• excludedStackingRules(optional): array excludedStackingRules
  The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules
• id(optional): string
  The stacking rule id.
• maxPromotions(optional): integer
  The maximum number of promotions allowed per stacking rule. Default is -1 indicates unlimited.
• promotions(optional): array promotions
  The promotion's repository id/s that we want to set the stacking rule on.

{
    "properties":{
        "promotions":{
            "description":"The promotion's repository id/s that we want to set the stacking rule on.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The promotion's repository id",
                        "type":"string"
                    }
                }
            }
        },
        "maxPromotions":{
            "description":"The maximum number of promotions allowed per stacking rule. Default is -1 indicates unlimited.",
            "type":"integer"
        },
        "displayName":{
            "description":"The display name of the stacking rule.",
            "type":"string"
        },
        "id":{
            "description":"The stacking rule id.",
            "type":"string"
        },
        "excludedStackingRules":{
            "description":"The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The stacking rules's repository id",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : excludedStackingRules

Type: array

The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules

Show Source

• Array of: object items

{
    "description":"The stacking rules's repository id/s that we don't want combine with the current stacking rule. If the array is empty, that means this stackingRule can be combined with all stackingRules",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The stacking rules's repository id",
                "type":"string"
            }
        }
    }
}

Nested Schema : promotions

Type: array

The promotion's repository id/s that we want to set the stacking rule on.

Show Source

• Array of: object items

{
    "description":"The promotion's repository id/s that we want to set the stacking rule on.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The promotion's repository id",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  The stacking rules's repository id

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The stacking rules's repository id",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  The promotion's repository id

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The promotion's repository id",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "promotions":[
        {
            "repositoryId":"promo10001"
        },
        {
            "repositoryId":"promo10002"
        }
    ],
    "maxPromotions":10,
    "displayName":"10% Off Orders Over $100 stacking rule",
    "repositoryId":"stack10002",
    "id":"stack10002",
    "excludedStackingRules":[
        {
            "repositoryId":"stack10001"
        },
        {
            "repositoryId":"stack10002"
        }
    ]
}

412 Response

ETag mismatch. Asset has been updated by another user.

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| |------------------|------------------| |21184|Stacking Rule not found for the given id: {nonExisting id}| |21171|No item found for the following type and ID: stackingRule, dd| |21182|The value "invalid" for property "maxPromotions" is not a valid number|

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