Adatsémák
Raktárhelyekhez rendelt mennyiségek
AllocationData · Séma · Adatsémák: Készlet
location_codeKarakterláncKötelezőRaktárhelykód.
location_idKarakterláncKötelezőRaktárhely-azonosító.
location_nameKarakterláncKötelezőA raktárhely neve.
on_handEgész számKötelezőFizikai készletmennyiség.
További mezők: Nem
ApiResponse[CodeContentData]
ApiResponse_CodeContentData_ · A kód JSON-ként, a fájl bináris adatként érkezik. Minden kéréshez Bearer és reveal jogosultság kell.
dataCodeContentDataKötelezőA sikeres válasz adatai.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
További mezők: Nem
ApiResponse[DigitalUploadData]
ApiResponse_DigitalUploadData_ · Ellenőrizd a méretet, ellenőrzőösszeget és formátumot. A kész feltöltés még nem jelent átvett szállítást.
dataDigitalUploadDataKötelezőA sikeres válasz adatai.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
További mezők: Nem
ApiResponse[ImportData]
ApiResponse_ImportData_ · Ellenőrizd az állapotot, verziót és érvényesítést. A vázlat a létrehozó API-kulcshoz tartozik.
dataImportDataKötelezőA sikeres válasz adatai.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
További mezők: Nem
Listázás · Készlet — Készlet — Válasz
ApiResponse_list_StockData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataTömb <StockData> KötelezőPéldaválasz · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
További mezők: Nem
ApiResponse[PoolData]
ApiResponse_PoolData_ · Módosítás előtt olvasd be a beállításokat és darabszámokat. A válasz nem tartalmaz kódot vagy fájltartalmat.
dataPoolDataKötelezőA sikeres válasz adatai.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
További mezők: Nem
Lekérés · Készlet — Készlet — Válasz
ApiResponse_StockDetailData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataStockDetailDataKötelezőPéldaválasz · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
További mezők: Nem
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Kérj le oldalanként legfeljebb 100 egységet. A lista metaadatokat mutat, kódokat nem.
dataUnitsDataKötelezőA sikeres válasz adatai.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
További mezők: Nem
CodeContentData
CodeContentData · A kód JSON-ként, a fájl bináris adatként érkezik. Minden kéréshez Bearer és reveal jogosultság kell.
codeKarakterláncKötelezőA digitális kód pontos szövege. Őrizze meg a kis- és nagybetűket, valamint a belső szóközöket.
minLength:1maxLength:512delivery_idKarakterlánc nullNem kötelezőSzállítás vagy rendelési kiosztás azonosítója.
Karakterlánc:format:"uuid"kindKarakterláncNem kötelezőAz adatstruktúra változata, a megengedett értékek szerint.
const:"code"payload_idKarakterláncKötelezőTartalomazonosító; nem nyilvános letöltési URL.
format:"uuid"unit_idKarakterláncKötelezőEgy egyedi kód vagy fájl azonosítója.
format:"uuid"
További mezők: Nem
DigitalUploadCreate
DigitalUploadCreate · Foglalj helyet a fájlnak, és rendeld egy importhoz vagy cserélendő egységhez.
consumer_idKarakterláncKötelezőA kapcsolódó import vagy egység azonosítója.
format:"uuid"consumer_kindKarakterláncKötelezőA feltöltés célja: digital_import / digital_unit.
Korlátozások
enum["digital_import", "digital_unit"]
filenameKarakterláncKötelezőFájl
minLength:1maxLength:255purposeKarakterláncKöteleződigital_import: TXT/CSV; digital_unit: egyenként eladott fájl.
Korlátozások
enum["digital_unit", "digital_import"]
sha256KarakterláncKötelezőSHA-256 (hex, 64)
Korlátozások
pattern"^[0-9a-f]{64}$"
size_bytesEgész számKötelezőMéret bájtban
minimum:1maximum:262144000
További mezők: Nem
DigitalUploadData
DigitalUploadData · Ellenőrizd a méretet, ellenőrzőösszeget és formátumot. A kész feltöltés még nem jelent átvett szállítást.
consumer_idKarakterláncKötelezőA kapcsolódó import vagy egység azonosítója.
format:"uuid"consumer_kindKarakterláncKötelezőA feltöltés célja: digital_import / digital_unit.
Korlátozások
enum["digital_import", "digital_unit"]
expires_atKarakterláncKötelezőA feltöltés vagy import lejárati ideje.
format:"date-time"filenameKarakterláncKötelezőFájl
idKarakterláncKötelezőErőforrás-azonosító; a visszaadott alakban őrizze meg.
format:"uuid"product_idKarakterláncKötelezőTermékazonosító.
purposeKarakterláncKöteleződigital_import: TXT/CSV; digital_unit: egyenként eladott fájl.
Korlátozások
enum["digital_unit", "digital_import"]
received_bytesEgész számKötelezőFeltöltés… · Méret bájtban
sha256KarakterláncKötelezőSHA-256 (hex, 64)
size_bytesEgész számKötelezőMéret bájtban
statusKarakterláncKötelezőAz adott művelet által elfogadott állapot.
További mezők: Nem
ImportCommit
ImportCommit · Hozz létre tervezett vagy átvett szállítást az ellenőrzött kötegből. A tervezett egységek még nem eladhatók.
delivered_atKarakterláncKötelezőA kézbesítés dátuma és időpontja.
format:"date-time"expected_delivery_versionEgész számKötelezőSzállítási verzió; új szállításnál 0.
minimum:0maximum:0expected_sales_limit_versionEgész szám nullNem kötelezőAz értékesítési korlát verziója; publish_for_sale=true esetén kötelező.
Egész szám:minimum:0maximum:9223372036854775807expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807location_idKarakterláncKötelezőRaktárhely-azonosító.
Korlátozások
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleLogikai értékNem kötelezőtrue a véges értékesítési korlátot is növeli; false nem módosítja.
statusKarakterláncKötelezőAz adott művelet által elfogadott állapot.
Korlátozások
enum["planned", "received"]
validation_digestKarakterláncKötelezőAz ellenőrzés ellenőrzőösszege; jóváhagyáskor változatlanul küldd.
Korlátozások
pattern"^[0-9a-f]{64}$"
warehouse_idKarakterláncKötelezőRaktárazonosító.
Korlátozások
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
További mezők: Nem
ImportCreate
ImportCreate · Készíts vázlatot legfeljebb 1000 kóddal vagy 100 fájllal. Az eladható készlet még nem nő.
countEgész számKötelezőA köteg pontos egységszáma.
minimum:1maximum:1000kindKarakterláncKötelezőAz adatstruktúra változata, a megengedett értékek szerint.
Korlátozások
enum["code", "file"]
További mezők: Nem
ImportData
ImportData · Ellenőrizd az állapotot, verziót és érvényesítést. A vázlat a létrehozó API-kulcshoz tartozik.
delivery_idKarakterlánc nullKötelezőSzállítás vagy rendelési kiosztás azonosítója.
delivery_statusKarakterlánc nullKötelezőSzállítási állapot: planned / received; jóváhagyás előtt null.
delivery_versionEgész szám nullKötelezőA raktári szállítás jelenlegi verziója.
expected_countEgész számKötelezőElvárt darabszám; csak teljes köteg fogadható el.
expires_atKarakterláncKötelezőA feltöltés vagy import lejárati ideje.
format:"date-time"idKarakterláncKötelezőErőforrás-azonosító; a visszaadott alakban őrizze meg.
format:"uuid"kindKarakterláncKötelezőAz adatstruktúra változata, a megengedett értékek szerint.
Korlátozások
enum["code", "file"]
product_idKarakterláncKötelezőTermékazonosító.
statusKarakterláncKötelezőAz adott művelet által elfogadott állapot.
validated_countEgész számKötelezőA legutóbbi sikeres ellenőrzésben elfogadott darabszám.
validation_digestKarakterlánc nullKötelezőAz ellenőrzés ellenőrzőösszege; jóváhagyáskor változatlanul küldd.
versionEgész számKötelezőAz erőforrás verziója az egyidejű módosítások ellenőrzéséhez.
További mezők: Nem
ImportReceive
ImportReceive · Vedd át a meglévő egységeket a kódok vagy fájlok újraimportálása nélkül.
expected_delivery_versionEgész számKötelezőSzállítási verzió; új szállításnál 0.
minimum:1maximum:9223372036854775807expected_sales_limit_versionEgész szám nullNem kötelezőAz értékesítési korlát verziója; publish_for_sale=true esetén kötelező.
Egész szám:minimum:0maximum:9223372036854775807expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807publish_for_saleLogikai értékNem kötelezőtrue a véges értékesítési korlátot is növeli; false nem módosítja.
További mezők: Nem
ImportValidate
ImportValidate · Ellenőrizd a teljes köteget. Duplikált vagy hibás tétel elutasítja a köteget; a kódok nem rövidülnek.
code_columnKarakterlánc nullNem kötelezőA kódok CSV-oszlopa; értéke code.
Karakterlánc:const:"code"expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807formatKarakterlánc nullNem kötelezőKódlista: txt / csv; fájlokhoz upload_ids.
Korlátozások · Karakterlánc 1
enum["txt", "csv"]
source_upload_idKarakterlánc nullNem kötelezőEhhez az importhoz tartozó kész, privát TXT/CSV-feltöltés.
Karakterlánc:format:"uuid"upload_idsTömb <Karakterlánc> nullNem kötelezőAz import 1–100 kész, privát fájlfeltöltése.
Tömb:minItems:1maxItems:100Tömb / Tömb:format:"uuid"
További mezők: Nem
ImportWithdrawal
ImportWithdrawal · Csak a szabad egységeket vond vissza. A foglalt és kiosztott egységek a rendeléseknél maradnak.
expected_delivery_versionEgész számKötelezőSzállítási verzió; új szállításnál 0.
minimum:1maximum:9223372036854775807expected_order_versionEgész számKötelezőA kiosztási sorrend verziója, nem a vevő rendeléséé.
minimum:0maximum:9223372036854775807expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807reasonKarakterláncKötelezőA módosításhoz rögzített indok.
minLength:1maxLength:500
További mezők: Nem
Módosítás · Kézi foglalás — Készlet — Kérés törzse
ManualReservationUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807manual_reservedEgész számKötelezőKézzel lefoglalt mennyiség.
minimum:0maximum:2147483647reasonKarakterláncNem kötelezőA módosításhoz rögzített indok.
maxLength:500
További mezők: Nem
PoolChange
PoolChange · Professional csomagtól kapcsolhatók be az egyedi kódok és fájlok. A kikapcsolás megőrzi a korábbi vásárlások hozzáférését.
email_modeKarakterláncNem köteleződisabled: nincs e-mail; order_link: rendelési hivatkozás; code_text: kódok is szerepelhetnek.
Korlátozások
enum["disabled", "order_link", "code_text"]
enabledLogikai értékKötelezőJelzi, hogy a beállítás engedélyezett-e.
expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:0maximum:9223372036854775807retention_daysEgész szám nullNem kötelezőnull: korlátlan; 1–3650 nap az első hozzáféréstől. Nincs automatikus kódtörlés.
Egész szám:minimum:1maximum:3650
További mezők: Nem
PoolCounts
PoolCounts · Módosítás előtt olvasd be a beállításokat és darabszámokat. A válasz nem tartalmaz kódot vagy fájltartalmat.
availableEgész számKötelezőA még nem lefoglalt vagy kiadott szabad egységek száma.
heldEgész számKötelezőRendelésekhez lefoglalt, még ki nem adott egységek.
issuedEgész számKötelezőKifizetett vásárlásokhoz már kiadott egységek.
plannedEgész számKötelezőJóváhagyott, még át nem vett szállítások egységei.
retiredEgész számKötelezőVisszavont egységek az előzményekben.
stagedEgész számKötelezőBefejezetlen importok egységei, még nem készlet.
További mezők: Nem
PoolData
PoolData · Módosítás előtt olvasd be a beállításokat és darabszámokat. A válasz nem tartalmaz kódot vagy fájltartalmat.
configuredLogikai értékKötelezőMentették-e a digitális készlet beállításait.
countsPoolCountsKötelezőEgységek száma készletállapotonként.
email_modeKarakterláncKöteleződisabled: nincs e-mail; order_link: rendelési hivatkozás; code_text: kódok is szerepelhetnek.
Korlátozások
enum["disabled", "order_link", "code_text"]
enabledLogikai értékKötelezőJelzi, hogy a beállítás engedélyezett-e.
order_versionEgész számKötelezőA készlet kiosztási sorrendjének verziója.
product_idKarakterláncKötelezőTermékazonosító.
retention_daysEgész szám nullKötelezőnull: korlátlan; 1–3650 nap az első hozzáféréstől. Nincs automatikus kódtörlés.
versionEgész számKötelezőAz erőforrás verziója az egyidejű módosítások ellenőrzéséhez.
További mezők: Nem
Módosítás · Értékesítési korlát — Készlet — Kérés törzse
SalesLimitUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807reasonKarakterláncNem kötelezőA módosításhoz rögzített indok.
maxLength:500sellable_limitEgész számKötelezőÉrtékesítési korlát: -1 esetén korlátlan, 0 esetén nincs értékesíthető mennyiség.
minimum:-1maximum:2147483647
További mezők: Nem
Létrehozás · Készletkorrekció — Készlet — Kérés törzse
StockAdjustmentCreate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:0maximum:9223372036854775807locationsTömb <LocationQuantity> KötelezőRaktárhelyek.
minItems:1maxItems:100reasonKarakterláncKötelezőA módosításhoz rögzített indok.
minLength:1maxLength:500target_idKarakterláncKötelezőA művelettel érintett termék vagy variáns azonosítója.
Korlátozások
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeKarakterláncKötelezőJelzi, hogy a művelet termékre vagy variánsra vonatkozik-e.
Korlátozások
enum["product", "variant"]
warehouse_idKarakterláncKötelezőRaktárazonosító.
Korlátozások
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
További mezők: Nem
Módosítás · Készlet — Készlet — Kérés törzse
StockAdjustmentUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807locationsTömb <LocationQuantity> KötelezőRaktárhelyek.
minItems:1maxItems:100reasonKarakterláncKötelezőA módosításhoz rögzített indok.
minLength:1maxLength:500
További mezők: Nem
Listázás · Készlet — Készlet — Válasz
StockData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
activeLogikai értékKötelezőJelzi, hogy az erőforrás aktív-e.
availableEgész szám nullKötelezőÉrtékesíthető mennyiség; a null korlátlan mennyiséget jelöl.
idKarakterláncKötelezőErőforrás-azonosító; a visszaadott alakban őrizze meg. (StockData).
manual_reservedEgész számKötelezőKézzel lefoglalt mennyiség.
on_handEgész számKötelezőFizikai készletmennyiség.
reservedEgész számKötelezőRendelések által lefoglalt mennyiség.
sellable_limitEgész számKötelezőÉrtékesítési korlát: -1 esetén korlátlan, 0 esetén nincs értékesíthető mennyiség.
target_idKarakterláncKötelezőA művelettel érintett termék vagy variáns azonosítója.
target_typeKarakterláncKötelezőJelzi, hogy a művelet termékre vagy variánsra vonatkozik-e.
Korlátozások
enum["product", "variant"]
total_reservedEgész számKötelezőÖsszes lefoglalt mennyiség.
updated_atKarakterláncKötelezőA legutóbbi módosítás időpontja.
format:"date-time"versionEgész számKötelezőAz erőforrás verziója az egyidejű módosítások ellenőrzéséhez.
warehouse_idKarakterláncKötelezőRaktárazonosító.
További mezők: Nem
Lekérés · Készlet — Készlet — Válasz
StockDetailData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
activeLogikai értékKötelezőJelzi, hogy az erőforrás aktív-e.
allocationsTömb <AllocationData> KötelezőRaktárhelyekhez rendelt mennyiségek.
availableEgész szám nullKötelezőÉrtékesíthető mennyiség; a null korlátlan mennyiséget jelöl.
idKarakterláncKötelezőErőforrás-azonosító; a visszaadott alakban őrizze meg. (StockDetailData).
manual_reservedEgész számKötelezőKézzel lefoglalt mennyiség.
on_handEgész számKötelezőFizikai készletmennyiség.
reservedEgész számKötelezőRendelések által lefoglalt mennyiség.
sellable_limitEgész számKötelezőÉrtékesítési korlát: -1 esetén korlátlan, 0 esetén nincs értékesíthető mennyiség.
target_idKarakterláncKötelezőA művelettel érintett termék vagy variáns azonosítója.
target_typeKarakterláncKötelezőJelzi, hogy a művelet termékre vagy variánsra vonatkozik-e.
Korlátozások
enum["product", "variant"]
total_reservedEgész számKötelezőÖsszes lefoglalt mennyiség.
updated_atKarakterláncKötelezőA legutóbbi módosítás időpontja.
format:"date-time"versionEgész számKötelezőAz erőforrás verziója az egyidejű módosítások ellenőrzéséhez.
warehouse_idKarakterláncKötelezőRaktárazonosító.
További mezők: Nem
UnitData
UnitData · Kérj le oldalanként legfeljebb 100 egységet. A lista metaadatokat mutat, kódokat nem.
content_stateKarakterláncKötelezőTartalomállapot: present / deleting / deleted.
delivery_idKarakterlánc nullKötelezőSzállítás vagy rendelési kiosztás azonosítója.
filenameKarakterlánc nullKötelezőFájl
idKarakterláncKötelezőErőforrás-azonosító; a visszaadott alakban őrizze meg.
format:"uuid"issued_atKarakterlánc nullKötelezőElső kiadás; előtte null.
Karakterlánc:format:"date-time"kindKarakterláncKötelezőAz adatstruktúra változata, a megengedett értékek szerint.
Korlátozások
enum["file", "code"]
location_idKarakterlánc nullKötelezőRaktárhely-azonosító.
mime_typeKarakterlánc nullKötelezőA média tartalomtípusa.
payload_idKarakterláncKötelezőTartalomazonosító; nem nyilvános letöltési URL.
format:"uuid"product_idKarakterláncKötelezőTermékazonosító.
size_bytesEgész szám nullKötelezőMéret bájtban
sort_orderEgész számKötelezőPozíció a rendezett gyűjteményben.
stateKarakterláncKötelezőÁllapot
versionEgész számKötelezőAz erőforrás verziója az egyidejű módosítások ellenőrzéséhez.
warehouse_idKarakterlánc nullKötelezőRaktárazonosító.
További mezők: Nem
UnitDeletion
UnitDeletion · Távolíts el egy eladatlan kódot vagy fájlt indoklással. Foglalt vagy kiosztott egység nem törölhető így.
expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1reasonKarakterláncKötelezőA módosításhoz rögzített indok.
minLength:1maxLength:500
További mezők: Nem
UnitReorder
UnitReorder · Küldd el a teljes szűretlen oldalt a kívánt sorrendben. Elavult verzió esetén 409 érkezik.
expected_order_versionEgész számKötelezőA kiosztási sorrend verziója, nem a vevő rendeléséé.
minimum:1unit_idsTömb <Karakterlánc> KötelezőA szűretlen oldal összes egysége a kívánt sorrendben.
minItems:2maxItems:100Tömb:format:"uuid"window_cursorKarakterlánc nullNem kötelezőA szűretlen oldal kurzora; első oldalnál null.
Karakterlánc:maxLength:1024
További mezők: Nem
UnitReplacement
UnitReplacement · Cseréld ki a kódot vagy fájlt a sorrend módosítása nélkül. A változás megmarad a készlettörténetben.
codeKarakterlánc nullNem kötelezőA digitális kód pontos szövege. Őrizze meg a kis- és nagybetűket, valamint a belső szóközöket.
Karakterlánc:minLength:1maxLength:512expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1reasonKarakterláncKötelezőA módosításhoz rögzített indok.
minLength:1maxLength:500upload_idKarakterlánc nullNem kötelezőErőforrás-azonosító; a visszaadott alakban őrizze meg. · upload_id
Karakterlánc:format:"uuid"
További mezők: Nem
UnitsData
UnitsData · Kérj le oldalanként legfeljebb 100 egységet. A lista metaadatokat mutat, kódokat nem.
order_versionEgész számKötelezőA készlet kiosztási sorrendjének verziója.
totalEgész számKötelezőTeljes összeg.
unitsTömb <UnitData> KötelezőAz egységek metaadatai; a tartalom külön jogosult kérést igényel.
További mezők: Igen