İç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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Kod JSON, dosya ikili veri olarak döner. Her istek Bearer ve reveal yetkisi gerektirir.
dataCodeContentData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

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

Ek alanlar: Hayır

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Boyutu, sağlama toplamını ve biçimi kontrol edin. Hazır yükleme, teslimatın alındığı anlamına gelmez.
dataDigitalUploadData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

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

Ek alanlar: Hayır

ApiResponse[ImportData]

ApiResponse_ImportData_ · Durumu, sürümü ve doğrulama sonucunu kontrol edin. Taslak, onu oluşturan API anahtarına aittir.
dataImportData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

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

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Değişiklikten önce ayarları ve adetleri okuyun. Yanıt kod veya dosya içeriği barındırmaz.
dataPoolData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

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

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Sayfa başına en fazla 100 birim okuyun. Liste, kodları göstermeden üst verileri döndürür.
dataUnitsData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Ek alanlar: Hayır

CodeContentData

CodeContentData · Kod JSON, dosya ikili veri olarak döner. Her istek Bearer ve reveal yetkisi gerektirir.
codeDizeZorunlu

Dijital kodun tam metni. Büyük/küçük harfleri ve iç boşlukları koruyun.

minLength: 1maxLength: 512
Örnek: "DEMO-ONE"
delivery_idDize nullİsteğe bağlı

Teslimat veya sipariş atamasının kimliği.

Dize:format: "uuid"
Örnek: null
kindDizeİsteğe bağlı

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

const: "code"
Varsayılan: "code"Örnek: "code"
payload_idDizeZorunlu

İçerik kimliği; herkese açık indirme URL’si değildir.

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000004"
unit_idDizeZorunlu

Tek bir kod veya dosyanın kimliği.

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000003"

Ek alanlar: Hayır

DigitalUploadCreate

DigitalUploadCreate · Dosya için alan ayırın ve dosyayı içe aktarmaya veya değiştirilecek birime bağlayın.
consumer_idDizeZorunlu

Bağlı içe aktarma veya birimin kimliği.

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
consumer_kindDizeZorunlu

Yüklemenin bağlantısı: digital_import / digital_unit.

Kısıtlamalar
enum
["digital_import", "digital_unit"]
Örnek: "digital_import"
filenameDizeZorunlu

Dosya

minLength: 1maxLength: 255
Örnek: "codes.txt"
purposeDizeZorunlu

digital_import: TXT/CSV; digital_unit: ayrı satılan dosya.

Kısıtlamalar
enum
["digital_unit", "digital_import"]
Örnek: "digital_import"
sha256DizeZorunlu

SHA-256 (hex, 64)

Kısıtlamalar
pattern
"^[0-9a-f]{64}$"
Örnek: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesTam sayıZorunlu

Bayt cinsinden boyut

minimum: 1maximum: 262144000
Örnek: 18

Ek alanlar: Hayır

DigitalUploadData

DigitalUploadData · Boyutu, sağlama toplamını ve biçimi kontrol edin. Hazır yükleme, teslimatın alındığı anlamına gelmez.
consumer_idDizeZorunlu

Bağlı içe aktarma veya birimin kimliği.

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
consumer_kindDizeZorunlu

Yüklemenin bağlantısı: digital_import / digital_unit.

Kısıtlamalar
enum
["digital_import", "digital_unit"]
Örnek: "digital_import"
expires_atDizeZorunlu

Bu yüklemenin veya içe aktarmanın sona erme zamanı.

format: "date-time"
Örnek: "2026-11-03T13:00:00Z"
filenameDizeZorunlu

Dosya

Örnek: "codes.txt"
idDizeZorunlu

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

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000002"
product_idDizeZorunlu

Ürün tanımlayıcısı.

Örnek: "example"
purposeDizeZorunlu

digital_import: TXT/CSV; digital_unit: ayrı satılan dosya.

Kısıtlamalar
enum
["digital_unit", "digital_import"]
Örnek: "digital_import"
received_bytesTam sayıZorunlu

Yükleniyor… · Bayt cinsinden boyut

Örnek: 18
sha256DizeZorunlu

SHA-256 (hex, 64)

Örnek: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesTam sayıZorunlu

Bayt cinsinden boyut

Örnek: 18
statusDizeZorunlu

Bu işlemin kabul ettiği durum.

Örnek: "ready"

Ek alanlar: Hayır

ImportCommit

ImportCommit · Doğrulanan partiden planlanmış veya alınmış teslimat oluşturun. Planlanan birimler henüz satılamaz.
delivered_atDizeZorunlu

Teslimat tarihi ve saati.

format: "date-time"
Örnek: "2026-11-03T12:00:00Z"
expected_delivery_versionTam sayıZorunlu

Teslimat sürümü; yeni teslimatta 0.

minimum: 0maximum: 0
Örnek: 0
expected_sales_limit_versionTam sayı nullİsteğe bağlı

Satış sınırı sürümü; publish_for_sale=true için zorunludur.

Tam sayı:minimum: 0maximum: 9223372036854775807
Örnek: 0
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 2
location_idDizeZorunlu

Depo konumu tanımlayıcısı.

Kısıtlamalar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Örnek: "location-digital"
publish_for_saleMantıksal değerİsteğe bağlı

true sonlu satış sınırını da artırır; false değiştirmez.

Varsayılan: falseÖrnek: true
statusDizeZorunlu

Bu işlemin kabul ettiği durum.

Kısıtlamalar
enum
["planned", "received"]
Örnek: "received"
validation_digestDizeZorunlu

Doğrulama sağlama toplamı; onaya değiştirmeden gönderin.

Kısıtlamalar
pattern
"^[0-9a-f]{64}$"
Örnek: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idDizeZorunlu

Depo tanımlayıcısı.

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

Ek alanlar: Hayır

ImportCreate

ImportCreate · En fazla 1000 kod veya 100 dosya içeren taslak hazırlayın. Satılabilir stok henüz artmaz.
countTam sayıZorunlu

Partideki tam birim sayısı.

minimum: 1maximum: 1000
Örnek: 2
kindDizeZorunlu

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar
enum
["code", "file"]
Örnek: "code"

Ek alanlar: Hayır

ImportData

ImportData · Durumu, sürümü ve doğrulama sonucunu kontrol edin. Taslak, onu oluşturan API anahtarına aittir.
delivery_idDize nullZorunlu

Teslimat veya sipariş atamasının kimliği.

Örnek: null
delivery_statusDize nullZorunlu

Teslimat durumu: planned / received; onay öncesi null.

Örnek: null
delivery_versionTam sayı nullZorunlu

Depo teslimatının güncel sürümü.

Örnek: null
expected_countTam sayıZorunlu

Beklenen sayı; yalnızca partinin tamamı kabul edilir.

Örnek: 2
expires_atDizeZorunlu

Bu yüklemenin veya içe aktarmanın sona erme zamanı.

format: "date-time"
Örnek: "2026-11-03T13:00:00Z"
idDizeZorunlu

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

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000001"
kindDizeZorunlu

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar
enum
["code", "file"]
Örnek: "code"
product_idDizeZorunlu

Ürün tanımlayıcısı.

Örnek: "example"
statusDizeZorunlu

Bu işlemin kabul ettiği durum.

Örnek: "validated"
validated_countTam sayıZorunlu

Son başarılı doğrulamada kabul edilen birim sayısı.

Örnek: 2
validation_digestDize nullZorunlu

Doğrulama sağlama toplamı; onaya değiştirmeden gönderin.

Örnek: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionTam sayıZorunlu

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

Örnek: 2

Ek alanlar: Hayır

ImportReceive

ImportReceive · Kod veya dosyaları yeniden içe aktarmadan mevcut birimleri teslim alın.
expected_delivery_versionTam sayıZorunlu

Teslimat sürümü; yeni teslimatta 0.

minimum: 1maximum: 9223372036854775807
Örnek: 1
expected_sales_limit_versionTam sayı nullİsteğe bağlı

Satış sınırı sürümü; publish_for_sale=true için zorunludur.

Tam sayı:minimum: 0maximum: 9223372036854775807
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 3
publish_for_saleMantıksal değerİsteğe bağlı

true sonlu satış sınırını da artırır; false değiştirmez.

Varsayılan: false

Ek alanlar: Hayır

ImportValidate

ImportValidate · Partinin tamamını kontrol edin. Yinelenen veya geçersiz kayıt partiyi reddeder; kodlar kısaltılmaz.
code_columnDize nullİsteğe bağlı

Kodların CSV sütunu; code kullanın.

Dize:const: "code"
expected_versionTam sayıZorunlu

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

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

Kod listesi: txt / csv; dosyalar için upload_ids kullanın.

Kısıtlamalar · Dize 1
enum
["txt", "csv"]
Örnek: "txt"
source_upload_idDize nullİsteğe bağlı

Bu içe aktarmanın hazır özel TXT/CSV yüklemesi.

Dize:format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000002"
upload_idsDizi <Dize> nullİsteğe bağlı

Bu içe aktarmaya ait 1–100 hazır özel dosya yüklemesi.

Dizi:minItems: 1maxItems: 100
Dizi / Dizi:format: "uuid"

Ek alanlar: Hayır

ImportWithdrawal

ImportWithdrawal · Yalnızca boş birimleri geri çekin. Ayrılan ve atanan birimler siparişlerine bağlı kalır.
expected_delivery_versionTam sayıZorunlu

Teslimat sürümü; yeni teslimatta 0.

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

Atama sırasının sürümü; müşteri siparişinin sürümü değildir.

minimum: 0maximum: 9223372036854775807
Örnek: 1
expected_versionTam sayıZorunlu

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

minimum: 1maximum: 9223372036854775807
Örnek: 3
reasonDizeZorunlu

Değişiklik için kaydedilen neden.

minLength: 1maxLength: 500
Örnek: "Withdraw a revoked license"

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

PoolChange

PoolChange · Professional ve üzeri planlarda ayrı kod veya dosyaları etkinleştirin. Kapatmak önceki satın alımların erişimini korur.
email_modeDizeİsteğe bağlı

disabled: e-posta yok; order_link: sipariş bağlantısı; code_text: kodlar da eklenebilir.

Kısıtlamalar
enum
["disabled", "order_link", "code_text"]
Varsayılan: "disabled"Örnek: "order_link"
enabledMantıksal değerZorunlu

Bu ayarın etkin olup olmadığı.

Örnek: true
expected_versionTam sayıZorunlu

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

minimum: 0maximum: 9223372036854775807
Örnek: 0
retention_daysTam sayı nullİsteğe bağlı

null: süresiz; ilk erişimden sonra 1–3650 gün. Kodlar otomatik silinmez.

Tam sayı:minimum: 1maximum: 3650
Örnek: null

Ek alanlar: Hayır

PoolCounts

PoolCounts · Değişiklikten önce ayarları ve adetleri okuyun. Yanıt kod veya dosya içeriği barındırmaz.
availableTam sayıZorunlu

Rezerve edilmemiş veya teslim edilmemiş boş birim sayısı.

Örnek: 1
heldTam sayıZorunlu

Siparişlere ayrılmış, henüz teslim edilmemiş birimler.

Örnek: 0
issuedTam sayıZorunlu

Ödenmiş satın alımlara teslim edilmiş birimler.

Örnek: 1
plannedTam sayıZorunlu

Onaylanmış fakat henüz alınmamış teslimatların birimleri.

Örnek: 0
retiredTam sayıZorunlu

Geçmişte saklanan geri çekilmiş birimler.

Örnek: 0
stagedTam sayıZorunlu

Tamamlanmamış içe aktarma birimleri; henüz stok değildir.

Örnek: 0

Ek alanlar: Hayır

PoolData

PoolData · Değişiklikten önce ayarları ve adetleri okuyun. Yanıt kod veya dosya içeriği barındırmaz.
configuredMantıksal değerZorunlu

Dijital havuz ayarlarının kaydedilip kaydedilmediği.

Örnek: true
countsPoolCounts Zorunlu

Stok durumuna göre birim sayıları.

Örnek: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
email_modeDizeZorunlu

disabled: e-posta yok; order_link: sipariş bağlantısı; code_text: kodlar da eklenebilir.

Kısıtlamalar
enum
["disabled", "order_link", "code_text"]
Örnek: "order_link"
enabledMantıksal değerZorunlu

Bu ayarın etkin olup olmadığı.

Örnek: true
order_versionTam sayıZorunlu

Havuzun atama sırası sürümü.

Örnek: 2
product_idDizeZorunlu

Ürün tanımlayıcısı.

Örnek: "example"
retention_daysTam sayı nullZorunlu

null: süresiz; ilk erişimden sonra 1–3650 gün. Kodlar otomatik silinmez.

Örnek: null
versionTam sayıZorunlu

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

Örnek: 1

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

UnitData

UnitData · Sayfa başına en fazla 100 birim okuyun. Liste, kodları göstermeden üst verileri döndürür.
content_stateDizeZorunlu

İçerik durumu: present / deleting / deleted.

Örnek: "present"
delivery_idDize nullZorunlu

Teslimat veya sipariş atamasının kimliği.

Örnek: "delivery-example"
filenameDize nullZorunlu

Dosya

Örnek: null
idDizeZorunlu

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

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000003"
issued_atDize nullZorunlu

İlk teslim zamanı; öncesinde null.

Dize:format: "date-time"
Örnek: null
kindDizeZorunlu

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar
enum
["file", "code"]
Örnek: "code"
location_idDize nullZorunlu

Depo konumu tanımlayıcısı.

Örnek: "location-digital"
mime_typeDize nullZorunlu

Medya içerik türü.

Örnek: null
payload_idDizeZorunlu

İçerik kimliği; herkese açık indirme URL’si değildir.

format: "uuid"
Örnek: "00000000-0000-4000-8000-000000000004"
product_idDizeZorunlu

Ürün tanımlayıcısı.

Örnek: "example"
size_bytesTam sayı nullZorunlu

Bayt cinsinden boyut

Örnek: null
sort_orderTam sayıZorunlu

Sıralı koleksiyondaki konum.

Örnek: 1
stateDizeZorunlu

Durum

Örnek: "available"
versionTam sayıZorunlu

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

Örnek: 1
warehouse_idDize nullZorunlu

Depo tanımlayıcısı.

Örnek: "warehouse-main"

Ek alanlar: Hayır

UnitDeletion

UnitDeletion · Satılmamış kod veya dosyayı gerekçeyle kaldırın. Ayrılmış ya da atanmış birimler reddedilir.
expected_versionTam sayıZorunlu

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

minimum: 1
Örnek: 1
reasonDizeZorunlu

Değişiklik için kaydedilen neden.

minLength: 1maxLength: 500
Örnek: "Withdraw a revoked license"

Ek alanlar: Hayır

UnitReorder

UnitReorder · Filtrelenmemiş sayfanın tamamını istenen sırayla gönderin. Eski sürüm 409 döndürür.
expected_order_versionTam sayıZorunlu

Atama sırasının sürümü; müşteri siparişinin sürümü değildir.

minimum: 1
Örnek: 1
unit_idsDizi <Dize> Zorunlu

Filtrelenmemiş sayfanın istenen sıradaki tüm birimleri.

minItems: 2maxItems: 100
Dizi:format: "uuid"
Örnek: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorDize nullİsteğe bağlı

Filtrelenmemiş sayfanın imleci; ilk sayfa için null.

Dize:maxLength: 1024

Ek alanlar: Hayır

UnitReplacement

UnitReplacement · Kod veya dosyayı sırasını değiştirmeden yenileyin. Değişiklik depo geçmişine kaydedilir.
codeDize nullİsteğe bağlı

Dijital kodun tam metni. Büyük/küçük harfleri ve iç boşlukları koruyun.

Dize:minLength: 1maxLength: 512
Örnek: "SYNTHETIC-REPLACEMENT"
expected_versionTam sayıZorunlu

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

minimum: 1
Örnek: 1
reasonDizeZorunlu

Değişiklik için kaydedilen neden.

minLength: 1maxLength: 500
Örnek: "Replace an invalid activation code"
upload_idDize nullİsteğe bağlı

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. · upload_id

Dize:format: "uuid"

Ek alanlar: Hayır

UnitsData

UnitsData · Sayfa başına en fazla 100 birim okuyun. Liste, kodları göstermeden üst verileri döndürür.
order_versionTam sayıZorunlu

Havuzun atama sırası sürümü.

Örnek: 2
totalTam sayıZorunlu

Toplam tutar.

Örnek: 1
unitsDizi <UnitData > Zorunlu

Birim üst verileri; içerik ayrı yetkili istek gerektirir.

Örnek: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Ek alanlar: Evet