IdeaSoft API API Reference
Sıkça Sorulan Sorular
Sizlerden sıkça gelen sorulan soruları buradan görüntüleyerek, sorularınıza daha hızlı cevap bulabilirsiniz.
Destek Sistemi
API ile ilgili tüm sorularınız için bizimle [email protected] adresimiz üzerinden iletişime geçebilirsiniz. Sizlere yardımcı olmaktan mutluluk duyarız.
IdeaSoft API kullanmak için ihtiyaç duyacağınız bilgileri bu dökümanda sizler için topladık. Navigasyon bölmesinden bilgi almak istediğiniz servislere gidebilir örnek istekleri, cevapları ve istek parametrelerini detaylıca görebilirsiniz. Servisin size dönmüş olduğu cevaptaki ilgili nesneyi cevaplar kısmında nesnenin ismine tıklayarak detaylı bir şekilde inceleyebilir her bir özelliğiyle ilgili detaylı açıklamalar bulabilirsiniz.
API Endpoint
https://magaza-adiniz.myideasoft.com/apiHizmet Şartları: http://www.ideasoft.com.tr/terms
İletişim: [email protected]
Şemalar: https
Versiyon: 2.2.0
Yetkilendirme
OAuth2
Yetkilendirme Dökümanı kısmında detaylı açıklama bulabilirsiniz.
authorization_codeTanım
IdeaShop API, authentication için OAuth2 standardını kullanır. Oauth2; kullanıcıların kullandığı uygulamalardan kendi özel hesaplarına (Facebook,github vs) sınırlı olarak ulaşmalarına yardımcı olan bir yetkilendirme sistemidir. Burada asıl amaç, kullanıcının kaynak dosyasından bilgilerini çekmek için kullanıcı adı ve parolasını almadan, gerekli parametreleri göndererek bilgilerine ulaşmayı sağlamaktır.
Gerekli Bilgiler
Uygulamanızın yetkilendirilmesi üç bilgiye ihtiyacınız vardır:
| Parametre | Açıklama |
|---|---|
| Client ID | Uygulamanız için atanan rastgele yaratılmış bir string. Bu bilgi açıktır. |
| Client Secret | Uygulamanız için özel yaratılmış bir string. Bu bilgi gizli tutulmalıdır |
| Redirect URI | Kullanıcının uygulamanıza yetki verdikten sonra geri dönmesi gereken adres. |
Not: Bu üç bilginin de önceden sistemimizde kayıtlı olması gereklidir. Admin panelinden Entegrasyonlar->API->Ekle yolu izlendiği takdirde 'Redirect URL' kullanıcının tercihine göre, 'Client ID' ve 'Client Secret' ise sistem tarafından otomatik olarak üretilecektir.
Yetkilendirme İşlemleri
IdeaShop API yetkilendirmesi için authorization_code yöntemi kullanılmaktadır:
authorization_codeyönteminde kullanıcı özel bir sayfaya yönlendirilir ve uygulamaya izin vermesi istenir. Kullanıcı adı ve parola gerekmez
authorization_code yöntemi için işlem dört aşamada gerçekleştirilir. Bu dört aşama her uygulama için sadece bir kere izlenir ve bu aşamalarla uygulamaya gerekli izinleri verme yetkisi sadece site yöneticisindedir. Bu aşamaları gerektiği gibi takip eden site yöneticisi Entegrasyonlar->API->İzin Yönetimi->Ekle yolu ile istediği uygulama için istediği kullanıcılara API erişimini açabilir.
1. Yetki sayfasına geliş
Uygulamanıza yetki vermesini istediğiniz IdeaShop kullanıcısını, uygulamanızı tanımlayan bilgiler ile beraber yetki sayfasına yönlendirmeniz gerekmektedir.
GET http://<site_adresi>/admin/user/auth/| Parametre | Açıklama |
|---|---|
| client_id | Yukarıda tanımlanan Client ID değeri |
| response_type | Dogrulama için kullanılacak yöntem. Geçerli değerler: (code) |
| state | İstek için rastgele yaratılmış bir kod. (Üçüncü adımda kontrol edilmelidir) |
| redirect_uri | Yukarıda tanımlanan Redirect URI değeri. Onaydan sonra kullanıcı bu adrese yönlendirilecektir |
Örnek Sorgu:
GET http://www.ideashopgiyim.com/admin/user/auth
?client_id=7_7d67dc7597f034d63775c1d9ae5d9ac7f5750197f
&response_type=code
&state=2b33fdd45jbevd6nam
&redirect_uri=http://client.example-app.com/auth
HTTP/1.1
2. Yetki izni sayfası
Kullanıcı, IdeaShop admin panelindeki yetki izin ekranına gelir. Burada uygulamanızın adı ve izinleri görülür. Kullanıcı isterse uygulamaya yetki verebilir veya reddedebilir.
3. Uygulama sayfasına geri geliş
Bu aşamada, kullanıcı daha önce verdiğiniz redirect_uri adresine yönlendirilir. Duruma göre GET parametrelerinde aşağıdaki değerler bulunacaktır. Uygulamanız, bu değerleri dikkate alarak token almak, uyarı vermek vb. işlemleri gerçekleştirmelidir.
GET http://<redirect_uri'de_verdiğiniz_adres>| Parametre | Açıklama |
|---|---|
| error | Hata kodu |
| error_description | Hata açıklaması |
| state | Birinci adımda verilen kod. (Man In The Middle tipi saldırılardan korunmak için bu değerin doğruluğunu kontrol etmeniz gereklidir) |
| code | Dördüncü adımda token almak için kullanılacak kimlik doğrulama kodu. Geçerlilik süresi 30 saniyedir |
Örnek Sorgu (Başarılı):
GET http://client.example-app.com/auth
?state=2b33fdd45jbevd6nam
&code=Q0ODMI2OGYjMjBkN2mJmYzNkOTE4gzMGRhZDZTcykyOGQ3M2M2YTU2ZGVlMzE2MzB2MYkc5NWzE0ZWNiYjI2MA
HTTP/1.1
error ve error_description değerleri sadece hata durumunda gönderilir. Gönderilebilecek hatalar aşağıdaki gibidir
| error | Açıklama | Açıklama |
|---|---|---|
| invalid_grant | Kullanılan yetkilendirme yöntemi geçersiz | |
| access_denied | "The user denied access to your application." | Kullanıcı uygulamanıza yetki vermemeyi seçtiğinde gönderilir |
Örnek Sorgu (Başarısız):
GET http://client.example-app.com/auth
?error=access_denied
&error_description=The%20user%20denied%20access%20to%20your%20application
&state=2b33fdd45jbevd6nam
HTTP/1.1
4. Token isteği
Bu adımda uygulama, kullanıcıdan bağımsız olarak sunucuya doğrudan istek göndererek "Access Token" ve "Refresh Token" bilgilerini alır.
POST http://<magaza-adiniz>.myideasoft.com/oauth/v2/token| Parametre | Açıklama |
|---|---|
| grant_type | Dogrulama için kullanılmakta olan yöntem. Geçerli değer: authorization_code |
| client_id | Yukarıda tanımlanan Client ID değeri |
| client_secret | Yukarıda tanımlanan Client Secret değeri |
| code | Üçüncü adımda elde edilen kimlik doğrulama kodu |
| redirect_uri | Yukarıda tanımlanan Redirect URI değeri |
Örnek Sorgu (authorization_code yöntemi için):
POST http://www.ideashopgiyim.com/oauth/v2/token
?grant_type=authorization_code
&client_id=7_7d67dc7597f034d63775c1d9ae5d9ac7f5750197f
&client_secret=1sowg0oogc4wg4w4o4gh4va57gggwskkgo08m44ksog8kmu88o
&code=Q0ODMI2OGYjMjBkN2mJmYzNkOTE4gzMGRhZDZTcykyOGQ3M2M2YTU2ZGVlMzE2MzB2MYkc5NWzE0ZWNiYjI2MA
&redirect_uri=http%3A//client.example-app.com%2Fauth%2F
HTTP/1.1
Token isteği başarılı olursa HTTP 200 kodu ile aşağıdakine benzer bir JSON objesi dönecektir:
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 286
{
"access_token": "OGE3MzkxNDlhOGY0M2RjZWM1MWI2MWIxZjRmNDJhZThiOGJkOWZlMWIwNzVkYWFlOWFiMDAxYzkwMDlmMDhlMw",
"expires_in": 21600,
"token_type": "bearer",
"scope": "Sahip olduğunuz izinler burada görüntülünecektir.",
"refresh_token": "NjczY2E2NzZiNDJjZWI5NTE2YjZhNTlhYTJmOTQ5MjljN2MwNmUxM2MzODc5YTE4OGVjMDdlYTBiMzY1MWI1Mw"
}
Başarısız istek HTTP 400 kodu ile dönecek ve error ve error_description parametrelerini içeren bir JSON objesi bulunduracaktır. Muhtemel hata kodları aşağıdaki gibidir:
| error | error_description | Açıklama |
|---|---|---|
| invalid_request | Invalid grant_type parameter or parameter missing | grant_type değeri eksik veya geçersiz |
| invalid_request | Missing parameter. "code" is required | code değeri eksik |
| invalid_request | The redirect URI parameter is required | redirect_uri değeri eksik |
| unauthorized_client | The grant type is unauthorized for this client_id | Kullandığınız grant_type uygulamanız için geçersiz |
| invalid_client | The client credentials are invalid | Verilen client_id veya client_secret değeri doğru değil |
| invalid_grant | Code doesn't exist or is invalid for the client | Verilen code değeri doğru değil |
| redirect_uri_mismatch | The redirect URI is missing or do not match | redirect_uri değeri doğru değil |
| invalid_grant | The authorization code has expired | Verilen code değerinin kullanım süresi dolmuş |
Alınan Access Token bundan sonraki bütün API çağrılarında kullanılacaktır. Geçerlilik süresi 6 Saat 'dir.
Access Token'in geçerlilik süresi dolduğunda Refresh Token kullanılarak yeni bir Access Token alınabilir. Ayrıca Refresh Token ile yapılan her Access Token talebinde Refresh Token yenilenecektir. Doğru bir kurgu ile Refresh Token ve Access Token düzenli olarak yenilendiği takdirde herhangi bir yeniden yetkilendirme süreci gerekmeyecektir.
Örnek Sorgu (refresh_token yöntemi için):
POST http://www.ideashopgiyim.com/oauth/v2/token
?grant_type=refresh_token
&client_id=7_7d67dc7597f034d63775c1d9ae5d9ac7f5750197f
&client_secret=1sowg0oogc4wg4w4o4gh4va57gggwskkgo08m44ksog8kmu88o
&refresh_token=NjczY2E2NzZiNDJjZWI5NTE2YjZhNTlhYTJmOTQ5MjljN2MwNmUxM2MzODc5YTE4OGVjMDdlYTBiMzY1MWI1Mw
HTTP/1.1
Token isteği başarılı olursa HTTP 200 kodu ile aşağıdakine benzer bir JSON objesi dönecektir:
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 286
{
"access_token": "MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3",
"expires_in": 21600,
"token_type": "bearer",
"scope": "Sahip olduğunuz izinler burada görüntülünecektir.",
"refresh_token": "OWJlYjM3YmQxMDdlYjY5M2Q4NjRkMzRhMjhjZTkxYWY0ZTk2OTE1ZDQ2Zjc0ODg1YTdjMzNkZWQzMzkyMGJhOA"
}
Refresh Token geçerlilik süresi 2 Ay 'dır. Bu süreden sonra, tekrar yetki verilmesi gereklidir
Bölgeler (Region)
Bölgeler, IdeaSoft üzerinde tanımlı, Türkiye'nin yedi coğrafi bölgesine ait veriler içerir. Ek olarak Kıbrıs bilgisini de içerir.
Bölge Listesi Alma
GET /regionsBölge listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Bölge adı
İstek Örneği
GET /api/regions HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Bölge listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 36
total_count: 5
[
{
"id": 123,
"name": "Marmara"
}
]| others_read | Diğer okuma izni. |
Bölge Alma
GET /regions/{id}İlgili Bölgeyi getirir.
Bölge nesnesinin id değeri
İstek Örneği
GET /api/regions/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Bölge alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 36
{
"id": 123,
"name": "Marmara"
}| others_read | Diğer okuma izni. |
Cari Hesaplar (CurrentAccount)
IdeaSoft mağaza sahibi Cari Hesapları kullanarak seçilen üye için bir kredi hesabı oluşturabilir. Ayrıca mağaza sahibi 'riskLimit' parametresi ile kredi limiti koyabilir ve bakiyeyi belirleyebilir.
Cari Hesap Listesi Alma
GET /current_accountsCari Hesap listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Cari Hesap kodu
255 karakter olmalıdır)Cari Hesap başlığı
createdAt değeri için başlangıç tarihi
createdAt değeri için bitiş tarihi
updatedAt değeri için başlangıç tarihi
updatedAt değeri için bitiş tarihi
İlgili üye
İstek Örneği
GET /api/current_accounts HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Cari Hesap listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 244
total_count: 5
[
{
"id": 123,
"code": "cari-hesap-kod-ornegi",
"title": "Cari Hesap Başlığı",
"balance": 155.5,
"riskLimit": 155.5,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"member": {
"id": 123
}
}
]| others_read | Diğer okuma izni. |
Cari Hesap Oluşturma
POST /current_accountsYeni bir Cari Hesap oluşturur.
Cari Hesap nesnesi
İstek Örneği
POST /api/current_accounts HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 145
{
"code": "cari-hesap-kod-ornegi",
"title": "Cari Hesap Başlığı",
"balance": 155.5,
"riskLimit": 155.5,
"member": {
"id": 123
}
}Cari Hesap oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 244
{
"id": 123,
"code": "cari-hesap-kod-ornegi",
"title": "Cari Hesap Başlığı",
"balance": 155.5,
"riskLimit": 155.5,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"member": {
"id": 123
}
}| others_write | Diğer okuma / yazma izni. |
Cari Hesap Güncelleme
PUT /current_accounts/{id}İlgili Cari Hesabı günceller.
Cari Hesap nesnesi
Cari Hesap nesnesinin id değeri
İstek Örneği
PUT /api/current_accounts/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 158
{
"id": 123,
"code": "cari-hesap-kod-ornegi",
"title": "Cari Hesap Başlığı",
"balance": 155.5,
"riskLimit": 155.5,
"member": {
"id": 123
}
}Cari Hesap güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 244
{
"id": 123,
"code": "cari-hesap-kod-ornegi",
"title": "Cari Hesap Başlığı",
"balance": 155.5,
"riskLimit": 155.5,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"member": {
"id": 123
}
}| others_write | Diğer okuma / yazma izni. |
Cari Hesap Alma
GET /current_accounts/{id}İlgili Cari Hesabı getirir.
Cari Hesap nesnesinin id değeri
İstek Örneği
GET /api/current_accounts/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Cari Hesap alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 244
{
"id": 123,
"code": "cari-hesap-kod-ornegi",
"title": "Cari Hesap Başlığı",
"balance": 155.5,
"riskLimit": 155.5,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"member": {
"id": 123
}
}| others_read | Diğer okuma izni. |
Cari Hesap Silme
DELETE /current_accounts/{id}Kalıcı olarak ilgili Cari Hesabı siler.
Cari Hesap nesnesinin id değeri
İstek Örneği
DELETE /api/current_accounts/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| others_write | Diğer okuma / yazma izni. |
Distribütörler (Distributor)
Seçilen ürün için ekstra distribütörler tanımlanabilir. Distribütörler servisi altında yeni distribütörler oluşturulabilir, silinebilir veya değiştirilebilir.
Distribütör Listesi Alma
GET /distributorsDistribütör listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Distribütör adı.
255 karakter olmalıdır) (/^[A-Z0-9._%+-][email protected][A-Z0-9.-]+\.[A-Z]{2,4}$/)Distribütör email adresi
255 karakter olmalıdır)Distribütör telefonu
255 karakter olmalıdır)Distribütör sorumlu kişi
İstek Örneği
GET /api/distributors HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Distribütör listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
total_count: 5
[
{
"id": 123,
"name": "Kırtasiye Tedarik",
"email": "[email protected]",
"phone": "+90 (544) 444 44 44",
"contactPerson": "Richard Roe"
}
]| catalog_read | Katalog okuma izni. |
Distribütör Oluşturma
POST /distributorsYeni bir Distribütör oluşturur.
Distribütör nesnesi
İstek Örneği
POST /api/distributors HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 141
{
"name": "Kırtasiye Tedarik",
"email": "[email protected]",
"phone": "+90 (544) 444 44 44",
"contactPerson": "Richard Roe"
}Distribütör oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
{
"id": 123,
"name": "Kırtasiye Tedarik",
"email": "[email protected]",
"phone": "+90 (544) 444 44 44",
"contactPerson": "Richard Roe"
}| catalog_write | Katalog okuma / yazma izni. |
Distribütör Güncelleme
PUT /distributors/{id}İlgili Distribütörü günceller.
Distribütör nesnesi
Distribütör nesnesinin id değeri
İstek Örneği
PUT /api/distributors/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
{
"id": 123,
"name": "Kırtasiye Tedarik",
"email": "[email protected]",
"phone": "+90 (544) 444 44 44",
"contactPerson": "Richard Roe"
}Distribütör güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
{
"id": 123,
"name": "Kırtasiye Tedarik",
"email": "[email protected]",
"phone": "+90 (544) 444 44 44",
"contactPerson": "Richard Roe"
}| catalog_write | Katalog okuma / yazma izni. |
Distribütör Alma
GET /distributors/{id}İlgili Distribütörü getirir.
Distribütör nesnesinin id değeri
İstek Örneği
GET /api/distributors/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Distribütör alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
{
"id": 123,
"name": "Kırtasiye Tedarik",
"email": "[email protected]",
"phone": "+90 (544) 444 44 44",
"contactPerson": "Richard Roe"
}| catalog_read | Katalog okuma izni. |
Distribütör Silme
DELETE /distributors/{id}Kalıcı olarak ilgili Distribütörü siler.
Distribütör nesnesinin id değeri
İstek Örneği
DELETE /api/distributors/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Distribütör Ürün Bağları (DistributorToProduct)
Distribütör Ürün Bağları ile Distribütör ve Ürün ilişkisi tanımlanır.
Distribütör Ürün Bağı Listesi Alma
GET /distributor_to_productsDistribütör Ürün Bağı listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Distribütör id
0 değerinden büyük olmalıdır)Ürün id
İstek Örneği
GET /api/distributor_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Distribütör Ürün Bağı listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 120
total_count: 5
[
{
"id": 123,
"distributor": {
"id": 123,
"name": "Kırtasiye Tedarik"
},
"product": {
"id": 123
}
}
]| catalog_read | Katalog okuma izni. |
Distribütör Ürün Bağı Oluşturma
POST /distributor_to_productsYeni bir Distribütör Ürün Bağı oluşturur.
Distribütör Ürün Bağı nesnesi
İstek Örneği
POST /api/distributor_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 74
{
"distributor": {
"id": 123
},
"product": {
"id": 123
}
}Distribütör Ürün Bağı oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 120
{
"id": 123,
"distributor": {
"id": 123,
"name": "Kırtasiye Tedarik"
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Distribütör Ürün Bağı Güncelleme
PUT /distributor_to_products/{id}İlgili Distribütör Ürün Bağını günceller.
Distribütör Ürün Bağı nesnesi
Distribütör Ürün Bağı nesnesinin id değeri
İstek Örneği
PUT /api/distributor_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 87
{
"id": 123,
"distributor": {
"id": 123
},
"product": {
"id": 123
}
}Distribütör Ürün Bağı güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 120
{
"id": 123,
"distributor": {
"id": 123,
"name": "Kırtasiye Tedarik"
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Distribütör Ürün Bağı Alma
GET /distributor_to_products/{id}İlgili Distribütör Ürün Bağını getirir.
Distribütör Ürün Bağı nesnesinin id değeri
İstek Örneği
GET /api/distributor_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Distribütör Ürün Bağı alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 120
{
"id": 123,
"distributor": {
"id": 123,
"name": "Kırtasiye Tedarik"
},
"product": {
"id": 123
}
}| catalog_read | Katalog okuma izni. |
Distribütör Ürün Bağı Silme
DELETE /distributor_to_products/{id}Kalıcı olarak ilgili Distribütör Ürün Bağını siler
Distribütör Ürün Bağı nesnesinin id değeri
İstek Örneği
DELETE /api/distributor_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Ek Bilgiler (ExtraInfo)
Ek Bilgiler, bir fincan çayın şekeridir. Diğer bir deyişle, Ek Bilgiler, her sipariş ürünü(orderItem)/ürün(product) için esnek bir bilgi, özniteliktir; ancak, Ürünün stok miktarından ve fiyatından bağımsızdır.
Ek Bilgi Listesi Alma
GET /extra_infosEk Bilgi listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Ek Bilgi adı
İstek Örneği
GET /api/extra_infos HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Bilgi listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 56
total_count: 5
[
{
"id": 123,
"name": "Ek bilgi",
"sortOrder": 99
}
]| catalog_read | Katalog okuma izni. |
Ek Bilgi Oluşturma
POST /extra_infosYeni bir Ek Bilgi oluşturur.
Ek Bilgi nesnesi
İstek Örneği
POST /api/extra_infos HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 43
{
"name": "Ek bilgi",
"sortOrder": 99
}Ek Bilgi oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 56
{
"id": 123,
"name": "Ek bilgi",
"sortOrder": 99
}| catalog_write | Katalog okuma / yazma izni. |
Ek Bilgi Güncelleme
PUT /extra_infos/{id}İlgili Ek Bilgiyi günceller.
Ek Bilgi nesnesi
Ek Bilgi nesnesinin id değeri
İstek Örneği
PUT /api/extra_infos/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 56
{
"id": 123,
"name": "Ek bilgi",
"sortOrder": 99
}Ek Bilgi güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 56
{
"id": 123,
"name": "Ek bilgi",
"sortOrder": 99
}| catalog_write | Katalog okuma / yazma izni. |
Ek Bilgi Alma
GET /extra_infos/{id}İlgili Ek Bilgiyi getirir.
Ek Bilgi nesnesinin id değeri
İstek Örneği
GET /api/extra_infos/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Bilgi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 56
{
"id": 123,
"name": "Ek bilgi",
"sortOrder": 99
}| catalog_read | Katalog okuma izni. |
Ek Bilgi Silme
DELETE /extra_infos/{id}Kalıcı olarak ilgili Ek Bilgiyi siler.
Ek Bilgi nesnesinin id değeri
İstek Örneği
DELETE /api/extra_infos/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Ek Bilgi Ürün Bağları (ExtraInfoToProduct)
Ek Bilgi Ürün Bağları Ek Bilgi ve Ürün arasındaki ilişkiyi belirler. Ayrıca dükkan sahibi, 'value' parametresini kullanarak Ek Bilginin değerini belirler. Bir örnek vermek gerekirse, eğer Ürün bir fincan çay ise ve Ek Bilgi şeker ise, o zaman Ek Bilgi Ürün Bağı 'value' parametresi de şeker miktarıdır.
Ek Bilgi Ürün Bağı Listesi Alma
GET /extra_info_to_productsEk Bilgi Ürün Bağı listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Ek bilgi id
0 değerinden büyük olmalıdır)Ürün id
İstek Örneği
GET /api/extra_info_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Bilgi Ürün Bağı listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 107
total_count: 5
[
{
"id": 123,
"value": "Kırmızı",
"extraInfo": {
"id": 123
},
"product": {
"id": 123
}
}
]| catalog_read | Katalog okuma izni. |
Ek Bilgi Ürün Bağı Oluşturma
POST /extra_info_to_productsYeni bir Ek Bilgi Ürün Bağı oluşturur.
Ek Bilgi Ürün Bağı nesnesi
İstek Örneği
POST /api/extra_info_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 94
{
"value": "Kırmızı",
"extraInfo": {
"id": 123
},
"product": {
"id": 123
}
}Ek Bilgi Ürün Bağı oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 107
{
"id": 123,
"value": "Kırmızı",
"extraInfo": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Ek Bilgi Ürün Bağı Güncelleme
PUT /extra_info_to_products/{id}İlgili Ek Bilgi Ürün Bağını günceller.
Ek Bilgi Ürün Bağı nesnesi
Ek Bilgi Ürün Bağı nesnesinin id değeri
İstek Örneği
PUT /api/extra_info_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 107
{
"id": 123,
"value": "Kırmızı",
"extraInfo": {
"id": 123
},
"product": {
"id": 123
}
}Ek Bilgi Ürün Bağı güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 107
{
"id": 123,
"value": "Kırmızı",
"extraInfo": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Ek Bilgi Ürün Bağı Alma
GET /extra_info_to_products/{id}İlgili Ek Bilgi Ürün Bağını getirir.
Ek Bilgi Ürün Bağı nesnesinin id değeri
İstek Örneği
GET /api/extra_info_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Bilgi Ürün Bağı alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 107
{
"id": 123,
"value": "Kırmızı",
"extraInfo": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_read | Katalog okuma izni. |
Ek Bilgi Ürün Bağı Silme
DELETE /extra_info_to_products/{id}Kalıcı olarak ilgili Ek Bilgi Ürün Bağını siler.
Ek Bilgi Ürün Bağı nesnesinin id değeri
İstek Örneği
DELETE /api/extra_info_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Ek Özellikler (Selection)
Ek Özellikler, ürün için seçilebilecek detayları temsil eder. Ek bilgilerden farklı olarak ek özellikler çok seçenekli seçilebilirlerdir.
Ek Özellik Listesi Alma
GET /selectionsEk Özellik listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Ek Özellik başlığı
0 değerinden büyük olmalıdır)Ek Özellik Grubu id
İstek Örneği
GET /api/selections HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Özellik listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 162
total_count: 5
[
{
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999,
"selectionGroup": {
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}
}
]| catalog_read | Katalog okuma izni. |
Ek Özellik Oluşturma
POST /selectionsYeni bir Ek Özellik oluşturur.
Ek Özellik nesnesi
İstek Örneği
POST /api/selections HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 96
{
"title": "Ek Özellik Başlığı",
"sortOrder": 999,
"selectionGroup": {
"id": 123
}
}Ek Özellik oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 162
{
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999,
"selectionGroup": {
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}
}| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Güncelleme
PUT /selections/{id}İlgili Ek Özelliği günceller.
Ek Özellik nesnesi
Ek Özellik nesnesinin id değeri
İstek Örneği
PUT /api/selections/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 109
{
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999,
"selectionGroup": {
"id": 123
}
}Ek Özellik güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 162
{
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999,
"selectionGroup": {
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}
}| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Alma
GET /selections/{id}İlgili Ek Özelliği getirir.
Ek Özellik nesnesinin id değeri
İstek Örneği
GET /api/selections/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Özellik alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 162
{
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999,
"selectionGroup": {
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}
}| catalog_read | Katalog okuma izni. |
Ek Özellik Silme
DELETE /selections/{id}Kalıcı olarak ilgili Ek Özelliği siler.
Ek Özellik nesnesinin id değeri
İstek Örneği
DELETE /api/selections/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Grupları (SelectionGroup)
Ek Özellik Grupları, ek özelliğin bağlı olduğu grup başlıklarıdır.
Ek Özellik Grubu Listesi Alma
GET /selection_groupsEk Özellik Grubu listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Ek Özellik Grubu başlığı
İstek Örneği
GET /api/selection_groups HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Özellik Grubu listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 64
total_count: 5
[
{
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}
]| catalog_read | Katalog okuma izni. |
Ek Özellik Grubu Oluşturma
POST /selection_groupsYeni bir Ek Özellik Grubu oluşturur.
Ek Özellik Grubu nesnesi
İstek Örneği
POST /api/selection_groups HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 51
{
"title": "SelectionGroup",
"sortOrder": 999
}Ek Özellik Grubu oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 64
{
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Grubu Güncelleme
PUT /selection_groups/{id}İlgili Ek Özellik Grubunu günceller.
Ek Özellik Grubu nesnesi
Ek Özellik Grubu nesnesinin id değeri
İstek Örneği
PUT /api/selection_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 64
{
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}Ek Özellik Grubu güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 64
{
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Grubu Alma
GET /selection_groups/{id}İlgili Ek Özellik Grubunu getirir.
Ek Özellik Grubu nesnesinin id değeri
İstek Örneği
GET /api/selection_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Özellik Grubu alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 64
{
"id": 123,
"title": "SelectionGroup",
"sortOrder": 999
}| catalog_read | Katalog okuma izni. |
Ek Özellik Grubu Silme
DELETE /selection_groups/{id}Kalıcı olarak ilgili Ek Özellik Grubunu siler.
Ek Özellik Grubu nesnesinin id değeri
İstek Örneği
DELETE /api/selection_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Ürün Bağları (SelectionToProduct)
Ek Özellik Ürün Bağları, seçilen ürünü veritabanında seçilen ek özellikle bağlayan bir bağlayıcı araçtır. Ek Özellik Ürün Bağları servisi bağ oluşturmak için id değerlerini kullanır; dolayısıyla hem ilişkili ürün hem de ek özellik bu ilişkiyi oluşturmak için önceden tanımlanmış olmalıdır. Ürün ve ek özellik arasındaki ilişki many-to-many şeklindedir. (Bir ürün birden fazla ek özelliğe sahip olabilir, ayrıca bir ek özellik birden fazla üründe olabilir.)
Ek Özellik Ürün Bağı Listesi Alma
GET /selection_to_productsEk Özellik Ürün Bağı listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Ek Özellik id
0 değerinden büyük olmalıdır)Ürün id
İstek Örneği
GET /api/selection_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Özellik Ürün Bağı listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 142
total_count: 5
[
{
"id": 123,
"selection": {
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999
},
"product": {
"id": 123
}
}
]| catalog_read | Katalog okuma izni. |
Ek Özellik Ürün Bağı Oluşturma
POST /selection_to_productsYeni bir Ek Özellik Ürün Bağı oluşturur.
Ek Özellik Ürün Bağı nesnesi
İstek Örneği
POST /api/selection_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 72
{
"selection": {
"id": 123
},
"product": {
"id": 123
}
}Ek Özellik Ürün Bağı oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 142
{
"id": 123,
"selection": {
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Ürün Bağı Güncelleme
PUT /selection_to_products/{id}İlgili Ek Özellik Ürün Bağını günceller.
Ek Özellik Ürün Bağı nesnesi
Ek Özellik Ürün Bağı nesnesinin id değeri
İstek Örneği
PUT /api/selection_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 85
{
"id": 123,
"selection": {
"id": 123
},
"product": {
"id": 123
}
}Ek Özellik Ürün Bağı güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 142
{
"id": 123,
"selection": {
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Ek Özellik Ürün Bağı Alma
GET /selection_to_products/{id}İlgili Ek Özellik Ürün Bağını getirir.
Ek Özellik Ürün Bağı nesnesinin id değeri
İstek Örneği
GET /api/selection_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ek Özellik Ürün Bağı alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 142
{
"id": 123,
"selection": {
"id": 123,
"title": "Ek Özellik Başlığı",
"sortOrder": 999
},
"product": {
"id": 123
}
}| catalog_read | Katalog okuma izni. |
Ek Özellik Ürün Bağı Silme
DELETE /selection_to_products/{id}Kalıcı olarak ilgili Ek Özellik Ürün Bağını siler.
Ek Özellik Ürün Bağı nesnesinin id değeri
İstek Örneği
DELETE /api/selection_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Entegrasyon Seçenekleri (ProductProtection)
IdeaSoft mağaza sahibi bu servis aracılığıyla ürünlerinin fiyat ve stok bilgilerinin yönetim paneli üzerinden çalıştırılan entegrasyonlardan etkilenmemesini sağlayabilir. Bu seçenekler kullanıldığında entegrasyondan gelen fiyat ve stok bilgileri ürünlerin üzerine yazılmaz.
Entegrasyon Seçeneği Listesi Alma
GET /product_protectionsEntegrasyon Seçeneği listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0, 1 Fiyat korumalı ürünleri listeler01
0, 1 Stok korumalı ürünleri listeler01
0 değerinden büyük olmalıdır)Ürün id
İstek Örneği
GET /api/product_protections HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Entegrasyon Seçeneği listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 99
total_count: 5
[
{
"id": 123,
"isPriceProtected": 0,
"isStockProtected": 0,
"product": {
"id": 123
}
}
]| catalog_read | Katalog okuma izni. |
Entegrasyon Seçeneği Oluşturma
POST /product_protectionsYeni bir Entegrasyon Seçeneği oluşturur.
Entegrasyon Seçeneği nesnesi
İstek Örneği
POST /api/product_protections HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 86
{
"isPriceProtected": 0,
"isStockProtected": 0,
"product": {
"id": 123
}
}Entegrasyon Seçeneği oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 99
{
"id": 123,
"isPriceProtected": 0,
"isStockProtected": 0,
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Entegrasyon Seçeneği Güncelleme
PUT /product_protections/{id}İlgili Entegrasyon Seçeneğini günceller.
Entegrasyon Seçeneği nesnesi
Entegrasyon Seçeneği nesnesinin id değeri
İstek Örneği
PUT /api/product_protections/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 99
{
"id": 123,
"isPriceProtected": 0,
"isStockProtected": 0,
"product": {
"id": 123
}
}Entegrasyon Seçeneği güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 99
{
"id": 123,
"isPriceProtected": 0,
"isStockProtected": 0,
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Entegrasyon Seçeneği Alma
GET /product_protections/{id}İlgili Entegrasyon Seçeneğini getirir.
Entegrasyon Seçeneği nesnesinin id değeri
İstek Örneği
GET /api/product_protections/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Entegrasyon Seçeneği alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 99
{
"id": 123,
"isPriceProtected": 0,
"isStockProtected": 0,
"product": {
"id": 123
}
}| catalog_read | Katalog okuma izni. |
Entegrasyon Seçeneği Silme
DELETE /product_protections/{id}Kalıcı olarak ilgili Entegrasyon Seçeneğini siler.
Entegrasyon Seçeneği nesnesinin id değeri
İstek Örneği
DELETE /api/product_protections/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Fatura Adresleri (BillingAddress)
Ödeme yöntemiyle ilişkili, faturanın gönderileceği posta adresi.
Fatura Adresi Listesi Alma
GET /billing_addressesFatura Adresi listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Sipariş id
createdAt değeri için başlangıç tarihi
createdAt değeri için bitiş tarihi
updatedAt değeri için başlangıç tarihi
updatedAt değeri için bitiş tarihi
İstek Örneği
GET /api/billing_addresses HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Fatura Adresi listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 445
total_count: 5
[
{
"id": 123,
"firstname": "John",
"surname": "Doe",
"country": "Türkiye",
"location": "İstanbul",
"subLocation": "Üsküdar",
"address": "Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2",
"phoneNumber": "+90 (216) 326 04 77",
"mobilePhoneNumber": "+90 (555) 555 55 55",
"order": {
"id": 123
},
"invoiceType": "individual",
"taxNo": "4996725041",
"taxOffice": "Üsküdar",
"identityRegistrationNumber": "11111111111"
}
]| order_read | Sipariş okuma izni. |
Fatura Adresi Oluşturma
POST /billing_addressesYeni bir Fatura Adresi oluşturur. Fatura Adresi oluşturabilmek için geçerli bir önceden tanımlanmış Sipariş id değerine ihtiyaç vardır.
Fatura Adresi nesnesi
İstek Örneği
POST /api/billing_addresses HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 432
{
"firstname": "John",
"surname": "Doe",
"country": "Türkiye",
"location": "İstanbul",
"subLocation": "Üsküdar",
"address": "Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2",
"phoneNumber": "+90 (216) 326 04 77",
"mobilePhoneNumber": "+90 (555) 555 55 55",
"order": {
"id": 123
},
"invoiceType": "individual",
"taxNo": "4996725041",
"taxOffice": "Üsküdar",
"identityRegistrationNumber": "11111111111"
}Fatura Adresi oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 445
{
"id": 123,
"firstname": "John",
"surname": "Doe",
"country": "Türkiye",
"location": "İstanbul",
"subLocation": "Üsküdar",
"address": "Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2",
"phoneNumber": "+90 (216) 326 04 77",
"mobilePhoneNumber": "+90 (555) 555 55 55",
"order": {
"id": 123
},
"invoiceType": "individual",
"taxNo": "4996725041",
"taxOffice": "Üsküdar",
"identityRegistrationNumber": "11111111111"
}| order_write | Sipariş okuma / yazma izni. |
Fatura Adresi Güncelleme
PUT /billing_addresses/{id}İlgili Fatura Adresini günceller.
Fatura Adresi nesnesi
Fatura Adresi nesnesinin id değeri
İstek Örneği
PUT /api/billing_addresses/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 445
{
"id": 123,
"firstname": "John",
"surname": "Doe",
"country": "Türkiye",
"location": "İstanbul",
"subLocation": "Üsküdar",
"address": "Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2",
"phoneNumber": "+90 (216) 326 04 77",
"mobilePhoneNumber": "+90 (555) 555 55 55",
"order": {
"id": 123
},
"invoiceType": "individual",
"taxNo": "4996725041",
"taxOffice": "Üsküdar",
"identityRegistrationNumber": "11111111111"
}Fatura Adresi güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 445
{
"id": 123,
"firstname": "John",
"surname": "Doe",
"country": "Türkiye",
"location": "İstanbul",
"subLocation": "Üsküdar",
"address": "Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2",
"phoneNumber": "+90 (216) 326 04 77",
"mobilePhoneNumber": "+90 (555) 555 55 55",
"order": {
"id": 123
},
"invoiceType": "individual",
"taxNo": "4996725041",
"taxOffice": "Üsküdar",
"identityRegistrationNumber": "11111111111"
}| order_write | Sipariş okuma / yazma izni. |
Fatura Adresi Alma
GET /billing_addresses/{id}İlgili Fatura Adresini getirir.
Fatura Adresi nesnesinin id değeri
İstek Örneği
GET /api/billing_addresses/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Fatura Adresi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 445
{
"id": 123,
"firstname": "John",
"surname": "Doe",
"country": "Türkiye",
"location": "İstanbul",
"subLocation": "Üsküdar",
"address": "Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2",
"phoneNumber": "+90 (216) 326 04 77",
"mobilePhoneNumber": "+90 (555) 555 55 55",
"order": {
"id": 123
},
"invoiceType": "individual",
"taxNo": "4996725041",
"taxOffice": "Üsküdar",
"identityRegistrationNumber": "11111111111"
}| order_read | Sipariş okuma izni. |
Favori Ürünler (FavouritedProduct)
Favori Ürünler müşterilerin sevdiği ürünleri bulmalarını veya takip edebilmelerinde yardımcı olur.
Favori Ürün Listesi Alma
GET /favourited_productsFavori Ürün listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Ürün id
0 değerinden büyük olmalıdır)Üye id
İstek Örneği
GET /api/favourited_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Favori Ürün listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 82
total_count: 5
[
{
"id": 123,
"member": {
"id": 123
},
"product": {
"id": 123
}
}
]| catalog_read | Katalog okuma izni. |
Favori Ürün Oluşturma
POST /favourited_productsYeni bir Favori Ürün oluşturur.
Favori Ürün nesnesi
İstek Örneği
POST /api/favourited_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 69
{
"member": {
"id": 123
},
"product": {
"id": 123
}
}Favori Ürün oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 82
{
"id": 123,
"member": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Favori Ürün Güncelleme
PUT /favourited_products/{id}İlgili Favori Ürünü günceller.
Favori Ürün nesnesi
Favori Ürün nesnesinin id değeri
İstek Örneği
PUT /api/favourited_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 82
{
"id": 123,
"member": {
"id": 123
},
"product": {
"id": 123
}
}Favori Ürün güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 82
{
"id": 123,
"member": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Favori Ürün Alma
GET /favourited_products/{id}İlgili Favori Ürünü getirir.
Favori Ürün nesnesinin id değeri
İstek Örneği
GET /api/favourited_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Favori Ürün alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 82
{
"id": 123,
"member": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_read | Katalog okuma izni. |
Favori Ürün Silme
DELETE /favourited_products/{id}Kalıcı olarak ilgili Favori Ürünü siler.
Favori Ürün nesnesinin id değeri
İstek Örneği
DELETE /api/favourited_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Hızlı Satın Al Bağlantıları (QuickCart)
Bir IdeaShop mağaza sahibi Hızlı Satın Al Bağlantıları servisi ile müşterilerini yalnızca bir linke tıklayarak ilgili ürünler sepetine ekli bir şekilde e-ticaret mağazasına yönlendiren bir URL oluşturabilir.
Hızlı Satın Al Bağlantısı Alma
GET /quick_cartsHızlı Satın Al Bağlantısı döndürür.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Hızlı Satın Al Bağlantısı adı
İstek Örneği
GET /api/quick_carts HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Hızlı Satın Al Bağlantısı listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 151
total_count: 5
[
{
"id": 123,
"name": "Hızlı Kalem Al",
"url": "products%5B0%5D%5Bid%5D=31&products%5B0%5D%5Bamount%5D=1",
"shortUrl": "https://goo.gl/VJ2FSF"
}
]| others_read | Diğer okuma izni. |
Hızlı Satın Al Bağlantısı Oluşturma
POST /quick_cartsYeni bir Hızlı Satın Al Bağlantısı oluşturur.
Hızlı Satın Al Bağlantısı nesnesi
İstek Örneği
POST /api/quick_carts HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 138
{
"name": "Hızlı Kalem Al",
"url": "products%5B0%5D%5Bid%5D=31&products%5B0%5D%5Bamount%5D=1",
"shortUrl": "https://goo.gl/VJ2FSF"
}Hızlı Satın Al Bağlantısı oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 151
{
"id": 123,
"name": "Hızlı Kalem Al",
"url": "products%5B0%5D%5Bid%5D=31&products%5B0%5D%5Bamount%5D=1",
"shortUrl": "https://goo.gl/VJ2FSF"
}| others_write | Diğer okuma / yazma izni. |
Hızlı Satın Al Bağlantısı Güncelleme
PUT /quick_carts/{id}İlgili Hızlı Satın Al Bağlantısını günceller.
Hızlı Satın Al Bağlantısı nesnesi
Hızlı Satın Al nesnesinin id değeri
İstek Örneği
PUT /api/quick_carts/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 151
{
"id": 123,
"name": "Hızlı Kalem Al",
"url": "products%5B0%5D%5Bid%5D=31&products%5B0%5D%5Bamount%5D=1",
"shortUrl": "https://goo.gl/VJ2FSF"
}Hızlı Satın Al Bağlantısı güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 151
{
"id": 123,
"name": "Hızlı Kalem Al",
"url": "products%5B0%5D%5Bid%5D=31&products%5B0%5D%5Bamount%5D=1",
"shortUrl": "https://goo.gl/VJ2FSF"
}| others_write | Diğer okuma / yazma izni. |
Hızlı Satın Al Bağlantısı Alma
GET /quick_carts/{id}İlgili Hızlı Satın Al Bağlantısını getirir.
Hızlı Satın Al nesnesinin id değeri
İstek Örneği
GET /api/quick_carts/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Hızlı Satın Al Bağlantısı alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 151
{
"id": 123,
"name": "Hızlı Kalem Al",
"url": "products%5B0%5D%5Bid%5D=31&products%5B0%5D%5Bamount%5D=1",
"shortUrl": "https://goo.gl/VJ2FSF"
}| others_read | Diğer okuma izni. |
Hızlı Satın Al Bağlantısı Silme
DELETE /quick_carts/{id}Kalıcı olarak ilgili Hızlı Satın Al Bağlantısını siler.
Hızlı Satın Al nesnesinin id değeri
İstek Örneği
DELETE /api/quick_carts/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| others_write | Diğer okuma / yazma izni. |
İlçeler (Town)
Ideasoft içerisinde tanımlı tüm ilçeler bu servisle görüntülenebilir. Veritabanında tanımlı ilçeler bulunmaktadır fakat mağaza sahibi isterse bunlara ekleme yapabilir, düzenleyebilir veya silebilir.
İlçe Listesi Alma
GET /townsİlçe listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Şehir id
0 değerinden büyük olmalıdır)İlçe grubu id
1 ile 255 karakter arasında olmalıdır)İlçe adı.
0, 1 Status şu değerleri alabilir:0 : Pasif1 : Aktif
İstek Örneği
GET /api/towns HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
İlçe listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
total_count: 5
[
{
"id": 123,
"name": "Üsküdar",
"status": 1,
"location": {
"id": 123
},
"townGroup": {
"id": 123,
"name": "Standart İlçeler"
}
}
]| others_read | Diğer okuma izni. |
İlçe Oluşturma
POST /townsYeni bir İlçe oluşturur.
İlçe nesnesi
İstek Örneği
POST /api/towns HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 109
{
"name": "Üsküdar",
"status": 1,
"location": {
"id": 123
},
"townGroup": {
"id": 123
}
}İlçe oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
{
"id": 123,
"name": "Üsküdar",
"status": 1,
"location": {
"id": 123
},
"townGroup": {
"id": 123,
"name": "Standart İlçeler"
}
}| others_write | Diğer okuma / yazma izni. |
İlçe Güncelleme
PUT /towns/{id}İlgili İlçeyi günceller.
İlçe nesnesi
İlçe nesnesinin id değeri
İstek Örneği
PUT /api/towns/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 122
{
"id": 123,
"name": "Üsküdar",
"status": 1,
"location": {
"id": 123
},
"townGroup": {
"id": 123
}
}İlçe güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
{
"id": 123,
"name": "Üsküdar",
"status": 1,
"location": {
"id": 123
},
"townGroup": {
"id": 123,
"name": "Standart İlçeler"
}
}| others_write | Diğer okuma / yazma izni. |
İlçe Alma
GET /towns/{id}İlgili İlçeyi getirir.
İlçe nesnesinin id değeri
İstek Örneği
GET /api/towns/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
İlçe alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 154
{
"id": 123,
"name": "Üsküdar",
"status": 1,
"location": {
"id": 123
},
"townGroup": {
"id": 123,
"name": "Standart İlçeler"
}
}| others_read | Diğer okuma izni. |
İlçe Silme
DELETE /towns/{id}Kalıcı olarak ilgili İlçeyi siler.
İlçe nesnesinin id değeri
İstek Örneği
DELETE /api/towns/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| others_write | Diğer okuma / yazma izni. |
İlçe Grupları (TownGroup)
İlçe Grupları, ilçeleri organize etmeye yardımcı olan bir servistir.
İlçe Grubu Listesi Alma
GET /town_groupsİlçe Grubu listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
1 ile 255 karakter arasında olmalıdır)İlçe Grubu adı
İstek Örneği
GET /api/town_groups HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
İlçe Grubu listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 63
total_count: 5
[
{
"id": 123,
"name": "Standart İlçeler",
"status": true
}
]| others_read | Diğer okuma izni. |
İlçe Grubu Oluşturma
POST /town_groupsYeni bir İlçe Grubu oluşturur.
İlçe Grubu nesnesi
İstek Örneği
POST /api/town_groups HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 50
{
"name": "Standart İlçeler",
"status": true
}İlçe Grubu oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 63
{
"id": 123,
"name": "Standart İlçeler",
"status": true
}| others_write | Diğer okuma / yazma izni. |
İlçe Grubu Güncelleme
PUT /town_groups/{id}İlgili İlçe Grubunu günceller.
İlçe Grubu nesnesi
İlçe Grubu nesnesinin id değeri
İstek Örneği
PUT /api/town_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 63
{
"id": 123,
"name": "Standart İlçeler",
"status": true
}İlçe Grubu güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 63
{
"id": 123,
"name": "Standart İlçeler",
"status": true
}| others_write | Diğer okuma / yazma izni. |
İlçe Grubu Alma
GET /town_groups/{id}İlgili İlçe Grubunu getirir.
İlçe Grubu nesnesinin id değeri
İstek Örneği
GET /api/town_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
İlçe Grubu alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 63
{
"id": 123,
"name": "Standart İlçeler",
"status": true
}| others_read | Diğer okuma izni. |
İlçe Grubu Silme
DELETE /town_groups/{id}Kalıcı olarak ilgili İlçe Grubunu siler.
İlçe Grubu nesnesinin id değeri
İstek Örneği
DELETE /api/town_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| others_write | Diğer okuma / yazma izni. |
Kargo Firmaları (ShippingCompany)
IdeaSoft mağaza sahibi kendi Kargo Firmasını oluşturabileceği gibi tanımlı firmaları da kullanabilir. Ayrıca bu servis aracılığıyla her bir Kargo Firması içina ayrıca ücretsiz kargo gibi imkanlar sunabilir.
Kargo Firması Listesi Alma
GET /shipping_companiesKargo Firması listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Kargo firması adı
255 karakter olmalıdır)Kargo firması kodu
cash_on_delivery, standart_delivery, not_applicable Ödeme Tipi şu değerleri alabilir:cash_on_delivery : Alıcı ödemelistandart_delivery : Gönderici ödemelinot_applicable : Bu alan için uygulanabilir değil
0 değerinden büyük olmalıdır)Teslimat Hizmeti Sağlayıcısı id
İstek Örneği
GET /api/shipping_companies HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kargo Firması listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 366
total_count: 5
[
{
"id": 123,
"name": "Idea Cargo",
"status": "active",
"extraPrice": 5,
"extraVolumetricWeightPrice": 10,
"freeShipmentOrderPrice": 100,
"freeShipmentVolumetricWeightLimit": 1,
"sortOrder": 999,
"companyCode": "CMP12KD",
"paymentType": "standart_delivery",
"shippingProvider": {
"id": 123,
"code": "idea",
"name": "Idea Cargo"
}
}
]| order_read | Sipariş okuma izni. |
Kargo Firması Oluşturma
POST /shipping_companiesYeni bir Kargo Firması oluşturur relationship.
Kargo Firması nesnesi
İstek Örneği
POST /api/shipping_companies HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 307
{
"name": "Idea Cargo",
"status": "active",
"extraPrice": 5,
"extraVolumetricWeightPrice": 10,
"freeShipmentOrderPrice": 100,
"freeShipmentVolumetricWeightLimit": 1,
"sortOrder": 999,
"companyCode": "CMP12KD",
"paymentType": "standart_delivery",
"shippingProvider": {
"id": 123
}
}Kargo Firması oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 366
{
"id": 123,
"name": "Idea Cargo",
"status": "active",
"extraPrice": 5,
"extraVolumetricWeightPrice": 10,
"freeShipmentOrderPrice": 100,
"freeShipmentVolumetricWeightLimit": 1,
"sortOrder": 999,
"companyCode": "CMP12KD",
"paymentType": "standart_delivery",
"shippingProvider": {
"id": 123,
"code": "idea",
"name": "Idea Cargo"
}
}| order_write | Sipariş okuma / yazma izni. |
Kargo Firması Güncelleme
PUT /shipping_companies/{id}İlgili Kargo Firmasını günceller.
Kargo Firması nesnesi
Kargo Firması nesnesinin id değeri
İstek Örneği
PUT /api/shipping_companies/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 320
{
"id": 123,
"name": "Idea Cargo",
"status": "active",
"extraPrice": 5,
"extraVolumetricWeightPrice": 10,
"freeShipmentOrderPrice": 100,
"freeShipmentVolumetricWeightLimit": 1,
"sortOrder": 999,
"companyCode": "CMP12KD",
"paymentType": "standart_delivery",
"shippingProvider": {
"id": 123
}
}Kargo Firması güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 366
{
"id": 123,
"name": "Idea Cargo",
"status": "active",
"extraPrice": 5,
"extraVolumetricWeightPrice": 10,
"freeShipmentOrderPrice": 100,
"freeShipmentVolumetricWeightLimit": 1,
"sortOrder": 999,
"companyCode": "CMP12KD",
"paymentType": "standart_delivery",
"shippingProvider": {
"id": 123,
"code": "idea",
"name": "Idea Cargo"
}
}| order_write | Sipariş okuma / yazma izni. |
Kargo Firması Alma
GET /shipping_companies/{id}İlgili Kargo Firmasını getirir.
Kargo Firması nesnesinin id değeri
İstek Örneği
GET /api/shipping_companies/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kargo Firması alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 366
{
"id": 123,
"name": "Idea Cargo",
"status": "active",
"extraPrice": 5,
"extraVolumetricWeightPrice": 10,
"freeShipmentOrderPrice": 100,
"freeShipmentVolumetricWeightLimit": 1,
"sortOrder": 999,
"companyCode": "CMP12KD",
"paymentType": "standart_delivery",
"shippingProvider": {
"id": 123,
"code": "idea",
"name": "Idea Cargo"
}
}| order_read | Sipariş okuma izni. |
Kargo Firması Silme
DELETE /shipping_companies/{id}Kalıcı olarak ilgili Kargo Firmasını siler.
Kargo Firması nesnesinin id değeri
İstek Örneği
DELETE /api/shipping_companies/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| order_write | Sipariş okuma / yazma izni. |
Kargo Oranları (ShippingRate)
Kargo Oranları, belirli teslimat senaryolarında ortaya çıkan ekstra maliyetler için kullanılabilecek servistir. Örneğin, belirli bölgelere aynı desiye sahip kargoların daha pahalı teslim edildiği durumlar gibi. Marmara bölgesine teslimat oranı 1.2 iken Doğu Anadolu bölgesine teslimat oranı 1.4 olabilir.
Kargo Oranı Listesi Alma
GET /shipping_ratesKargo Oranı listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Kargo firması id
0 değerinden büyük olmalıdır)Bölge id
İstek Örneği
GET /api/shipping_rates HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kargo Oranı listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 210
total_count: 5
[
{
"id": 123,
"volumetricWeightStart": 0,
"volumetricWeightEnd": 1,
"rate": 1,
"region": {
"id": 123,
"name": "Marmara"
},
"shippingCompany": {
"id": 123,
"name": "Idea Cargo"
}
}
]| order_read | Sipariş okuma izni. |
Kargo Oranı Oluşturma
POST /shipping_ratesYeni bir Kargo Oranı oluşturur.
Kargo Oranı nesnesi
İstek Örneği
POST /api/shipping_rates HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 148
{
"volumetricWeightStart": 0,
"volumetricWeightEnd": 1,
"rate": 1,
"region": {
"id": 123
},
"shippingCompany": {
"id": 123
}
}Kargo Oranı oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 210
{
"id": 123,
"volumetricWeightStart": 0,
"volumetricWeightEnd": 1,
"rate": 1,
"region": {
"id": 123,
"name": "Marmara"
},
"shippingCompany": {
"id": 123,
"name": "Idea Cargo"
}
}| order_write | Sipariş okuma / yazma izni. |
Kargo Oranı Güncelleme
PUT /shipping_rates/{id}İlgili Kargo Oranını günceller.
Kargo Oranı nesnesi
Kargo Oranı nesnesinin id değeri
İstek Örneği
PUT /api/shipping_rates/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 161
{
"id": 123,
"volumetricWeightStart": 0,
"volumetricWeightEnd": 1,
"rate": 1,
"region": {
"id": 123
},
"shippingCompany": {
"id": 123
}
}Kargo Oranı güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 210
{
"id": 123,
"volumetricWeightStart": 0,
"volumetricWeightEnd": 1,
"rate": 1,
"region": {
"id": 123,
"name": "Marmara"
},
"shippingCompany": {
"id": 123,
"name": "Idea Cargo"
}
}| order_write | Sipariş okuma / yazma izni. |
Kargo Oranı Alma
GET /shipping_rates/{id}İlgili Kargo Oranını getirir.
Kargo Oranı nesnesinin id değeri
İstek Örneği
GET /api/shipping_rates/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kargo Oranı alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 210
{
"id": 123,
"volumetricWeightStart": 0,
"volumetricWeightEnd": 1,
"rate": 1,
"region": {
"id": 123,
"name": "Marmara"
},
"shippingCompany": {
"id": 123,
"name": "Idea Cargo"
}
}| order_read | Sipariş okuma izni. |
Kargo Oranı Silme
DELETE /shipping_rates/{id}Kalıcı olarak ilgili Kargo Oranını siler.
Kargo Oranı nesnesinin id değeri
İstek Örneği
DELETE /api/shipping_rates/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| order_write | Sipariş okuma / yazma izni. |
Kategoriler (Category)
Kategori, IdeaSoft mağaza sahibinin sitesinde sunmuş olduğu ürünleri, sitede gezinmeyi ve aranan ürünlerin bulunmasını kolaylaştırmak adına oluşturabildiği ürün gruplarını temsil eder.
Kategori Listesi Alma
GET /categoriesKategori listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Kategori adı
0, 1 Status şu değerleri alabilir:0 : Pasif1 : Aktif
128 karakter olmalıdır)Kategori Distribütör
0 değerinden büyük olmalıdır)Üst kategori id
createdAt değeri için başlangıç tarihi
createdAt değeri için bitiş tarihi
updatedAt değeri için başlangıç tarihi
updatedAt değeri için bitiş tarihi
İstek Örneği
GET /api/categories HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kategori listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 1185
total_count: 5
[
{
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}
]| catalog_read | Katalog okuma izni. |
Kategori Oluşturma
POST /categoriesYeni bir Kategori oluşturur.
Kategori nesnesi
İstek Örneği
POST /api/categories HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 461
{
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123
}
}Kategori oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 1185
{
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}| catalog_write | Katalog okuma / yazma izni. |
Kategori Güncelleme
PUT /categories/{id}İlgili Kategoriyi günceller.
Kategori nesnesi
Kategori nesnesinin id değeri
İstek Örneği
PUT /api/categories/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 474
{
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123
}
}Kategori güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 1185
{
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}| catalog_write | Katalog okuma / yazma izni. |
Kategori Alma
GET /categories/{id}İlgili Kategoriyi getirir.
Kategori nesnesinin id değeri
İstek Örneği
GET /api/categories/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kategori alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 1185
{
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123,
"name": "Kırtasiye",
"slug": "kirtasiye",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"percent": 1,
"imageFile": "kalem.jpg",
"distributor": "",
"displayShowcaseContent": 1,
"showcaseContent": "Üst içerik metni.",
"showcaseContentDisplayType": 3,
"hasChildren": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"parent": {
"id": 123
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
},
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}| catalog_read | Katalog okuma izni. |
Kategori Silme
DELETE /categories/{id}Kalıcı olarak ilgili Kategoriyi siler.
Kategori nesnesinin id değeri
İstek Örneği
DELETE /api/categories/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Kişisel Etiketler (Label)
Ürün filtrelemerinde ve detaylarında kullanılmakta olan kişisel etiketlerin bu servis üzerinden eklenmesi, düzenlenmesi ve silinmesi sağlanır.
Kişisel Etiket Listesi Alma
GET /labelsKişisel etiketleri verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
Kişisel etiket id
Sıralama seçeneği
255 karakter olmalıdır)Kişisel etiket adı
createdAt değeri için başlangıç tarihi
createdAt değeri için bitiş tarihi
updatedAt değeri için başlangıç tarihi
updatedAt değeri için bitiş tarihi
İstek Örneği
GET /api/labels HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kişisel Etiket listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 791
total_count: 5
[
{
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123
}
}
}
]| catalog_read | Katalog okuma izni. |
Kişisel Etiket Oluşturma
POST /labelsYeni bir kişisel etiket oluşturur.
Kişisel Etiket nesnesi
İstek Örneği
POST /api/labels HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 291
{
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"parent": {
"id": 123
}
}Kişisel Etiket oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 791
{
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123
}
}
}| catalog_write | Katalog okuma / yazma izni. |
Kişisel Etiket Güncelleme
PUT /labels/{id}İlgili kişisel etiketi günceller.
Kişisel Etiket nesnesi
Kişisel etiket nesnesinin id değeri
İstek Örneği
PUT /api/labels/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 304
{
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"parent": {
"id": 123
}
}Kişisel Etiket güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 791
{
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123
}
}
}| catalog_write | Katalog okuma / yazma izni. |
Kişisel Etiket Alma
GET /labels/{id}İlgili kişisel etiketi getirir.
Kişisel etiket nesnesinin id değeri
İstek Örneği
GET /api/labels/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kişisel Etiket alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 791
{
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123,
"name": "Kırtasiye ürünleri",
"sortOrder": 999,
"hasChildren": 1,
"slug": "kirtasiye-urunleri",
"metaTitle": "Kırtasiye Ürünleri",
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"status": 1,
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"parent": {
"id": 123
}
}
}| catalog_read | Katalog okuma izni. |
Kişisel Etiket Silme
DELETE /labels/{id}Kalıcı olarak ilgili kişisel etiketi siler.
Kişisel etiket nesnesinin id değeri
İstek Örneği
DELETE /api/labels/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Kişisel Etiket Ürün Bağları (LabelToProduct)
Ürün filtrelemerinde kullanılmakta olan kişisel etiketlerin bu servis üzerinden ürünlere eklenmesi, silinmesi ve düzenlenmesi sağlanır.
Kişisel Etiket Ürün Bağı Listesi Alma
GET /label_to_productsKişisel etiket ürün bağlarını listeler.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
0 değerinden büyük olmalıdır)Belirli bir üründeki etiket bağlarının gösterilmesi
0 değerinden büyük olmalıdır)Yalnızca belirli bir etiketteki bağların gösterilmesi
İstek Örneği
GET /api/label_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kişisel Etiket Ürün Bağı listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 81
total_count: 5
[
{
"id": 123,
"label": {
"id": 123
},
"product": {
"id": 123
}
}
]| catalog_read | Katalog okuma izni. |
Kişisel Etiket Ürün Bağı Oluşturma
POST /label_to_productsKişisel etiketlere ürün bağlanmasını sağlar.
Kişisel Etiket Ürün Bağı nesnesi
İstek Örneği
POST /api/label_to_products HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 68
{
"label": {
"id": 123
},
"product": {
"id": 123
}
}Kişisel Etiket Ürün Bağı oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 81
{
"id": 123,
"label": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Kişisel Etiket Ürün Bağı Güncelleme
PUT /label_to_products/{id}İlgili kişisel etiketi günceller.
Kişisel Etiket Ürün Bağı nesnesi
Kişisel etiket nesnesinin id değeri
İstek Örneği
PUT /api/label_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 81
{
"id": 123,
"label": {
"id": 123
},
"product": {
"id": 123
}
}Kişisel Etiket Ürün Bağı güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 81
{
"id": 123,
"label": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_write | Katalog okuma / yazma izni. |
Kişisel Etiket Ürün Bağı Alma
GET /label_to_products/{id}İlgili kişisel etiket ürün bağını getirir.
Kişisel etiket nesnesinin id değeri
İstek Örneği
GET /api/label_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kişisel Etiket Ürün Bağı alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 81
{
"id": 123,
"label": {
"id": 123
},
"product": {
"id": 123
}
}| catalog_read | Katalog okuma izni. |
Kişisel Etiket Ürün Bağı Silme
DELETE /label_to_products/{id}Kalıcı olarak ilgili kişisel etiket ürün bağını siler.
Kişisel etiket ürün bağı nesnesinin id değeri
İstek Örneği
DELETE /api/label_to_products/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Kurlar (Currency)
IdeaSoft mağazasında kullanılabilecek tüm para birimleri önceden tanımlanmıştır. Mağaza sahibi yalnızca bu para birimlerinin özelliklerini değiştirebilir ancak bir para birimi oluşturamaz veya silemez; Mevcut para birimleri: USD, EURO, TL, POUND, JPY, YUAN, GOLD, CHF.
Kur Listesi Alma
GET /currenciesKur listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
50 karakter olmalıdır)Kur etiketi
5 karakter olmalıdır)Kur kısaltması
0, 1 Status şu değerleri alabilir:0 : Pasif1 : Aktif
İstek Örneği
GET /api/currencies HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kur listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 165
total_count: 5
[
{
"id": 123,
"label": "TL",
"buyingPrice": 1,
"sellingPrice": 1,
"abbr": "TL",
"updatedAt": "2018-02-21T15:01:03+0300",
"status": 1,
"isPrimary": 1
}
]| others_read | Diğer okuma izni. |
Kur Güncelleme
PUT /currencies/{id}İlgili Kur günceller.
Kur nesnesi
Kur nesnesinin id değeri
İstek Örneği
PUT /api/currencies/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 132
{
"id": 123,
"buyingPrice": 1,
"sellingPrice": 1,
"updatedAt": "2018-02-21T15:01:03+0300",
"status": 1,
"isPrimary": 1
}Kur güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 165
{
"id": 123,
"label": "TL",
"buyingPrice": 1,
"sellingPrice": 1,
"abbr": "TL",
"updatedAt": "2018-02-21T15:01:03+0300",
"status": 1,
"isPrimary": 1
}| others_write | Diğer okuma / yazma izni. |
Kur Alma
GET /currencies/{id}İlgili Kur getirir.
Kur nesnesinin id değeri
İstek Örneği
GET /api/currencies/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Kur alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 165
{
"id": 123,
"label": "TL",
"buyingPrice": 1,
"sellingPrice": 1,
"abbr": "TL",
"updatedAt": "2018-02-21T15:01:03+0300",
"status": 1,
"isPrimary": 1
}| others_read | Diğer okuma izni. |
Mail Listeleri (Maillist)
Mail Listeleri abone olan üyelerin veya ziyaretçilerin e-posta adreslerini kaydeder.
Mail Listesi Listesi Alma
GET /maillistsMail Listesi listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Mail Listesi adı.
255 karakter olmalıdır) (/^[A-Z0-9._%+-][email protected][A-Z0-9.-]+\.[A-Z]{2,4}$/)Mail Listesi e-mail.
0 değerinden büyük olmalıdır)Mail Listesi Grubu id
createdAt değeri için başlangıç tarihi
createdAt değeri için bitiş tarihi
updatedAt değeri için başlangıç tarihi
updatedAt değeri için bitiş tarihi
İstek Örneği
GET /api/maillists HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Mail Listesi listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 326
total_count: 5
[
{
"id": 123,
"name": "Mail listesi",
"email": "[email protected]",
"lastMailSentDate": "2018-02-21T09:36:03+0300",
"creatorIpAddress": "192.168.1.1",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"maillistGroup": {
"id": 123,
"name": "Mail listesi grubu"
}
}
]| others_read | Diğer okuma izni. |
Mail Listesi Oluşturma
POST /maillistsYeni bir Mail Listesini oluşturur.
Mail Listesi nesnesi
İstek Örneği
POST /api/maillists HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 193
{
"name": "Mail listesi",
"email": "[email protected]",
"lastMailSentDate": "2018-02-21T09:36:03+0300",
"creatorIpAddress": "192.168.1.1",
"maillistGroup": {
"id": 123
}
}Mail Listesi oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 326
{
"id": 123,
"name": "Mail listesi",
"email": "[email protected]",
"lastMailSentDate": "2018-02-21T09:36:03+0300",
"creatorIpAddress": "192.168.1.1",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"maillistGroup": {
"id": 123,
"name": "Mail listesi grubu"
}
}| others_write | Diğer okuma / yazma izni. |
Mail Listesi Güncelleme
PUT /maillists/{id}İlgili Mail Listesini günceller.
Mail Listesi nesnesi
Mail Listesi nesnesinin id değeri
İstek Örneği
PUT /api/maillists/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 206
{
"id": 123,
"name": "Mail listesi",
"email": "[email protected]",
"lastMailSentDate": "2018-02-21T09:36:03+0300",
"creatorIpAddress": "192.168.1.1",
"maillistGroup": {
"id": 123
}
}Mail Listesi güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 326
{
"id": 123,
"name": "Mail listesi",
"email": "[email protected]",
"lastMailSentDate": "2018-02-21T09:36:03+0300",
"creatorIpAddress": "192.168.1.1",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"maillistGroup": {
"id": 123,
"name": "Mail listesi grubu"
}
}| others_write | Diğer okuma / yazma izni. |
Mail Listesi Alma
GET /maillists/{id}İlgili Mail Listesini getirir.
Mail Listesi nesnesinin id değeri
İstek Örneği
GET /api/maillists/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Mail Listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 326
{
"id": 123,
"name": "Mail listesi",
"email": "[email protected]",
"lastMailSentDate": "2018-02-21T09:36:03+0300",
"creatorIpAddress": "192.168.1.1",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300",
"maillistGroup": {
"id": 123,
"name": "Mail listesi grubu"
}
}| others_read | Diğer okuma izni. |
Mail Listesi Silme
DELETE /maillists/{id}Kalıcı olarak ilgili Mail Listesini siler.
Mail Listesi nesnesinin id değeri
İstek Örneği
DELETE /api/maillists/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| others_write | Diğer okuma / yazma izni. |
Mail Listesi Grupları (MaillistGroup)
Mail Listesi Grupları, abone olmuş e-posta adresleri için bir gruplandırma aracıdır. Bu gruplar aracılığıyla dükkan sahibi tüm müşterileri, üyeleri, ziyaretçileri dilediği şekilde bilgilendirebilir.
Mail Listesi Grubu Listesi Alma
GET /maillist_groupsMail Listesi Grubu listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Mail Listesi Grubu adı
İstek Örneği
GET /api/maillist_groups HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Mail Listesi Grubu listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 47
total_count: 5
[
{
"id": 123,
"name": "Mail listesi grubu"
}
]| others_read | Diğer okuma izni. |
Mail Listesi Grubu Oluşturma
POST /maillist_groupsYeni bir Mail Listesi Grubu oluşturur.
Mail Listesi Grubu nesnesi
İstek Örneği
POST /api/maillist_groups HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 34
{
"name": "Mail listesi grubu"
}Mail Listesi Grubu oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 47
{
"id": 123,
"name": "Mail listesi grubu"
}| others_write | Diğer okuma / yazma izni. |
Mail Listesi Grubu Güncelleme
PUT /maillist_groups/{id}İlgili Mail Listesi Grubunu günceller.
Mail Listesi Grubu nesnesi
Mail Listesi Grubu nesnesinin id değeri
İstek Örneği
PUT /api/maillist_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 47
{
"id": 123,
"name": "Mail listesi grubu"
}Mail Listesi Grubu güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 47
{
"id": 123,
"name": "Mail listesi grubu"
}| others_write | Diğer okuma / yazma izni. |
Mail Listesi Grubu Alma
GET /maillist_groups/{id}İlgili Mail Listesi Grubunu getirir.
Mail Listesi Grubu nesnesinin id değeri
İstek Örneği
GET /api/maillist_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Mail Listesi Grubu alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 47
{
"id": 123,
"name": "Mail listesi grubu"
}| others_read | Diğer okuma izni. |
Mail Listesi Grubu Silme
DELETE /maillist_groups/{id}Kalıcı olarak ilgili Mail Listesi Grubunu siler.
Mail Listesi Grubu nesnesinin id değeri
İstek Örneği
DELETE /api/maillist_groups/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| others_write | Diğer okuma / yazma izni. |
Markalar (Brand)
Marka, bir ürünü tanıtmaya, benzerlerinden ayırmaya yarayan, o ürünün simgesi olan özel isimdir. IdeaSoft mağaza sahibi, 'distributorCode' ve 'distributor' parametrelerini kullanarak, aynı markalı ürünler için distribütör tercihini belirtebilir. Ayrıca, müşteriler markanın genel özellikleri hakkında 'showcaseContent' kullanarak bilgilendirilebilir. Aynı zamanda marka, 'metaKeywords' ve 'metaDescription' parametreleri yoluyla SEO optimizasyonlarına imkan tanır.
Marka Listesi Alma
GET /brandsMarka listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Marka adı.
0, 1 Status şu değerleri alabilir:0 : Pasif1 : Aktif
128 karakter olmalıdır)Marka distribörü
createdAt değeri için başlangıç tarihi
createdAt değeri için bitiş tarihi
updatedAt değeri için başlangıç tarihi
updatedAt değeri için bitiş tarihi
Marka arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]
İstek Örneği
GET /api/brands HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Marka listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 491
total_count: 5
[
{
"id": 123,
"name": "Idea Kalem",
"slug": "idea-kalem",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"distributor": "Super Tedarik",
"imageFile": "kalem.jpg",
"showcaseContent": "Üst içerik metni.",
"displayShowcaseContent": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}
]| catalog_read | Katalog okuma izni. |
Marka Oluşturma
POST /brandsYeni bir Marka oluşturur.
Marka nesnesi
İstek Örneği
POST /api/brands HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 392
{
"name": "Idea Kalem",
"slug": "idea-kalem",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"distributor": "Super Tedarik",
"imageFile": "kalem.jpg",
"showcaseContent": "Üst içerik metni.",
"displayShowcaseContent": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem"
}Marka oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 491
{
"id": 123,
"name": "Idea Kalem",
"slug": "idea-kalem",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"distributor": "Super Tedarik",
"imageFile": "kalem.jpg",
"showcaseContent": "Üst içerik metni.",
"displayShowcaseContent": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}| catalog_write | Katalog okuma / yazma izni. |
Marka Güncelleme
PUT /brands/{id}İlgili Markayı günceller.
Marka nesnesi
Marka nesnesinin id değeri
İstek Örneği
PUT /api/brands/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 405
{
"id": 123,
"name": "Idea Kalem",
"slug": "idea-kalem",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"distributor": "Super Tedarik",
"imageFile": "kalem.jpg",
"showcaseContent": "Üst içerik metni.",
"displayShowcaseContent": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem"
}Marka güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 491
{
"id": 123,
"name": "Idea Kalem",
"slug": "idea-kalem",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"distributor": "Super Tedarik",
"imageFile": "kalem.jpg",
"showcaseContent": "Üst içerik metni.",
"displayShowcaseContent": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}| catalog_write | Katalog okuma / yazma izni. |
Marka Alma
GET /brands/{id}İlgili Markayı getirir.
Marka nesnesinin id değeri
İstek Örneği
GET /api/brands/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Marka alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 491
{
"id": 123,
"name": "Idea Kalem",
"slug": "idea-kalem",
"sortOrder": 999,
"status": 1,
"distributorCode": "string (string)",
"distributor": "Super Tedarik",
"imageFile": "kalem.jpg",
"showcaseContent": "Üst içerik metni.",
"displayShowcaseContent": 1,
"metaKeywords": "kırmızı, kalem, kırtasiye",
"metaDescription": "Kaliteli kırtasiye ürünleri.",
"pageTitle": "Kırmızı Kalem",
"createdAt": "2018-02-21T09:36:03+0300",
"updatedAt": "2018-02-21T15:01:03+0300"
}| catalog_read | Katalog okuma izni. |
Marka Silme
DELETE /brands/{id}Kalıcı olarak ilgili Markayı siler.
Marka nesnesinin id değeri
İstek Örneği
DELETE /api/brands/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| catalog_write | Katalog okuma / yazma izni. |
Ödemeler (Payment)
Ödemelerle alakalı tüm veriler bu servis altında toplanır. Mağaza sahibi verilere bu servisle ulaşabilir.
Ödeme Listesi Alma
GET /paymentsÖdeme listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
1 ile 255 karakter arasında olmalıdır)İşlem id.
Müşteri e-mail.
0 değerinden büyük olmalıdır)Üye id
waiting_for_approval, approved, fulfilled, cancelled, delivered, on_accumulation, waiting_for_payment, being_prepared, refunded, personal_status_1, personal_status_2, personal_status_3, deleted, failed, in_transaction Status şu değerleri alabilir:waiting_for_approval : Onay Bekliyorapproved : Onaylandıfulfilled : Kargoya Verildicancelled : İptal Edildidelivered : Teslim Edildion_accumulation : Tedarik Sürecindewaiting_for_payment : Ödeme Bekleniyorbeing_prepared : Hazırlanıyorrefunded : İade Edildipersonal_status_1 : Kişisel Sipariş Durumu 1personal_status_2 : Kişisel Sipariş Durumu 2personal_status_3 : Kişisel Sipariş Durumu 3deleted : Silindifailed : Hatalı Ödemelerin_transaction : Sonuçlanmamış Ödemeler
Havale, Özel Ödeme Sistemi, Kredi Kartı, Paypal, GarantiPay, Mail Order, BKM Express, Kapıda Ödeme Nakit, Kapıda Ödeme Kredi Kartı Ödeme tipi adı şu değerleri alabilir:HavaleÖzel Ödeme SistemiKredi KartıPaypalGarantiPayMail OrderBKM ExpressKapıda Ödeme NakitKapıda Ödeme Kredi Kartı
createdAt değeri için başlangıç tarihi
createdAt değeri için bitiş tarihi
İstek Örneği
GET /api/payments HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ödeme listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 998
total_count: 5
[
{
"id": 123,
"memberFirstname": "John",
"memberSurname": "Doe",
"memberEmail": "[email protected]",
"memberPhone": "+90 (216) 326 04 77",
"paymentTypeName": "Kredi Kartı",
"paymentProviderCode": "IdeaPay",
"paymentProviderName": "IdeaPay",
"paymentGatewayName": "IdeaCard",
"paymentGatewayCode": "ideacard",
"bankName": "Idea Bank",
"deviceType": "desktop",
"clientIp": "192.168.1.1",
"currencyRates": "{\"TL\":[1,1],\"USD\":[3.7698,3.7766],\"EUR\":[4.6575,4.6659],\"GBP\":[5.2597,5.2872]}",
"amount": 1,
"finalAmount": 1,
"sumOfGainedPoints": 100,
"installment": 1,
"installmentRate": 1,
"extraInstallment": 0,
"currency": "TL",
"transactionId": "53072074",
"memberNote": "Her ayın ikisinde teslimat istiyorum.",
"userNote": "Her ayın ikisinde gönderilecek.",
"status": "waiting_for_approval",
"errorMessage": "Limit yetersiz.",
"cardSavingSystem": "ideasave",
"createdAt": "2018-02-21T09:36:03+0300",
"member": {
"id": 123
}
}
]| others_read | Diğer okuma izni. |
Ödeme Oluşturma
POST /paymentsYeni bir Ödeme oluşturur.
Ödeme nesnesi
İstek Örneği
POST /api/payments HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 942
{
"memberFirstname": "John",
"memberSurname": "Doe",
"memberEmail": "[email protected]",
"memberPhone": "+90 (216) 326 04 77",
"paymentTypeName": "Kredi Kartı",
"paymentProviderCode": "IdeaPay",
"paymentProviderName": "IdeaPay",
"paymentGatewayName": "IdeaCard",
"paymentGatewayCode": "ideacard",
"bankName": "Idea Bank",
"deviceType": "desktop",
"clientIp": "192.168.1.1",
"currencyRates": "{\"TL\":[1,1],\"USD\":[3.7698,3.7766],\"EUR\":[4.6575,4.6659],\"GBP\":[5.2597,5.2872]}",
"amount": 1,
"finalAmount": 1,
"sumOfGainedPoints": 100,
"installment": 1,
"installmentRate": 1,
"extraInstallment": 0,
"currency": "TL",
"transactionId": "53072074",
"memberNote": "Her ayın ikisinde teslimat istiyorum.",
"userNote": "Her ayın ikisinde gönderilecek.",
"status": "waiting_for_approval",
"errorMessage": "Limit yetersiz.",
"cardSavingSystem": "ideasave",
"member": {
"id": 123
}
}Ödeme oluşturma işlemi (POST) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (201 Created)
HTTP/1.1 201 Created
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 998
{
"id": 123,
"memberFirstname": "John",
"memberSurname": "Doe",
"memberEmail": "[email protected]",
"memberPhone": "+90 (216) 326 04 77",
"paymentTypeName": "Kredi Kartı",
"paymentProviderCode": "IdeaPay",
"paymentProviderName": "IdeaPay",
"paymentGatewayName": "IdeaCard",
"paymentGatewayCode": "ideacard",
"bankName": "Idea Bank",
"deviceType": "desktop",
"clientIp": "192.168.1.1",
"currencyRates": "{\"TL\":[1,1],\"USD\":[3.7698,3.7766],\"EUR\":[4.6575,4.6659],\"GBP\":[5.2597,5.2872]}",
"amount": 1,
"finalAmount": 1,
"sumOfGainedPoints": 100,
"installment": 1,
"installmentRate": 1,
"extraInstallment": 0,
"currency": "TL",
"transactionId": "53072074",
"memberNote": "Her ayın ikisinde teslimat istiyorum.",
"userNote": "Her ayın ikisinde gönderilecek.",
"status": "waiting_for_approval",
"errorMessage": "Limit yetersiz.",
"cardSavingSystem": "ideasave",
"createdAt": "2018-02-21T09:36:03+0300",
"member": {
"id": 123
}
}| others_write | Diğer okuma / yazma izni. |
Ödeme Güncelleme
PUT /payments/{id}İlgili Ödemeyi günceller.
Ödeme nesnesi
Ödeme nesnesinin id değeri
İstek Örneği
PUT /api/payments/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 955
{
"id": 123,
"memberFirstname": "John",
"memberSurname": "Doe",
"memberEmail": "[email protected]",
"memberPhone": "+90 (216) 326 04 77",
"paymentTypeName": "Kredi Kartı",
"paymentProviderCode": "IdeaPay",
"paymentProviderName": "IdeaPay",
"paymentGatewayName": "IdeaCard",
"paymentGatewayCode": "ideacard",
"bankName": "Idea Bank",
"deviceType": "desktop",
"clientIp": "192.168.1.1",
"currencyRates": "{\"TL\":[1,1],\"USD\":[3.7698,3.7766],\"EUR\":[4.6575,4.6659],\"GBP\":[5.2597,5.2872]}",
"amount": 1,
"finalAmount": 1,
"sumOfGainedPoints": 100,
"installment": 1,
"installmentRate": 1,
"extraInstallment": 0,
"currency": "TL",
"transactionId": "53072074",
"memberNote": "Her ayın ikisinde teslimat istiyorum.",
"userNote": "Her ayın ikisinde gönderilecek.",
"status": "waiting_for_approval",
"errorMessage": "Limit yetersiz.",
"cardSavingSystem": "ideasave",
"member": {
"id": 123
}
}Ödeme güncelleme işlemi (PUT) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 998
{
"id": 123,
"memberFirstname": "John",
"memberSurname": "Doe",
"memberEmail": "[email protected]",
"memberPhone": "+90 (216) 326 04 77",
"paymentTypeName": "Kredi Kartı",
"paymentProviderCode": "IdeaPay",
"paymentProviderName": "IdeaPay",
"paymentGatewayName": "IdeaCard",
"paymentGatewayCode": "ideacard",
"bankName": "Idea Bank",
"deviceType": "desktop",
"clientIp": "192.168.1.1",
"currencyRates": "{\"TL\":[1,1],\"USD\":[3.7698,3.7766],\"EUR\":[4.6575,4.6659],\"GBP\":[5.2597,5.2872]}",
"amount": 1,
"finalAmount": 1,
"sumOfGainedPoints": 100,
"installment": 1,
"installmentRate": 1,
"extraInstallment": 0,
"currency": "TL",
"transactionId": "53072074",
"memberNote": "Her ayın ikisinde teslimat istiyorum.",
"userNote": "Her ayın ikisinde gönderilecek.",
"status": "waiting_for_approval",
"errorMessage": "Limit yetersiz.",
"cardSavingSystem": "ideasave",
"createdAt": "2018-02-21T09:36:03+0300",
"member": {
"id": 123
}
}| others_write | Diğer okuma / yazma izni. |
Ödeme Alma
GET /payments/{id}İlgili Ödemeyi getirir.
Ödeme nesnesinin id değeri
İstek Örneği
GET /api/payments/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ödeme alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 998
{
"id": 123,
"memberFirstname": "John",
"memberSurname": "Doe",
"memberEmail": "[email protected]",
"memberPhone": "+90 (216) 326 04 77",
"paymentTypeName": "Kredi Kartı",
"paymentProviderCode": "IdeaPay",
"paymentProviderName": "IdeaPay",
"paymentGatewayName": "IdeaCard",
"paymentGatewayCode": "ideacard",
"bankName": "Idea Bank",
"deviceType": "desktop",
"clientIp": "192.168.1.1",
"currencyRates": "{\"TL\":[1,1],\"USD\":[3.7698,3.7766],\"EUR\":[4.6575,4.6659],\"GBP\":[5.2597,5.2872]}",
"amount": 1,
"finalAmount": 1,
"sumOfGainedPoints": 100,
"installment": 1,
"installmentRate": 1,
"extraInstallment": 0,
"currency": "TL",
"transactionId": "53072074",
"memberNote": "Her ayın ikisinde teslimat istiyorum.",
"userNote": "Her ayın ikisinde gönderilecek.",
"status": "waiting_for_approval",
"errorMessage": "Limit yetersiz.",
"cardSavingSystem": "ideasave",
"createdAt": "2018-02-21T09:36:03+0300",
"member": {
"id": 123
}
}| others_read | Diğer okuma izni. |
Ödeme Silme
DELETE /payments/{id}Kalıcı olarak ilgili Ödemeyi siler.
Ödeme nesnesinin id değeri
İstek Örneği
DELETE /api/payments/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (204 No Content)
HTTP/1.1 204 No Content
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
| others_write | Diğer okuma / yazma izni. |
Ödeme Altyapısı Sağlayıcıları (PaymentProvider)
IdeaSoft API, yirmi adet Ödeme Altyapısı Sağlayıcısına sahiptir. Mağaza sahipleri yeni bir ödeme altyapısı sağlayıcısı ekleyemez, güncelleyemez, silemez. Yalnızca yönetim paneli üzerinden güncelleme yapılabilir.
Ödeme Altyapısı Sağlayıcısı Listesi Alma
GET /payment_providersÖdeme Altyapısı Sağlayıcısı listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Ödeme Altyapısı kodu
255 karakter olmalıdır)Ödeme Altyapısı adı
İstek Örneği
GET /api/payment_providers HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ödeme Altyapısı Sağlayıcısı listesi alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 241
total_count: 5
[
{
"id": 123,
"code": "MoneyOrder",
"name": "Havale",
"status": 1,
"paymentType": {
"id": 123,
"name": "Havale"
},
"settings": [
{
"id": 123,
"varKey": "agentId",
"varValue": "PALIKJXZQ"
}
]
}
]| others_read | Diğer okuma izni. |
Ödeme Altyapısı Sağlayıcısı Alma
GET /payment_providers/{id}İlgili Ödeme Altyapısı Sağlayıcısını getirir.
Ödeme Altyapııs Sağlayıcısı nesnesinin id değeri
İstek Örneği
GET /api/payment_providers/123 HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8
Ödeme Altyapısı Sağlayıcısı alma işlemi (GET) başarı ile sonuçlandı.
İstek gövdesinin (genellikle json objesi) yapısı bozuk.
Yetki hatası. Authorization istek başlığı hatalı veya bulunamadı.
İstemcinin bu operasyona özel gerekli yetkileri yok.
Talep edilen nesne sunucuda bulunamadı.
Bu operasyon tipine (GET, POST, PUT veya DELETE) izin verilmiyor.
Gönderilen nesnede (genellikle validasyonla ilgili) sorun var.
Belli bir süre içerisinde çok fazla istek yapıldı.
Sunucuda bir hata oluştu ve istek karşılanamadı.
Sunucu şu anda hizmet vermiyor (kapalı veya erişilemiyor).
Başarılı Cevap Örneği (200 OK)
HTTP/1.1 200 OK
Host: magaza-adiniz.myideasoft.com
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Content-Length: 241
{
"id": 123,
"code": "MoneyOrder",
"name": "Havale",
"status": 1,
"paymentType": {
"id": 123,
"name": "Havale"
},
"settings": [
{
"id": 123,
"varKey": "agentId",
"varValue": "PALIKJXZQ"
}
]
}| others_read | Diğer okuma izni. |
Ödeme Kanalları (PaymentGateway)
IdeaSoft API, yirmi adet Ödeme Kanalına sahiptir. Mağaza sahipleri yeni bir ödeme kanalı ekleyemez, güncelleyemez, silemez. Yalnızca yönetim paneli üzerinden güncelleme yapılabilir. Bu servis ödeme altyapısı sağlayıcısı id değeri ile sağlayıcı bilgilerini çeker.
Ödeme Kanalı Listesi Alma
GET /payment_gatewaysÖdeme Kanalı listesini verir.
id Sıralama değeri. Örnek: Artan sıra için sort=id azalan sıra için sort=-id
1 ile 100 arasında olmalıdır) 20Bir sayfada gelecek sonuç adedi
1 değerinden büyük olmalıdır) 1Hangi sayfadan başlanacağı
1 değerinden büyük olmalıdır)Yalnızca belirtilen id değerinden sonraki kayıtları getirir
Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4
255 karakter olmalıdır)Ödeme kanalı notu
255 karakter olmalıdır)Ödeme kanalı adı
İstek Örneği
GET /api/payment_gateways HTTP/1.1
Host: magaza-adiniz.myideasoft.com
Authorization: Bearer MDIxMTVmMzUxNWU0NDMzYzM5ZjIzMzg3
Content-Type: application/json; charset=utf-8