İçeriğe atla
ShopentlyLearn

Veri şemaları: Stok

Veri şemaları: Stok. API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Veri şemaları

Depo konumlarına atanan miktarlar

AllocationData · Şema · Veri şemaları: Stok
location_codeDizeZorunlu

Depo konumu kodu.

Örnek: "example"
location_idDizeZorunlu

Depo konumu tanımlayıcısı.

Örnek: "example"
location_nameDizeZorunlu

Depo konumu adı.

Örnek: "example"
on_handTam sayıZorunlu

Fiziksel stok miktarı.

Örnek: 10

Ek alanlar: Hayır

Listele · Stok — Stok — Yanıt

ApiResponse_list_StockData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataDizi <StockData > Zorunlu

Yanıt örneği · ApiResponse_list_StockData__.

Örnek: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

Getir · Stok — Stok — Yanıt

ApiResponse_StockDetailData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataStockDetailData Zorunlu

Yanıt örneği · StockDetailData.

Örnek: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example"}

Ek alanlar: Hayır

Güncelle · Manuel rezervasyon — Stok — İstek gövdesi

ManualReservationUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807
Örnek: 1
manual_reservedTam sayıZorunlu

Elle ayrılan miktar.

minimum: 0maximum: 2147483647
Örnek: 1
reasonDizeİsteğe bağlı

Değişiklik için kaydedilen neden.

maxLength: 500
Varsayılan: ""

Ek alanlar: Hayır

Güncelle · Satış limiti — Stok — İstek gövdesi

SalesLimitUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807
Örnek: 1
reasonDizeİsteğe bağlı

Değişiklik için kaydedilen neden.

maxLength: 500
Varsayılan: ""
sellable_limitTam sayıZorunlu

Satış sınırı: -1 sınırsız anlamına gelir, 0 ise mevcut satışları kapatır.

minimum: -1maximum: 2147483647
Örnek: 1

Ek alanlar: Hayır

Oluştur · Stok düzeltmesi — Stok — İstek gövdesi

StockAdjustmentCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 0maximum: 9223372036854775807
Örnek: 0
locationsDizi <LocationQuantity > Zorunlu

Depo konumları.

minItems: 1maxItems: 100
Örnek: [{"location_id":"example","on_hand":1}]
reasonDizeZorunlu

Değişiklik için kaydedilen neden.

minLength: 1maxLength: 500
Örnek: "Example"
target_idDizeZorunlu

İşlemin etkilediği ürün veya varyantın tanımlayıcısı.

Kısıtlamalar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Örnek: "example"
target_typeDizeZorunlu

İşlemin ürünle mi, varyantla mı ilgili olduğu.

Kısıtlamalar
enum
["product", "variant"]
Örnek: "product"
warehouse_idDizeZorunlu

Depo tanımlayıcısı.

Kısıtlamalar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Örnek: "example"

Ek alanlar: Hayır

Güncelle · Stok — Stok — İstek gövdesi

StockAdjustmentUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807
Örnek: 1
locationsDizi <LocationQuantity > Zorunlu

Depo konumları.

minItems: 1maxItems: 100
Örnek: [{"location_id":"example","on_hand":1}]
reasonDizeZorunlu

Değişiklik için kaydedilen neden.

minLength: 1maxLength: 500
Örnek: "Example"

Ek alanlar: Hayır

Listele · Stok — Stok — Yanıt

StockData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
activeMantıksal değerZorunlu

Kaynağın etkin olup olmadığı.

Örnek: true
availableTam sayı nullZorunlu

Satışa sunulabilir miktar; null sınırsız miktarı belirtir.

Örnek: 5
idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (StockData).

Örnek: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedTam sayıZorunlu

Elle ayrılan miktar.

Örnek: 2
on_handTam sayıZorunlu

Fiziksel stok miktarı.

Örnek: 10
reservedTam sayıZorunlu

Siparişler tarafından ayrılan miktar.

Örnek: 3
sellable_limitTam sayıZorunlu

Satış sınırı: -1 sınırsız anlamına gelir, 0 ise mevcut satışları kapatır.

Örnek: 10
target_idDizeZorunlu

İşlemin etkilediği ürün veya varyantın tanımlayıcısı.

Örnek: "example"
target_typeDizeZorunlu

İşlemin ürünle mi, varyantla mı ilgili olduğu.

Kısıtlamalar
enum
["product", "variant"]
Örnek: "product"
total_reservedTam sayıZorunlu

Ayrılan toplam miktar.

Örnek: 5
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1
warehouse_idDizeZorunlu

Depo tanımlayıcısı.

Örnek: "example"

Ek alanlar: Hayır

Getir · Stok — Stok — Yanıt

StockDetailData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
activeMantıksal değerZorunlu

Kaynağın etkin olup olmadığı.

Örnek: true
allocationsDizi <AllocationData > Zorunlu

Depo konumlarına atanan miktarlar.

Örnek: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]
availableTam sayı nullZorunlu

Satışa sunulabilir miktar; null sınırsız miktarı belirtir.

Örnek: 5
idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (StockDetailData).

Örnek: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedTam sayıZorunlu

Elle ayrılan miktar.

Örnek: 2
on_handTam sayıZorunlu

Fiziksel stok miktarı.

Örnek: 10
reservedTam sayıZorunlu

Siparişler tarafından ayrılan miktar.

Örnek: 3
sellable_limitTam sayıZorunlu

Satış sınırı: -1 sınırsız anlamına gelir, 0 ise mevcut satışları kapatır.

Örnek: 10
target_idDizeZorunlu

İşlemin etkilediği ürün veya varyantın tanımlayıcısı.

Örnek: "example"
target_typeDizeZorunlu

İşlemin ürünle mi, varyantla mı ilgili olduğu.

Kısıtlamalar
enum
["product", "variant"]
Örnek: "product"
total_reservedTam sayıZorunlu

Ayrılan toplam miktar.

Örnek: 5
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1
warehouse_idDizeZorunlu

Depo tanımlayıcısı.

Örnek: "example"

Ek alanlar: Hayır