Skip to content
Ideasoft
Admin API

Distributor

Serverhttps://your-store.myideasoft.com

Distributor LIST

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

Bu endpoint, sistemdeki distributor (entegrasyon/dağıtıcı) kayıtlarını listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi; sayfalama (limit, page), sıralama (sort), ID bazlı filtreleme (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Distributor LIST › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum Distributor sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2

Default: 1
id
​integer · min: 1

Tek bir Distributor kaydını döndürmek için kullanılabilir. Örnek: id=42

ids
​string

Birden fazla Distributor kaydını aynı anda listelemek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Örnek: sinceId=100

q
​string

Alan bazlı gelişmiş arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Acm veya q[status]=active

s
​string

Genel arama anahtar kelimesiyle (simple search) filtreleme yapar. Sistem genelindeki tanımlı alanlarda eşleşme arar. Örnek: s=istanbul

Distributor LIST › Responses

The request (GET or PUT) completed successfully.

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

Distributor POST

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

Distributor POST › Request Body

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

Distributor POST › Responses

The create request (POST) completed successfully.

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

Distributor COUNT

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

Bu endpoint, sistemdeki distributor (entegrasyon/dağıtıcı) kayıtlarını listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi; sayfalama (limit, page), sıralama (sort), ID bazlı filtreleme (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Distributor COUNT › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum Distributor sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2

Default: 1
id
​integer · min: 1

Tek bir Distributor kaydını döndürmek için kullanılabilir. Örnek: id=42

ids
​string

Birden fazla Distributor kaydını aynı anda listelemek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Örnek: sinceId=100

q
​string

Alan bazlı gelişmiş arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Acm veya q[status]=active

s
​string

Genel arama anahtar kelimesiyle (simple search) filtreleme yapar. Sistem genelindeki tanımlı alanlarda eşleşme arar. Örnek: s=istanbul

Distributor COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Distributor GET

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

Distributor GET › path Parameters

id
​string · pattern: \d+ · required

Distributor GET › Responses

The request (GET or PUT) completed successfully.

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

Distributor PUT

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

Distributor PUT › path Parameters

id
​string · pattern: \d+ · required

Distributor PUT › Request Body

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

Distributor PUT › Responses

The request (GET or PUT) completed successfully.

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

Distributor DELETE

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

Distributor DELETE › path Parameters

id
​string · pattern: \d+ · required

Distributor DELETE › Responses

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

No data returned