İçeriğe geç
Store API

ShippingProvider

Serverhttps://magaza-adiniz.myideasoft.com

ShippingProvider LIST

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

Bu endpoint, sistemde tanımlı kargo sağlayıcılarını (shipping provider) listeler. Filtreleme, sıralama, sayfalama veya belirli kayıtları ID üzerinden çağırma işlemleri desteklenir.

ShippingProvider LIST › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapılabilir. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek Shipping Provider (kargo sağlayıcı) 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 değerinden sonraki Shipping Provider kayıtlarını getirir. Özellikle artan ID’ye göre sıralı veri çekmek için kullanılır. Örnek: sinceId=120

ids
​string

Birden fazla Shipping Provider kaydını virgülle ayrılmış ID değerleriyle döndürür. Örnek: ids=1,2,3,4

code
​string

Shipping Company Code.

name
​string

Shipping Company Name.

ShippingProvider LIST › Responses

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

Kargo sağlayıcısı nesnesi
code
​string · maxLength: 64 · required

Kargo sağlayıcısı kodu. Benzersiz olmalıdır.

Example: idea
name
​string · maxLength: 255 · required

Kargo sağlayıcısının görünen adı.

Example: Idea Cargo
id
​integer

Kargo sağlayıcısının benzersiz kimlik numarası.

Example: 123
trackingUrl
​string · maxLength: 1024

Kargo takip url.

Example: https://app.kargonomi.com.tr/kargo-takip
trackingFormMethod
​string · enum

Kargo takibi için kullanılan HTTP metodu (GET veya POST).

Enum values:
get
post
Example: get
payload
​string · maxLength: 65535

Kargo takip kodunun gönderildiği sorgu veya form şablonu.

Example: q={tracking_code}&val=1
settings
​object

Kargo sağlayıcısına özel ek yapılandırma ayarları.

Example: {"apiKey":"abc123xyz","region":"TR","supportsCashOnDelivery":true}
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingProvider GET

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

ShippingProvider GET › path Parameters

id
​string · pattern: \d+ · required

ShippingProvider GET › Responses

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

Kargo sağlayıcısı nesnesi
code
​string · maxLength: 64 · required

Kargo sağlayıcısı kodu. Benzersiz olmalıdır.

Example: idea
name
​string · maxLength: 255 · required

Kargo sağlayıcısının görünen adı.

Example: Idea Cargo
id
​integer

Kargo sağlayıcısının benzersiz kimlik numarası.

Example: 123
trackingUrl
​string · maxLength: 1024

Kargo takip url.

Example: https://app.kargonomi.com.tr/kargo-takip
trackingFormMethod
​string · enum

Kargo takibi için kullanılan HTTP metodu (GET veya POST).

Enum values:
get
post
Example: get
payload
​string · maxLength: 65535

Kargo takip kodunun gönderildiği sorgu veya form şablonu.

Example: q={tracking_code}&val=1
settings
​object

Kargo sağlayıcısına özel ek yapılandırma ayarları.

Example: {"apiKey":"abc123xyz","region":"TR","supportsCashOnDelivery":true}
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly