Add Promotions

Request

POST http:///api/v1/partner/loyalty/promotions

Request body

The request body takes a complete PartnerAddPromotionRequest resource, containing the following writable properties:

{
    "active": "boolean",
    "consumerFacing": "boolean",
    "criteriaGroups": null,
    "dayEndTime": "int32",
    "dayStartTime": "int32",
    "discountAmt": "number",
    "discountType": "string",
    "discountUnitType": "string",
    "enableBOGO": "boolean",
    "enableDayDuration": "boolean",
    "enableLimitPerCustomer": "boolean",
    "enableMaxAvailable": "boolean",
    "endDate": "int64",
    "fri": "boolean",
    "limitPerCustomer": "int32",
    "lowerPriceBound": "number",
    "maxAvailable": "int32",
    "maxCashValue": "number",
    "memberGroupIds": [
        "string"
    ],
    "mon": "boolean",
    "name": "string",
    "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",
    "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",
    "upperPriceBound": "number",
    "usageCount": "int32",
    "wed": "boolean"
}

Properties

Name Type Description Additional
active boolean Optional
consumerFacing boolean Optional
criteriaGroups[] array Optional
dayEndTime int32 Optional
dayStartTime int32 Optional
discountAmt number Optional
discountType string

Possible values are:

  • Cash
  • Percentage
  • FinalPrice
 Optional
discountUnitType string

Possible values are:

  • UNIT
  • HALF_GRAM
  • GRAM
  • TWO_GRAMS
  • THREE_GRAMS
  • ONE_EIGHTTH
  • QUARTER
  • HALF
  • OUNCE
  • CUSTOM
  • POUND
  • FLUID_OZ
 Optional
enableBOGO boolean Optional
enableDayDuration boolean Optional
enableLimitPerCustomer boolean Optional
enableMaxAvailable boolean Optional
endDate int64 Optional
fri boolean Optional
limitPerCustomer int32 Optional
lowerPriceBound number Optional
maxAvailable int32 Optional
maxCashValue number Optional
memberGroupIds[] array of string Optional
mon boolean Optional
name string Optional
promoCodeRequired boolean Optional
promoCodes[] array of string Optional
promoDesc string Optional
promoSource string

Possible values are:

  • Manual
  • MemberGroup
 Optional
promocode string Optional
promotionType string

Possible values are:

  • Cart
  • Product
  • DeliveryFee
 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:

  • None
  • LastVisit
  • FirstTimeMember
  • LastVist
  • CartOrderMin
  • NumberMinOrders
  • ProductTag
  • ByVendor
  • ProductCategory
  • Product
  • ByBrand
  • OneFromVendors
  • OneFromCategories
  • OneFromProducts
  • OneFromProductTags
  • OneFromBrands
  • AnyFromMatching
  • OneFromMatching
 Optional
rules[].updated boolean Optional
rules[].vendorId string Optional
rules[].vendorIds[] array of string Optional
sat boolean Optional
scalable boolean 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:

  • Cash
  • Percentage
  • FinalPrice
 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:

  • None
  • LastVisit
  • FirstTimeMember
  • LastVist
  • CartOrderMin
  • NumberMinOrders
  • ProductTag
  • ByVendor
  • ProductCategory
  • Product
  • ByBrand
  • OneFromVendors
  • OneFromCategories
  • OneFromProducts
  • OneFromProductTags
  • OneFromBrands
  • AnyFromMatching
  • OneFromMatching
 Optional
target.unitWeight string

Possible values are:

  • UNIT
  • HALF_GRAM
  • GRAM
  • TWO_GRAMS
  • THREE_GRAMS
  • ONE_EIGHTTH
  • QUARTER
  • HALF
  • OUNCE
  • CUSTOM
  • POUND
  • FLUID_OZ
 Optional
target.updated boolean Optional
target.vendorId string Optional
target.vendorIds[] array of string Optional
targetPriceRange boolean Optional
thur boolean Optional
tues boolean Optional
upperPriceBound number Optional
usageCount int32 Optional
wed boolean Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

 Promotion

Explore this API

body
Request Content-Type
Response Content-Type
Try it out!