Skip to content
Ideasoft
Admin API

MemberAddress

Serverhttps://your-store.myideasoft.com

MemberAddress LIST

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

Tüm Üye Adresi (MemberAddress) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

MemberAddress LIST › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

member
​integer · min: -1

Adreslerin ilişkili olduğu Üye ID'sine (Member ID) göre filtreleme yapar.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

MemberAddress LIST › Responses

The request (GET or PUT) completed successfully.

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MemberSummary

Üye hesap bilgilerini içeren obje

​CountrySummary
​LocationSummary
​TownSummary

İlçe nesnesi


MemberAddress POST

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

MemberAddress POST › Request Body

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MemberSummary

Üye hesap bilgilerini içeren obje

​CountrySummary
​LocationSummary
​TownSummary

İlçe nesnesi

MemberAddress POST › Responses

The create request (POST) completed successfully.

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MemberSummary

Üye hesap bilgilerini içeren obje

​CountrySummary
​LocationSummary
​TownSummary

İlçe nesnesi


MemberAddress COUNT

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

Tüm Üye Adresi (MemberAddress) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

MemberAddress COUNT › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

member
​integer · min: -1

Adreslerin ilişkili olduğu Üye ID'sine (Member ID) göre filtreleme yapar.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

MemberAddress COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


MemberAddress GET

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

MemberAddress GET › path Parameters

id
​string · pattern: \d+ · required

MemberAddress GET › Responses

The request (GET or PUT) completed successfully.

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MemberSummary

Üye hesap bilgilerini içeren obje

​CountrySummary
​LocationSummary
​TownSummary

İlçe nesnesi


MemberAddress PUT

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

MemberAddress PUT › path Parameters

id
​string · pattern: \d+ · required

MemberAddress PUT › Request Body

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MemberSummary

Üye hesap bilgilerini içeren obje

​CountrySummary
​LocationSummary
​TownSummary

İlçe nesnesi

MemberAddress PUT › Responses

The request (GET or PUT) completed successfully.

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MemberSummary

Üye hesap bilgilerini içeren obje

​CountrySummary
​LocationSummary
​TownSummary

İlçe nesnesi


MemberAddress DELETE

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

MemberAddress DELETE › path Parameters

id
​string · pattern: \d+ · required

MemberAddress DELETE › Responses

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

No data returned