Skip to content
Ideasoft
Admin API

ShippingCompany

Serverhttps://your-store.myideasoft.com

ShippingCompany LIST

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

ShippingCompany 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 gelecek Shipping Companies 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. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

status
​string · enum

Shipping company status arama filtresi.

Enum values:
active
passive
q
​string

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

s
​string

Arama anahtarı ile filtreleme.

is_abroad
​integer · min: 0 · max: 1

Ülkelere göre ara. Ülke ID’leri virgülle ayrılmış olmalı.

ShippingCompany LIST › Responses

The request (GET or PUT) completed successfully.

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ücretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingCompany POST

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

ShippingCompany POST › Request Body

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ücretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingCompany POST › Responses

The create request (POST) completed successfully.

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ücretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingCompany COUNT

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

ShippingCompany 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 gelecek Shipping Companies 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. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

status
​string · enum

Shipping company status arama filtresi.

Enum values:
active
passive
q
​string

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

s
​string

Arama anahtarı ile filtreleme.

is_abroad
​integer · min: 0 · max: 1

Ülkelere göre ara. Ülke ID’leri virgülle ayrılmış olmalı.

ShippingCompany COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


ShippingCompany GET

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

ShippingCompany GET › path Parameters

id
​string · pattern: \d+ · required

ShippingCompany GET › Responses

The request (GET or PUT) completed successfully.

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ücretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingCompany PUT

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

ShippingCompany PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek Shipping company id

ShippingCompany PUT › Request Body

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ücretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingCompany PUT › Responses

The request (GET or PUT) completed successfully.

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ücretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingCompany DELETE

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

ShippingCompany DELETE › path Parameters

id
​string · pattern: \d+ · required

Silinecek Shipping company id

ShippingCompany DELETE › Responses

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

No data returned