İçeriğe geç
Store API

ShippingAddress

Serverhttps://magaza-adiniz.myideasoft.com

ShippingAddress LIST

GET
https://magaza-adiniz.myideasoft.com
/api/shipping_addresses
Bearer

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
sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

ids
​string

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

order
​integer · min: 1

Order ID.

startDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

startUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

ShippingAddress LIST › Responses

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

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingAddress POST

POST
https://magaza-adiniz.myideasoft.com
/api/shipping_addresses
Bearer

ShippingAddress POST › Request Body

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingAddress POST › Responses

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

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingAddress GET

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

ShippingAddress GET › path Parameters

id
​string · pattern: \d+ · required

ShippingAddress GET › Responses

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

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingAddress PUT

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

ShippingAddress PUT › path Parameters

id
​string · pattern: \d+ · required

ShippingAddress PUT › Request Body

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingAddress PUT › Responses

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

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly