T-SOFT/Admin API/Kampanyalar

Kampanyalar

Kapsam: okuma read_discounts, oluşturma/güncelleme/silme write_discounts. Kampanya uçları mağazada kampanya lisansı ister; lisans yoksa 403 döner.

Kampanyalar

UçMetotKapsam
campaign/campaignsGET, POSTread_discounts / write_discounts
campaign/campaigns/{id}GET, PATCH, DELETEread_discounts / write_discounts
GET /campaign/campaigns
curl 'https://magaza.com/api/v3/admin/2026-01/campaign/campaigns?filter[status]=1&include=includes,promotions' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Accept: application/vnd.api+json'

Başlıca alanlar:

AlanAçıklama
name, adminNameMüşteriye ve panele görünen ad
codeKampanya kodu
statusDurum
startDate, finishDateBaşlangıç ve bitiş (Unix zaman damgası, saniye)
weekdays, hoursGeçerli günler ve saatler
hasCoupon, coupon, maxCouponCountKupon kodlu kampanya ayarları
count, maxCount, maxCountPerCustomerKullanım sayısı ve sınırları
logicalGroup, priorityBirlikte uygulanma grubu ve önceliği
cargoFreeKargo bedava
customerFilterType, customerFilterIdsKampanyanın geçerli olduğu müşteri kümesi
includeItems, excludeItems, promotionItemsKoşul, hariç tutma ve kazanım satırları

Filtreler: id, status, code (virgülle birden fazla), name, adminName, hasCoupon. Koşul ve kazanım satırları includes, excludes, promotions ilişkilerinden de okunabilir.

Kampanya oluşturma

name, startDate, finishDate ve weekdays zorunludur. Koşul ve kazanım satırları kampanya gövdesindeki includeItems, excludeItems ve promotionItems dizileriyle yazılır; ayrı bir satır ucu yoktur. Kampanyayı kopyalamak için POST /campaign/campaigns/{id}/-actions/replicate.

Kampanya kuralları karmaşıktır. Yeni bir kampanya tipi kurmadan önce aynı kampanyayı panelde kurup GET /campaign/campaigns/{id} yanıtını şablon olarak kullanın.

Hediye çekleri

campaign/gift-codes: bir kampanyaya bağlı tekil kodlar. Okuma read_discounts, yazma write_discounts.

AlanAçıklama
codeÇek kodu (en az 4 karakter, tekil)
campaignIdBağlı kampanya
customerIdÇekin bağlı olduğu müşteri
discountType, variable1İndirim türü (percent ya da price) ve tutarı
countKullanım hakkı
statusKullanılabilir mi
finishDateSon kullanma zamanı
createdOrderIdÇekin kullanıldığı sipariş
POST /campaign/gift-codes
curl -X POST 'https://magaza.com/api/v3/admin/2026-01/campaign/gift-codes' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{"data": {"type": "gift-codes", "attributes": {"campaignId": 19, "code": "HOSGELDIN-8F2K", "discountType": "price", "variable1": 100, "count": 1}}}'

Filtreler: id, code, status, campaignId, customerId, discountType, finishDate.