İçeriğe geç
Admin API

CustomTax

Serverhttps://magaza-adiniz.myideasoft.com

CustomTax LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/custom_taxes
Bearer
or
OAuth 2.0

CustomTax 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 CustomTaxes 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

q
​string

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

CustomTax LIST › Responses

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

Özel vergi oranları nesnesi
name
​string · maxLength: 255 · required

Özel vergi oranının adı.

countryCode
​string · maxLength: 255 · required

Ülke nesnesi için tanımlı 2 harfli kod.

Example: TR
currencyAbbr
​string · maxLength: 255 · required

Özel vergi oranları nesnesine ait kurun kısaltması.

Example: TL
limitType
​string · enum · required

Vergi oranının uygulanabileceği limit tipi.

Enum values:
min
max
Example: min
limitValue
​number · float · min: 0 · required

Özel vergi oranları limit değeri

amountType
​string · enum · required

Vergi miktarının hangi formatta olduğunu belirtir. - "percentage": Vergi, ürün veya hizmet fiyatının yüzdesi olarak uygulanır (örn. %18 KDV). - "fixed": Vergi, sabit bir tutar olarak uygulanır (örn. 10 TL sabit vergi).

Enum values:
percentage
fixed
Example: percentage
amountValue
​number · float · min: 0 · required

Özel vergi oranları miktarı

isShippingValueIncluded
​integer · enum · required

Verginin kargo bedeline dahil olup olmadığını belirtir (0 = Dahil değil, 1 = Dahil).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Özel vergi oranının aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
id
​integer

Özel vergi oranı nesnesine ait benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Özel vergi oranının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Özel vergi oranının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CustomTax POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/custom_taxes
Bearer
or
OAuth 2.0

CustomTax POST › Request Body

Özel vergi oranları nesnesi
name
​string · maxLength: 255 · required

Özel vergi oranının adı.

countryCode
​string · maxLength: 255 · required

Ülke nesnesi için tanımlı 2 harfli kod.

Example: TR
currencyAbbr
​string · maxLength: 255 · required

Özel vergi oranları nesnesine ait kurun kısaltması.

Example: TL
limitType
​string · enum · required

Vergi oranının uygulanabileceği limit tipi.

Enum values:
min
max
Example: min
limitValue
​number · float · min: 0 · required

Özel vergi oranları limit değeri

amountType
​string · enum · required

Vergi miktarının hangi formatta olduğunu belirtir. - "percentage": Vergi, ürün veya hizmet fiyatının yüzdesi olarak uygulanır (örn. %18 KDV). - "fixed": Vergi, sabit bir tutar olarak uygulanır (örn. 10 TL sabit vergi).

Enum values:
percentage
fixed
Example: percentage
amountValue
​number · float · min: 0 · required

Özel vergi oranları miktarı

isShippingValueIncluded
​integer · enum · required

Verginin kargo bedeline dahil olup olmadığını belirtir (0 = Dahil değil, 1 = Dahil).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Özel vergi oranının aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
id
​integer

Özel vergi oranı nesnesine ait benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Özel vergi oranının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Özel vergi oranının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CustomTax POST › Responses

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

Özel vergi oranları nesnesi
name
​string · maxLength: 255 · required

Özel vergi oranının adı.

countryCode
​string · maxLength: 255 · required

Ülke nesnesi için tanımlı 2 harfli kod.

Example: TR
currencyAbbr
​string · maxLength: 255 · required

Özel vergi oranları nesnesine ait kurun kısaltması.

Example: TL
limitType
​string · enum · required

Vergi oranının uygulanabileceği limit tipi.

Enum values:
min
max
Example: min
limitValue
​number · float · min: 0 · required

Özel vergi oranları limit değeri

amountType
​string · enum · required

Vergi miktarının hangi formatta olduğunu belirtir. - "percentage": Vergi, ürün veya hizmet fiyatının yüzdesi olarak uygulanır (örn. %18 KDV). - "fixed": Vergi, sabit bir tutar olarak uygulanır (örn. 10 TL sabit vergi).

Enum values:
percentage
fixed
Example: percentage
amountValue
​number · float · min: 0 · required

Özel vergi oranları miktarı

isShippingValueIncluded
​integer · enum · required

Verginin kargo bedeline dahil olup olmadığını belirtir (0 = Dahil değil, 1 = Dahil).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Özel vergi oranının aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
id
​integer

Özel vergi oranı nesnesine ait benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Özel vergi oranının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Özel vergi oranının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CustomTax GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/custom_taxes/{id}
Bearer
or
OAuth 2.0

CustomTax GET › path Parameters

id
​string · pattern: \d+ · required

CustomTax id değeri

CustomTax GET › Responses

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

Özel vergi oranları nesnesi
name
​string · maxLength: 255 · required

Özel vergi oranının adı.

countryCode
​string · maxLength: 255 · required

Ülke nesnesi için tanımlı 2 harfli kod.

Example: TR
currencyAbbr
​string · maxLength: 255 · required

Özel vergi oranları nesnesine ait kurun kısaltması.

Example: TL
limitType
​string · enum · required

Vergi oranının uygulanabileceği limit tipi.

Enum values:
min
max
Example: min
limitValue
​number · float · min: 0 · required

Özel vergi oranları limit değeri

amountType
​string · enum · required

Vergi miktarının hangi formatta olduğunu belirtir. - "percentage": Vergi, ürün veya hizmet fiyatının yüzdesi olarak uygulanır (örn. %18 KDV). - "fixed": Vergi, sabit bir tutar olarak uygulanır (örn. 10 TL sabit vergi).

Enum values:
percentage
fixed
Example: percentage
amountValue
​number · float · min: 0 · required

Özel vergi oranları miktarı

isShippingValueIncluded
​integer · enum · required

Verginin kargo bedeline dahil olup olmadığını belirtir (0 = Dahil değil, 1 = Dahil).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Özel vergi oranının aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
id
​integer

Özel vergi oranı nesnesine ait benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Özel vergi oranının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Özel vergi oranının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CustomTax PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/custom_taxes/{id}
Bearer
or
OAuth 2.0

CustomTax PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek CustomTax id değeri

CustomTax PUT › Request Body

Özel vergi oranları nesnesi
name
​string · maxLength: 255 · required

Özel vergi oranının adı.

countryCode
​string · maxLength: 255 · required

Ülke nesnesi için tanımlı 2 harfli kod.

Example: TR
currencyAbbr
​string · maxLength: 255 · required

Özel vergi oranları nesnesine ait kurun kısaltması.

Example: TL
limitType
​string · enum · required

Vergi oranının uygulanabileceği limit tipi.

Enum values:
min
max
Example: min
limitValue
​number · float · min: 0 · required

Özel vergi oranları limit değeri

amountType
​string · enum · required

Vergi miktarının hangi formatta olduğunu belirtir. - "percentage": Vergi, ürün veya hizmet fiyatının yüzdesi olarak uygulanır (örn. %18 KDV). - "fixed": Vergi, sabit bir tutar olarak uygulanır (örn. 10 TL sabit vergi).

Enum values:
percentage
fixed
Example: percentage
amountValue
​number · float · min: 0 · required

Özel vergi oranları miktarı

isShippingValueIncluded
​integer · enum · required

Verginin kargo bedeline dahil olup olmadığını belirtir (0 = Dahil değil, 1 = Dahil).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Özel vergi oranının aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
id
​integer

Özel vergi oranı nesnesine ait benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Özel vergi oranının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Özel vergi oranının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CustomTax PUT › Responses

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

Özel vergi oranları nesnesi
name
​string · maxLength: 255 · required

Özel vergi oranının adı.

countryCode
​string · maxLength: 255 · required

Ülke nesnesi için tanımlı 2 harfli kod.

Example: TR
currencyAbbr
​string · maxLength: 255 · required

Özel vergi oranları nesnesine ait kurun kısaltması.

Example: TL
limitType
​string · enum · required

Vergi oranının uygulanabileceği limit tipi.

Enum values:
min
max
Example: min
limitValue
​number · float · min: 0 · required

Özel vergi oranları limit değeri

amountType
​string · enum · required

Vergi miktarının hangi formatta olduğunu belirtir. - "percentage": Vergi, ürün veya hizmet fiyatının yüzdesi olarak uygulanır (örn. %18 KDV). - "fixed": Vergi, sabit bir tutar olarak uygulanır (örn. 10 TL sabit vergi).

Enum values:
percentage
fixed
Example: percentage
amountValue
​number · float · min: 0 · required

Özel vergi oranları miktarı

isShippingValueIncluded
​integer · enum · required

Verginin kargo bedeline dahil olup olmadığını belirtir (0 = Dahil değil, 1 = Dahil).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Özel vergi oranının aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
id
​integer

Özel vergi oranı nesnesine ait benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Özel vergi oranının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Özel vergi oranının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CustomTax DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/admin-api/custom_taxes/{id}
Bearer
or
OAuth 2.0

CustomTax DELETE › path Parameters

id
​string · pattern: \d+ · required

Silinecek CustomTax id değeri

CustomTax DELETE › Responses

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

No data returned