Methods

  • get - Get Promotion List

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "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"
        }
    ]
}

Properties

Name Type Description Additional
limit int32 Optional
skip int32 Optional
total int64 Optional
values[] array Optional
values[].active boolean Optional
values[].assigned boolean Optional
values[].companyId string Optional
values[].consumerFacing boolean Optional
values[].created int64 Optional
values[].criteriaGroups[] array Optional
values[].dayEndTime int32 Optional
values[].dayStartTime int32 Optional
values[].deleted boolean Optional
values[].dirty boolean Optional
values[].discountAmt number Optional
values[].discountType string

Possible values are:

  • Cash
  • Percentage
  • FinalPrice
Optional
values[].discountUnitType string

Possible values are:

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

Possible values are:

  • Manual
  • MemberGroup
Optional
values[].promocode string Optional
values[].promotionType string

Possible values are:

  • Cart
  • Product
  • DeliveryFee
Optional
values[].restrictMemberGroups boolean Optional
values[].rules[] array Optional
values[].rules[].brandIds[] array of string Optional
values[].rules[].categoryId string Optional
values[].rules[].categoryIds[] array of string Optional
values[].rules[].companyId string Optional
values[].rules[].created int64 Optional
values[].rules[].deleted boolean Optional
values[].rules[].id string Optional
values[].rules[].maxAmt number Optional
values[].rules[].minAmt number Optional
values[].rules[].modified int64 Optional
values[].rules[].productId string Optional
values[].rules[].productIds[] array of string Optional
values[].rules[].productTags[] array of string Optional
values[].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
values[].rules[].updated boolean Optional
values[].rules[].vendorId string Optional
values[].rules[].vendorIds[] array of string Optional
values[].sat boolean Optional
values[].scalable boolean Optional
values[].shopId string Optional
values[].stackable boolean Optional
values[].startDate int64 Optional
values[].sun boolean Optional
values[].target object PromotionTargetRule Optional
values[].target.brandIds[] array of string Optional
values[].target.categoryId string Optional
values[].target.categoryIds[] array of string Optional
values[].target.companyId string Optional
values[].target.created int64 Optional
values[].target.deleted boolean Optional
values[].target.discountAmt number Optional
values[].target.discountType string

Possible values are:

  • Cash
  • Percentage
  • FinalPrice
Optional
values[].target.id string Optional
values[].target.maxAmt number Optional
values[].target.minAmt number Optional
values[].target.modified int64 Optional
values[].target.productId string Optional
values[].target.productIds[] array of string Optional
values[].target.productTags[] array of string Optional
values[].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
values[].target.unitWeight string

Possible values are:

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

Possible values are:

  • V1
  • V2
Optional
values[].wed boolean Optional