Skip to content
Ideasoft
Admin API

BillingAddress

Serverhttps://your-store.myideasoft.com

BillingAddress LIST

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

BillingAddress LIST › query Parameters

sort
​string

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

limit
​integer · min: 1 · max: 100

Bir sayfada görüntülenecek Billing Address sayısı

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası

Default: 1
id
​integer · min: 1

Tekli Billing Address listeleme için id değeri

ids
​string

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

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

q
​string

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

order
​integer · min: 1

Order Id filtresi

s
​string

Arama anahtarı ile filtreleme

BillingAddress LIST › Responses

The request (GET or PUT) completed successfully.

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111

BillingAddress POST

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

BillingAddress POST › Request Body

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111

BillingAddress POST › Responses

The create request (POST) completed successfully.

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111

BillingAddress COUNT

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

BillingAddress COUNT › query Parameters

sort
​string

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

limit
​integer · min: 1 · max: 100

Bir sayfada görüntülenecek Billing Address sayısı

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası

Default: 1
id
​integer · min: 1

Tekli Billing Address listeleme için id değeri

ids
​string

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

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

q
​string

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

order
​integer · min: 1

Order Id filtresi

s
​string

Arama anahtarı ile filtreleme

BillingAddress COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


BillingAddress GET

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

BillingAddress GET › path Parameters

id
​string · pattern: \d+ · required

BillingAddress GET › Responses

The request (GET or PUT) completed successfully.

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111

BillingAddress PUT

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

BillingAddress PUT › path Parameters

id
​string · pattern: \d+ · required

BillingAddress PUT › Request Body

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111

BillingAddress PUT › Responses

The request (GET or PUT) completed successfully.

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111