BLblaze
Blaze Partner Store - Loyalty

Get Promotion By Id

get/api/v1/partner/loyalty/promotions/{promotionId}

Request

  • Base URL
    http://api.partners.blaze.me
  • URL
    http://api.partners.blaze.me/api/v1/partner/loyalty/promotions/{promotionId}
  • Auth
    none declared

Path parameters

promotionIdstring required

Response

successful operation

idstring
createdinteger
modifiedinteger
deletedboolean
updatedboolean
companyIdstring
shopIdstring
dirtyboolean
scope'Company' | 'Shop'
companyPromoIdstring
referralCodeboolean
namestring
promoDescstring
discountType'Cash' | 'Percentage' | 'FinalPrice'
discountAmtnumber
discountUnitType'UNIT' | 'HALF_GRAM' | 'GRAM' | 'TWO_GRAMS' | 'THREE_GRAMS' | 'ONE_EIGHTTH' | 'QUARTER' | 'HALF' | 'OUNCE' | 'CUSTOM' | 'POUND' | 'FLUID_OZ' | 'MILLILITER' | 'METRC_OUNCE' | 'METRC_ONE_EIGHTH' | 'MILLIGRAM' | 'METRC_QUARTER'
promocodestring
referralPrefixstring
promoCodeRequiredboolean
consumerFacingboolean
startDateinteger
endDateinteger
activeboolean
maxAvailableinteger
usageCountinteger
enableMaxAvailableboolean
limitPerCustomerinteger
enableLimitPerCustomerboolean
restrictMemberGroupsboolean
memberGroupIdsstring[]
promotionType'Cart' | 'Product' | 'DeliveryFee' | 'BOGO' | 'Bundle' | 'VarietyBundle'
maxCashValuenumber
enableBOGOboolean
enableDayDurationboolean
dayStartTimeinteger
dayEndTimeinteger
scalableboolean
targetPriceRangeboolean
lowerPriceBoundnumber
upperPriceBoundnumber
version'V1' | 'V2' | 'V3'
referralPointsnumber
rank'Highest' | 'High' | 'Medium' | 'Low' | 'Lowest'
monboolean
tuesboolean
wedboolean
thurboolean
friboolean
satboolean
sunboolean
promoCodesstring[]
promoSource'Manual' | 'MemberGroup'
stackableboolean
importIdstring
lowestPriceFirstboolean
assignedboolean
finalizedDiscountIdstring
restrictConsumerTypesboolean
consumerTypesstring[]
salesChannelsstring[]
autoApplyboolean
enableMultiAppliesboolean
maxAppliesinteger
groupProductsBy'None' | 'Brand' | 'Category' | 'Vendor'
autoApplyRequestedboolean
enableUsageCooldownInDaysboolean
thirdPartyLoyaltyEnabledboolean
usageCooldownInDaysinteger
includeAnonymousboolean
priorityinteger
validVarietyBundleboolean

Changes

No recorded changes to this operation across all 112 revisions of this API.