SearchResultLoyaltyReward resource

Methods

  • get - Get Rewards List

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "active": "boolean",
            "assigned": "boolean",
            "categoryIds": [
                "string"
            ],
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "detail": "string",
            "dirty": "boolean",
            "discountAmt": "number",
            "discountType": "string",
            "discountUnitType": "string",
            "endDate": "int64",
            "finalizedDiscountId": "string",
            "id": "string",
            "loyaltyType": "string",
            "modified": "int64",
            "name": "string",
            "points": "int32",
            "priority": "int32",
            "productIds": [
                "string"
            ],
            "productTags": [
                "string"
            ],
            "promotionId": "string",
            "published": "boolean",
            "publishedDate": "int64",
            "rewardNo": "string",
            "rewardTarget": "string",
            "shopId": "string",
            "slug": "string",
            "startDate": "int64",
            "unpublishedDate": "int64",
            "updated": "boolean",
            "vendorIds": [
                "string"
            ]
        }
    ]
}

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[].categoryIds[] array of string Optional
values[].companyId string Optional
values[].created int64 Optional
values[].deleted boolean Optional
values[].detail string 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[].endDate int64 Optional
values[].finalizedDiscountId string Optional
values[].id string Optional
values[].loyaltyType string

Possible values are:

  • Regular
  • Promotion
 Optional
values[].modified int64 Optional
values[].name string Optional
values[].points int32 Optional
values[].priority int32 Optional
values[].productIds[] array of string Optional
values[].productTags[] array of string Optional
values[].promotionId string Optional
values[].published boolean Optional
values[].publishedDate int64 Optional
values[].rewardNo string Optional
values[].rewardTarget string

Possible values are:

  • WholeCart
  • DeliveryFee
  • AllSelectedProducts
  • OneFromProducts
  • OneFromCategories
  • OneFromVendors
  • OneFromProductTags
 Optional
values[].shopId string Optional
values[].slug string Optional
values[].startDate int64 Optional
values[].unpublishedDate int64 Optional
values[].updated boolean Optional
values[].vendorIds[] array of string Optional