promotion28 عملية

Promotion API

Marketing campaigns, coupon codes, and gift card programs.

Queries

QUERY

activeCampaigns

#

List all active campaigns for the current tenant

يُرجع[!]!
QUERY

activeCoupons

#

List all active coupons for the current tenant

يُرجع[!]!
QUERY

campaign

#

Get a campaign by ID

الوسائط

  • id!
يُرجع
QUERY

campaignCodes

#

List coupon codes for a campaign with pagination (admin)

الوسائط

  • input!
يُرجع!
QUERY

campaignStatistics

#

Get campaign statistics (admin)

الوسائط

  • campaignId!
يُرجع!
QUERY

checkGiftCardBalance

#

Check gift card balance detail

الوسائط

  • giftCardId!
يُرجع!
QUERY

coupon

#

Get a coupon by code

الوسائط

  • codeString!
يُرجع
QUERY

exportCampaignCodes

#

Export campaign coupon codes to CSV or PDF (admin)

الوسائط

  • input!
يُرجع!
QUERY

exportGiftCards

#

Export gift cards to CSV or PDF (admin)

الوسائط

  • input
يُرجع!
QUERY

giftCard

#

Get a gift card by code

الوسائط

  • codeString!
يُرجع
QUERY

giftCardBalance

#

Get gift card balance

الوسائط

  • giftCardId!
يُرجع
QUERY

giftCardBatches

#

List gift card batches (admin)

الوسائط

  • input
يُرجع!
QUERY

listCampaigns

#

List campaigns with filtering (admin)

الوسائط

  • input
يُرجع!
QUERY

listCoupons

#

List coupons with filtering (admin)

الوسائط

  • input
يُرجع!
QUERY

listGiftCards

#

List gift cards with pagination, filtering, and sorting (admin)

الوسائط

  • input
يُرجع!
QUERY

myGiftCards

#

List gift cards for the current account

يُرجع[!]!

Mutations

MUTATION

applyCoupon

#

Apply a coupon to an order

الوسائط

  • input!
يُرجع!
MUTATION

createCampaign

#

Create a new campaign (admin only)

الوسائط

  • input!
يُرجع!
MUTATION

createCoupon

#

Create a new coupon (admin only)

الوسائط

  • input!
يُرجع!
MUTATION

createReferralCoupon

#

Create referral coupons (triggered by referral events)

الوسائط

  • input!
يُرجع!
MUTATION

deleteCampaign

#

Delete a campaign (admin only)

الوسائط

  • campaignId!
يُرجعBoolean!
MUTATION

issueGiftCard

#

Issue a new gift card (admin only)

الوسائط

  • input!
يُرجع!
MUTATION

issueGiftCardBatch

#

Issue gift cards in batch (admin only)

الوسائط

  • input!
يُرجع!
MUTATION

redeemGiftCard

#

Redeem a gift card to wallet

الوسائط

  • input!
يُرجع!
MUTATION

sendCampaignNotification

#

Send campaign notifications manually (admin only) Allows sending notifications for active campaigns: - For campaigns that didn't auto-send on activation - For re-sending notifications (e.g., follow-up reminders) - With optional delivery channel overrides

الوسائط

  • input!
يُرجع!
MUTATION

updateCampaign

#

Update a campaign (admin only)

الوسائط

  • input!
يُرجع!
MUTATION

updateCoupon

#

Update a coupon's fields (admin only)

الوسائط

  • input!
يُرجع!
MUTATION

updateCouponStatus

#

Update a coupon's status (admin only)

الوسائط

  • input!
يُرجع!