İçeriğe geç
Admin API

ShippingAddress

Serverhttps://magaza-adiniz.myideasoft.com

ShippingAddress LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/shipping_addresses
Bearer
or
OAuth 2.0

ShippingAddress 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 listelenecek Shipping Address adedi.

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı.

Default: 1
id
​integer · min: 1

Tekli listeleme için ID değeri.

ids
​string

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

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

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

order
​integer · min: 1

Order ID.

s
​string

Arama anahtarı ile filtreleme.

ShippingAddress LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

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

Şehir adı

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

İlçe adı

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

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

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

Sabit telefon numarası

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

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi


ShippingAddress POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/shipping_addresses
Bearer
or
OAuth 2.0

ShippingAddress POST › Request Body

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

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

Şehir adı

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

İlçe adı

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

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

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

Sabit telefon numarası

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

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

ShippingAddress POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

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

Şehir adı

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

İlçe adı

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

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

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

Sabit telefon numarası

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

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi


ShippingAddress COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/shipping_addresses/count
Bearer
or
OAuth 2.0

ShippingAddress 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 listelenecek Shipping Address adedi.

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı.

Default: 1
id
​integer · min: 1

Tekli listeleme için ID değeri.

ids
​string

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

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

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

order
​integer · min: 1

Order ID.

s
​string

Arama anahtarı ile filtreleme.

ShippingAddress COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


ShippingAddress GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/shipping_addresses/{id}
Bearer
or
OAuth 2.0

ShippingAddress GET › path Parameters

id
​string · pattern: \d+ · required

ShippingAddress GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

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

Şehir adı

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

İlçe adı

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

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

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

Sabit telefon numarası

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

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi


ShippingAddress PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/shipping_addresses/{id}
Bearer
or
OAuth 2.0

ShippingAddress PUT › path Parameters

id
​string · pattern: \d+ · required

ShippingAddress PUT › Request Body

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

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

Şehir adı

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

İlçe adı

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

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

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

Sabit telefon numarası

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

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

ShippingAddress PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

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

Şehir adı

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

İlçe adı

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

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

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

Sabit telefon numarası

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

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi