PUT http:///api/v1/partner/loyalty/promotions/{promotionId}
Parameter name | Value | Description | Additional |
---|---|---|---|
promotionId | string | Required |
The request body takes a complete Promotion resource, containing the following writable properties:
{
"active": "boolean",
"assigned": "boolean",
"companyId": "string",
"consumerFacing": "boolean",
"created": "int64",
"criteriaGroups": null,
"dayEndTime": "int32",
"dayStartTime": "int32",
"deleted": "boolean",
"dirty": "boolean",
"discountAmt": "number",
"discountType": "string",
"discountUnitType": "string",
"enableBOGO": "boolean",
"enableDayDuration": "boolean",
"enableLimitPerCustomer": "boolean",
"enableMaxAvailable": "boolean",
"endDate": "int64",
"finalizedDiscountId": "string",
"fri": "boolean",
"id": "string",
"importId": "string",
"limitPerCustomer": "int32",
"lowerPriceBound": "number",
"lowestPriceFirst": "boolean",
"maxAvailable": "int32",
"maxCashValue": "number",
"memberGroupIds": [
"string"
],
"modified": "int64",
"mon": "boolean",
"name": "string",
"priority": "int32",
"promoCodeRequired": "boolean",
"promoCodes": [
"string"
],
"promoDesc": "string",
"promoSource": "string",
"promocode": "string",
"promotionType": "string",
"restrictMemberGroups": "boolean",
"rules": [
{
"brandIds": [
"string"
],
"categoryId": "string",
"categoryIds": [
"string"
],
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"maxAmt": "number",
"minAmt": "number",
"modified": "int64",
"productId": "string",
"productIds": [
"string"
],
"productTags": [
"string"
],
"ruleType": "string",
"updated": "boolean",
"vendorId": "string",
"vendorIds": [
"string"
]
}
],
"sat": "boolean",
"scalable": "boolean",
"shopId": "string",
"stackable": "boolean",
"startDate": "int64",
"sun": "boolean",
"target": {
"brandIds": [
"string"
],
"categoryId": "string",
"categoryIds": [
"string"
],
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"discountAmt": "number",
"discountType": "string",
"id": "string",
"maxAmt": "number",
"minAmt": "number",
"modified": "int64",
"productId": "string",
"productIds": [
"string"
],
"productTags": [
"string"
],
"ruleType": "string",
"unitWeight": "string",
"updated": "boolean",
"vendorId": "string",
"vendorIds": [
"string"
]
},
"targetPriceRange": "boolean",
"thur": "boolean",
"tues": "boolean",
"updated": "boolean",
"upperPriceBound": "number",
"usageCount": "int32",
"version": "string",
"wed": "boolean"
}
Name | Type | Description | Additional |
---|---|---|---|
active | boolean | Optional | |
assigned | boolean | Optional | |
companyId | string | Optional | |
consumerFacing | boolean | Optional | |
created | int64 | Optional | |
criteriaGroups[] | array | Optional | |
dayEndTime | int32 | Optional | |
dayStartTime | int32 | Optional | |
deleted | boolean | Optional | |
dirty | boolean | Optional | |
discountAmt | number | Optional | |
discountType | string |
Possible values are:
|
Optional |
discountUnitType | string |
Possible values are:
|
Optional |
enableBOGO | boolean | Optional | |
enableDayDuration | boolean | Optional | |
enableLimitPerCustomer | boolean | Optional | |
enableMaxAvailable | boolean | Optional | |
endDate | int64 | Optional | |
finalizedDiscountId | string | Optional | |
fri | boolean | Optional | |
id | string | Optional | |
importId | string | Optional | |
limitPerCustomer | int32 | Optional | |
lowerPriceBound | number | Optional | |
lowestPriceFirst | boolean | Optional | |
maxAvailable | int32 | Optional | |
maxCashValue | number | Optional | |
memberGroupIds[] | array of string | Optional | |
modified | int64 | Optional | |
mon | boolean | Optional | |
name | string | Optional | |
priority | int32 | Optional | |
promoCodeRequired | boolean | Optional | |
promoCodes[] | array of string | Optional | |
promoDesc | string | Optional | |
promoSource | string |
Possible values are:
|
Optional |
promocode | string | Optional | |
promotionType | string |
Possible values are:
|
Optional |
restrictMemberGroups | boolean | Optional | |
rules[] | array | Optional | |
rules[].brandIds[] | array of string | Optional | |
rules[].categoryId | string | Optional | |
rules[].categoryIds[] | array of string | Optional | |
rules[].companyId | string | Optional | |
rules[].created | int64 | Optional | |
rules[].deleted | boolean | Optional | |
rules[].id | string | Optional | |
rules[].maxAmt | number | Optional | |
rules[].minAmt | number | Optional | |
rules[].modified | int64 | Optional | |
rules[].productId | string | Optional | |
rules[].productIds[] | array of string | Optional | |
rules[].productTags[] | array of string | Optional | |
rules[].ruleType | string |
Possible values are:
|
Optional |
rules[].updated | boolean | Optional | |
rules[].vendorId | string | Optional | |
rules[].vendorIds[] | array of string | Optional | |
sat | boolean | Optional | |
scalable | boolean | Optional | |
shopId | string | Optional | |
stackable | boolean | Optional | |
startDate | int64 | Optional | |
sun | boolean | Optional | |
target | object | PromotionTargetRule | Optional |
target.brandIds[] | array of string | Optional | |
target.categoryId | string | Optional | |
target.categoryIds[] | array of string | Optional | |
target.companyId | string | Optional | |
target.created | int64 | Optional | |
target.deleted | boolean | Optional | |
target.discountAmt | number | Optional | |
target.discountType | string |
Possible values are:
|
Optional |
target.id | string | Optional | |
target.maxAmt | number | Optional | |
target.minAmt | number | Optional | |
target.modified | int64 | Optional | |
target.productId | string | Optional | |
target.productIds[] | array of string | Optional | |
target.productTags[] | array of string | Optional | |
target.ruleType | string |
Possible values are:
|
Optional |
target.unitWeight | string |
Possible values are:
|
Optional |
target.updated | boolean | Optional | |
target.vendorId | string | Optional | |
target.vendorIds[] | array of string | Optional | |
targetPriceRange | boolean | Optional | |
thur | boolean | Optional | |
tues | boolean | Optional | |
updated | boolean | Optional | |
upperPriceBound | number | Optional | |
usageCount | int32 | Optional | |
version | string |
Possible values are:
|
Optional |
wed | boolean | Optional |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK successful operation |
Promotion |