Jump to

• Request
• Response

batchGrantPromotions

post

/ccadmin/v1/profiles/batchGrantPromotions

Grant Promotions for Profile(s).

Request

Supported Media Types

• application/json

Header Parameters

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

Body ()

Root Schema : batchGrantPromotions_request

Type: object

Show Source

• profileIds: array profileIds
  An array of profile id(s)
• promotionIds: array promotionIds
  An array of promotion id(s)

{
    "type":"object",
    "properties":{
        "promotionIds":{
            "description":"An array of promotion id(s)",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "promo1001",
                "promo1002"
            ]
        },
        "profileIds":{
            "description":"An array of profile id(s)",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "profile1",
                "profile2"
            ]
        }
    },
    "required":[
        "profileIds",
        "promotionIds"
    ],
    "example":{
        "profileIds":[
            "profile1",
            "profile2"
        ],
        "promotionIds":[
            "promo1001",
            "promo1002"
        ]
    }
}

Example:

{
    "profileIds":[
        "profile1",
        "profile2"
    ],
    "promotionIds":[
        "promo1001",
        "promo1002"
    ]
}

Nested Schema : profileIds

Type: array

An array of profile id(s)

Show Source

• Array of: string

{
    "description":"An array of profile id(s)",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "profile1",
        "profile2"
    ]
}

Example:

[
    "profile1",
    "profile2"
]

Nested Schema : promotionIds

Type: array

An array of promotion id(s)

Show Source

• Array of: string

{
    "description":"An array of promotion id(s)",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "promo1001",
        "promo1002"
    ]
}

Example:

[
    "promo1001",
    "promo1002"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds in initiating batch grant promotions to an array of given profiles

Body

Example Response (application/json)

{
}

400 Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud. This could be due to promotions being invalid or required properties such as promotionIds and profileIds being missing. The following are the internal error codes thrown by this API when an error occurs: |Error Code|Description| |------------------|------------------| |13037|If the required properties of promotionIds, and profilesId are missing| |21171|If the promotion id is invalid|

Body

Example Response (application/json)

{
    "Status":"13037",
    "Message":"Missing required property: promotionIds"
}

401 Response

The following response occurs if there is not a valid bearer token present in request authorization header

Body

Example Response (application/json)

{
    "errorCode":"60006000",
    "message":"The user is not authenticated.",
    "status":"401"
}

Back to Top