İçeriğe geç
Store API

ShippingRate

Serverhttps://magaza-adiniz.myideasoft.com

ShippingRate LIST

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

Bu endpoint, sistemde tanımlı kargo ücretlerini listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), bölge (region), kargo şirketi (shippingCompany) ve arama (q) parametreleriyle özelleştirilebilir.

ShippingRate LIST › query Parameters

sort
​string

Sonuçların sıralanma biçimini belirtir. - Artan sıra için: sort=id - Azalan sıra için: sort=-id Birden fazla alanla sıralamak için virgülle ayırabilirsiniz. Örnek: sort=-price,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek Shipping Rate (kargo ücreti) sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=3

Default: 1
sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir. Özellikle incremental veri çekimi veya sonsuz kaydırma işlemleri için kullanışlıdır. Örnek: sinceId=100

ids
​string

Birden fazla Shipping Rate kaydını aynı anda getirmek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

shippingCompany
​integer · min: 1

Kargo şirketine göre filtreleme yapar. Örnek: shippingCompany=UPS veya shippingCompany=1

region
​integer · min: 1

Bölgeye (Region) göre filtreleme yapar. Bölge ismi veya ID’si ile sorgulanabilir. Örnek: region=Europe veya region=3

ShippingRate LIST › Responses

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

volumetricWeightStart
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.

Example: 0
volumetricWeightEnd
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.

Example: 1
rate
​number · float · min: 0 · required

Seçili bölge ve kargo firması için kargo oranı.

Example: 1
id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123
​RegionSummary
​ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.


ShippingRate POST

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

ShippingRate POST › Request Body

volumetricWeightStart
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.

Example: 0
volumetricWeightEnd
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.

Example: 1
rate
​number · float · min: 0 · required

Seçili bölge ve kargo firması için kargo oranı.

Example: 1
id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123
​RegionSummary
​ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.

ShippingRate POST › Responses

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

volumetricWeightStart
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.

Example: 0
volumetricWeightEnd
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.

Example: 1
rate
​number · float · min: 0 · required

Seçili bölge ve kargo firması için kargo oranı.

Example: 1
id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123
​RegionSummary
​ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.


ShippingRate GET

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

ShippingRate GET › path Parameters

id
​string · pattern: \d+ · required

ShippingRate GET › Responses

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

volumetricWeightStart
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.

Example: 0
volumetricWeightEnd
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.

Example: 1
rate
​number · float · min: 0 · required

Seçili bölge ve kargo firması için kargo oranı.

Example: 1
id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123
​RegionSummary
​ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.


ShippingRate PUT

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

ShippingRate PUT › path Parameters

id
​string · pattern: \d+ · required

ShippingRate PUT › Request Body

volumetricWeightStart
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.

Example: 0
volumetricWeightEnd
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.

Example: 1
rate
​number · float · min: 0 · required

Seçili bölge ve kargo firması için kargo oranı.

Example: 1
id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123
​RegionSummary
​ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.

ShippingRate PUT › Responses

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

volumetricWeightStart
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.

Example: 0
volumetricWeightEnd
​number · float · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.

Example: 1
rate
​number · float · min: 0 · required

Seçili bölge ve kargo firması için kargo oranı.

Example: 1
id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123
​RegionSummary
​ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.


ShippingRate DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/api/shipping_rates/{id}
Bearer

ShippingRate DELETE › path Parameters

id
​string · pattern: \d+ · required

ShippingRate DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned