Skip to content
Ideasoft
Admin API

PosCampaign

Serverhttps://your-store.myideasoft.com

PosCampaign LIST

GET
https://your-store.myideasoft.com
/admin-api/pos_campaigns
Bearer
or
OAuth 2.0

PosCampaign LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek PosCampaigns adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​string

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

q
​string

PosCampaign arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

name
​string

PosCampaign Name.

posAccount
​string

PosAccount Id filtresi

s
​string

Arama anahtarı ile filtreleme

PosCampaign LIST › Responses

The request (GET or PUT) completed successfully.

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​PosAccountSummary
​object[] · maxItems: 36

Taksit oranları listesi

status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosCampaign POST

POST
https://your-store.myideasoft.com
/admin-api/pos_campaigns
Bearer
or
OAuth 2.0

PosCampaign POST › Request Body

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​PosAccountSummary
​object[] · maxItems: 36

Taksit oranları listesi

status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosCampaign POST › Responses

The create request (POST) completed successfully.

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​PosAccountSummary
​object[] · maxItems: 36

Taksit oranları listesi

status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosCampaign COUNT

GET
https://your-store.myideasoft.com
/admin-api/pos_campaigns/count
Bearer
or
OAuth 2.0

PosCampaign COUNT › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek PosCampaigns adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​string

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

q
​string

PosCampaign arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

name
​string

PosCampaign Name.

posAccount
​string

PosAccount Id filtresi

s
​string

Arama anahtarı ile filtreleme

PosCampaign COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


PosCampaign GET

GET
https://your-store.myideasoft.com
/admin-api/pos_campaigns/{id}
Bearer
or
OAuth 2.0

PosCampaign GET › path Parameters

id
​string · pattern: \d+ · required

PosCampaign GET › Responses

The request (GET or PUT) completed successfully.

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​PosAccountSummary
​object[] · maxItems: 36

Taksit oranları listesi

status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosCampaign PUT

PUT
https://your-store.myideasoft.com
/admin-api/pos_campaigns/{id}
Bearer
or
OAuth 2.0

PosCampaign PUT › path Parameters

id
​string · pattern: \d+ · required

PosCampaign PUT › Request Body

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​PosAccountSummary
​object[] · maxItems: 36

Taksit oranları listesi

status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosCampaign PUT › Responses

The request (GET or PUT) completed successfully.

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​PosAccountSummary
​object[] · maxItems: 36

Taksit oranları listesi

status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosCampaign DELETE

DELETE
https://your-store.myideasoft.com
/admin-api/pos_campaigns/{id}
Bearer
or
OAuth 2.0

PosCampaign DELETE › path Parameters

id
​string · pattern: \d+ · required

PosCampaign DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned