Skip to content
Ideasoft
Admin API

ShippingRate

Serverhttps://your-store.myideasoft.com

ShippingRate LIST

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

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

Tek bir Shipping Rate (kargo ücreti) kaydını getirmek için kullanılır. Örnek: id=12

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

shippingCompany
​integer · min: 1

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

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

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

q
​string

Alan bazlı arama filtresi. q parametresi, belirli alanlarda arama yapmanızı sağlar. Kullanım: q[alanAdı]=arananDeğer Örnek: q[region]=Europe veya q[shippingCompany]=DHL

ShippingRate LIST › Responses

The request (GET or PUT) completed successfully.

volumetricWeightStart
​number · float · min: 0 · required

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

Example: 0
volumetricWeightEnd
​number · float · min: 1 · 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
​RegionSummary · required
​ShippingCompanySummary · required

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

id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123

ShippingRate POST

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

ShippingRate POST › Request Body

volumetricWeightStart
​number · float · min: 0 · required

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

Example: 0
volumetricWeightEnd
​number · float · min: 1 · 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
​RegionSummary · required
​ShippingCompanySummary · required

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

id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123

ShippingRate POST › Responses

The create request (POST) completed successfully.

volumetricWeightStart
​number · float · min: 0 · required

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

Example: 0
volumetricWeightEnd
​number · float · min: 1 · 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
​RegionSummary · required
​ShippingCompanySummary · required

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

id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123

ShippingRate COUNT

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

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 COUNT › 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
id
​integer · min: 1

Tek bir Shipping Rate (kargo ücreti) kaydını getirmek için kullanılır. Örnek: id=12

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

shippingCompany
​integer · min: 1

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

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

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

q
​string

Alan bazlı arama filtresi. q parametresi, belirli alanlarda arama yapmanızı sağlar. Kullanım: q[alanAdı]=arananDeğer Örnek: q[region]=Europe veya q[shippingCompany]=DHL

ShippingRate COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


ShippingRate GET

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

ShippingRate GET › path Parameters

id
​string · pattern: \d+ · required

ShippingRate GET › Responses

The request (GET or PUT) completed successfully.

volumetricWeightStart
​number · float · min: 0 · required

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

Example: 0
volumetricWeightEnd
​number · float · min: 1 · 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
​RegionSummary · required
​ShippingCompanySummary · required

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

id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123

ShippingRate PUT

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

ShippingRate PUT › path Parameters

id
​string · pattern: \d+ · required

ShippingRate PUT › Request Body

volumetricWeightStart
​number · float · min: 0 · required

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

Example: 0
volumetricWeightEnd
​number · float · min: 1 · 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
​RegionSummary · required
​ShippingCompanySummary · required

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

id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123

ShippingRate PUT › Responses

The request (GET or PUT) completed successfully.

volumetricWeightStart
​number · float · min: 0 · required

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

Example: 0
volumetricWeightEnd
​number · float · min: 1 · 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
​RegionSummary · required
​ShippingCompanySummary · required

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

id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123

ShippingRate DELETE

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

ShippingRate DELETE › path Parameters

id
​string · pattern: \d+ · required

ShippingRate DELETE › Responses

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

No data returned