Veri şemaları
Depo konumlarına atanan miktarlar
AllocationData · Şema · Veri şemaları: Stok
location_codeDizeZorunluDepo konumu kodu.
location_idDizeZorunluDepo konumu tanımlayıcısı.
location_nameDizeZorunluDepo konumu adı.
on_handTam sayıZorunluFiziksel stok miktarı.
Ek alanlar: Hayır
ApiResponse[CodeContentData]
ApiResponse_CodeContentData_ · Kod JSON, dosya ikili veri olarak döner. Her istek Bearer ve reveal yetkisi gerektirir.
dataCodeContentDataZorunluBaşarılı yanıtın verileri.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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.
dataDigitalUploadDataZorunluBaşarılı yanıtın verileri.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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.
dataImportDataZorunluBaşarılı yanıtın verileri.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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> ZorunluYanıt örneği · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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.
dataPoolDataZorunluBaşarılı yanıtın verileri.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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ı.
dataStockDetailDataZorunluYanıt örneği · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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.
dataUnitsDataZorunluBaşarılı yanıtın verileri.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
Ek alanlar: Hayır
CodeContentData
CodeContentData · Kod JSON, dosya ikili veri olarak döner. Her istek Bearer ve reveal yetkisi gerektirir.
codeDizeZorunluDijital kodun tam metni. Büyük/küçük harfleri ve iç boşlukları koruyun.
minLength:1maxLength:512delivery_idDize nullİsteğe bağlıTeslimat veya sipariş atamasının kimliği.
Dize:format:"uuid"kindDizeİsteğe bağlıİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
const:"code"payload_idDizeZorunluİçerik kimliği; herkese açık indirme URL’si değildir.
format:"uuid"unit_idDizeZorunluTek bir kod veya dosyanın kimliği.
format:"uuid"
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_idDizeZorunluBağlı içe aktarma veya birimin kimliği.
format:"uuid"consumer_kindDizeZorunluYüklemenin bağlantısı: digital_import / digital_unit.
Kısıtlamalar
enum["digital_import", "digital_unit"]
filenameDizeZorunluDosya
minLength:1maxLength:255purposeDizeZorunludigital_import: TXT/CSV; digital_unit: ayrı satılan dosya.
Kısıtlamalar
enum["digital_unit", "digital_import"]
sha256DizeZorunluSHA-256 (hex, 64)
Kısıtlamalar
pattern"^[0-9a-f]{64}$"
size_bytesTam sayıZorunluBayt cinsinden boyut
minimum:1maximum:262144000
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_idDizeZorunluBağlı içe aktarma veya birimin kimliği.
format:"uuid"consumer_kindDizeZorunluYüklemenin bağlantısı: digital_import / digital_unit.
Kısıtlamalar
enum["digital_import", "digital_unit"]
expires_atDizeZorunluBu yüklemenin veya içe aktarmanın sona erme zamanı.
format:"date-time"filenameDizeZorunluDosya
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
format:"uuid"product_idDizeZorunluÜrün tanımlayıcısı.
purposeDizeZorunludigital_import: TXT/CSV; digital_unit: ayrı satılan dosya.
Kısıtlamalar
enum["digital_unit", "digital_import"]
received_bytesTam sayıZorunluYükleniyor… · Bayt cinsinden boyut
sha256DizeZorunluSHA-256 (hex, 64)
size_bytesTam sayıZorunluBayt cinsinden boyut
statusDizeZorunluBu işlemin kabul ettiği durum.
Ek alanlar: Hayır
ImportCommit
ImportCommit · Doğrulanan partiden planlanmış veya alınmış teslimat oluşturun. Planlanan birimler henüz satılamaz.
delivered_atDizeZorunluTeslimat tarihi ve saati.
format:"date-time"expected_delivery_versionTam sayıZorunluTeslimat sürümü; yeni teslimatta 0.
minimum:0maximum:0expected_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:9223372036854775807expected_versionTam sayıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807location_idDizeZorunluDepo konumu tanımlayıcısı.
Kısıtlamalar
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
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.
statusDizeZorunluBu işlemin kabul ettiği durum.
Kısıtlamalar
enum["planned", "received"]
validation_digestDizeZorunluDoğrulama sağlama toplamı; onaya değiştirmeden gönderin.
Kısıtlamalar
pattern"^[0-9a-f]{64}$"
warehouse_idDizeZorunluDepo tanımlayıcısı.
Kısıtlamalar
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
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ıZorunluPartideki tam birim sayısı.
minimum:1maximum:1000kindDizeZorunluİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
Kısıtlamalar
enum["code", "file"]
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 nullZorunluTeslimat veya sipariş atamasının kimliği.
delivery_statusDize nullZorunluTeslimat durumu: planned / received; onay öncesi null.
delivery_versionTam sayı nullZorunluDepo teslimatının güncel sürümü.
expected_countTam sayıZorunluBeklenen sayı; yalnızca partinin tamamı kabul edilir.
expires_atDizeZorunluBu yüklemenin veya içe aktarmanın sona erme zamanı.
format:"date-time"idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
format:"uuid"kindDizeZorunluİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
Kısıtlamalar
enum["code", "file"]
product_idDizeZorunluÜrün tanımlayıcısı.
statusDizeZorunluBu işlemin kabul ettiği durum.
validated_countTam sayıZorunluSon başarılı doğrulamada kabul edilen birim sayısı.
validation_digestDize nullZorunluDoğrulama sağlama toplamı; onaya değiştirmeden gönderin.
versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
Ek alanlar: Hayır
ImportReceive
ImportReceive · Kod veya dosyaları yeniden içe aktarmadan mevcut birimleri teslim alın.
expected_delivery_versionTam sayıZorunluTeslimat sürümü; yeni teslimatta 0.
minimum:1maximum:9223372036854775807expected_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:9223372036854775807expected_versionTam sayıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807publish_for_saleMantıksal değerİsteğe bağlıtrue sonlu satış sınırını da artırır; false değiştirmez.
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807formatDize nullİsteğe bağlıKod listesi: txt / csv; dosyalar için upload_ids kullanın.
Kısıtlamalar · Dize 1
enum["txt", "csv"]
source_upload_idDize nullİsteğe bağlıBu içe aktarmanın hazır özel TXT/CSV yüklemesi.
Dize:format:"uuid"upload_idsDizi <Dize> nullİsteğe bağlıBu içe aktarmaya ait 1–100 hazır özel dosya yüklemesi.
Dizi:minItems:1maxItems:100Dizi / 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ıZorunluTeslimat sürümü; yeni teslimatta 0.
minimum:1maximum:9223372036854775807expected_order_versionTam sayıZorunluAtama sırasının sürümü; müşteri siparişinin sürümü değildir.
minimum:0maximum:9223372036854775807expected_versionTam sayıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807reasonDizeZorunluDeğişiklik için kaydedilen neden.
minLength:1maxLength:500
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807manual_reservedTam sayıZorunluElle ayrılan miktar.
minimum:0maximum:2147483647reasonDizeİsteğe bağlıDeğişiklik için kaydedilen neden.
maxLength:500
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"]
enabledMantıksal değerZorunluBu ayarın etkin olup olmadığı.
expected_versionTam sayıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:0maximum:9223372036854775807retention_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
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ıZorunluRezerve edilmemiş veya teslim edilmemiş boş birim sayısı.
heldTam sayıZorunluSiparişlere ayrılmış, henüz teslim edilmemiş birimler.
issuedTam sayıZorunluÖdenmiş satın alımlara teslim edilmiş birimler.
plannedTam sayıZorunluOnaylanmış fakat henüz alınmamış teslimatların birimleri.
retiredTam sayıZorunluGeçmişte saklanan geri çekilmiş birimler.
stagedTam sayıZorunluTamamlanmamış içe aktarma birimleri; henüz stok değildir.
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ğerZorunluDijital havuz ayarlarının kaydedilip kaydedilmediği.
countsPoolCountsZorunluStok durumuna göre birim sayıları.
email_modeDizeZorunludisabled: e-posta yok; order_link: sipariş bağlantısı; code_text: kodlar da eklenebilir.
Kısıtlamalar
enum["disabled", "order_link", "code_text"]
enabledMantıksal değerZorunluBu ayarın etkin olup olmadığı.
order_versionTam sayıZorunluHavuzun atama sırası sürümü.
product_idDizeZorunluÜrün tanımlayıcısı.
retention_daysTam sayı nullZorunlunull: süresiz; ilk erişimden sonra 1–3650 gün. Kodlar otomatik silinmez.
versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807reasonDizeİsteğe bağlıDeğişiklik için kaydedilen neden.
maxLength:500sellable_limitTam sayıZorunluSatış sınırı: -1 sınırsız anlamına gelir, 0 ise mevcut satışları kapatır.
minimum:-1maximum:2147483647
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:0maximum:9223372036854775807locationsDizi <LocationQuantity> ZorunluDepo konumları.
minItems:1maxItems:100reasonDizeZorunluDeğişiklik için kaydedilen neden.
minLength:1maxLength:500target_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}$"
target_typeDizeZorunluİşlemin ürünle mi, varyantla mı ilgili olduğu.
Kısıtlamalar
enum["product", "variant"]
warehouse_idDizeZorunluDepo tanımlayıcısı.
Kısıtlamalar
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807locationsDizi <LocationQuantity> ZorunluDepo konumları.
minItems:1maxItems:100reasonDizeZorunluDeğişiklik için kaydedilen neden.
minLength:1maxLength:500
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ğerZorunluKaynağın etkin olup olmadığı.
availableTam sayı nullZorunluSatışa sunulabilir miktar; null sınırsız miktarı belirtir.
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (StockData).
manual_reservedTam sayıZorunluElle ayrılan miktar.
on_handTam sayıZorunluFiziksel stok miktarı.
reservedTam sayıZorunluSiparişler tarafından ayrılan miktar.
sellable_limitTam sayıZorunluSatış sınırı: -1 sınırsız anlamına gelir, 0 ise mevcut satışları kapatır.
target_idDizeZorunluİşlemin etkilediği ürün veya varyantın tanımlayıcısı.
target_typeDizeZorunluİşlemin ürünle mi, varyantla mı ilgili olduğu.
Kısıtlamalar
enum["product", "variant"]
total_reservedTam sayıZorunluAyrılan toplam miktar.
updated_atDizeZorunluSon güncelleme zamanı.
format:"date-time"versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
warehouse_idDizeZorunluDepo tanımlayıcısı.
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ğerZorunluKaynağın etkin olup olmadığı.
allocationsDizi <AllocationData> ZorunluDepo konumlarına atanan miktarlar.
availableTam sayı nullZorunluSatışa sunulabilir miktar; null sınırsız miktarı belirtir.
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (StockDetailData).
manual_reservedTam sayıZorunluElle ayrılan miktar.
on_handTam sayıZorunluFiziksel stok miktarı.
reservedTam sayıZorunluSiparişler tarafından ayrılan miktar.
sellable_limitTam sayıZorunluSatış sınırı: -1 sınırsız anlamına gelir, 0 ise mevcut satışları kapatır.
target_idDizeZorunluİşlemin etkilediği ürün veya varyantın tanımlayıcısı.
target_typeDizeZorunluİşlemin ürünle mi, varyantla mı ilgili olduğu.
Kısıtlamalar
enum["product", "variant"]
total_reservedTam sayıZorunluAyrılan toplam miktar.
updated_atDizeZorunluSon güncelleme zamanı.
format:"date-time"versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
warehouse_idDizeZorunluDepo tanımlayıcısı.
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.
delivery_idDize nullZorunluTeslimat veya sipariş atamasının kimliği.
filenameDize nullZorunluDosya
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
format:"uuid"issued_atDize nullZorunluİlk teslim zamanı; öncesinde null.
Dize:format:"date-time"kindDizeZorunluİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
Kısıtlamalar
enum["file", "code"]
location_idDize nullZorunluDepo konumu tanımlayıcısı.
mime_typeDize nullZorunluMedya içerik türü.
payload_idDizeZorunluİçerik kimliği; herkese açık indirme URL’si değildir.
format:"uuid"product_idDizeZorunluÜrün tanımlayıcısı.
size_bytesTam sayı nullZorunluBayt cinsinden boyut
sort_orderTam sayıZorunluSıralı koleksiyondaki konum.
stateDizeZorunluDurum
versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
warehouse_idDize nullZorunluDepo tanımlayıcısı.
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1reasonDizeZorunluDeğişiklik için kaydedilen neden.
minLength:1maxLength:500
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ıZorunluAtama sırasının sürümü; müşteri siparişinin sürümü değildir.
minimum:1unit_idsDizi <Dize> ZorunluFiltrelenmemiş sayfanın istenen sıradaki tüm birimleri.
minItems:2maxItems:100Dizi:format:"uuid"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:512expected_versionTam sayıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1reasonDizeZorunluDeğişiklik için kaydedilen neden.
minLength:1maxLength:500upload_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ıZorunluHavuzun atama sırası sürümü.
totalTam sayıZorunluToplam tutar.
unitsDizi <UnitData> ZorunluBirim üst verileri; içerik ayrı yetkili istek gerektirir.
Ek alanlar: Evet