Ugrás a tartalomhoz
ShopentlyLearn

Adatsémák: Készlet

Adatsémák: Készlet. Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Adatsémák

Raktárhelyekhez rendelt mennyiségek

AllocationData · Séma · Adatsémák: Készlet
location_codeKarakterláncKötelező

Raktárhelykód.

Példa: "example"
location_idKarakterláncKötelező

Raktárhely-azonosító.

Példa: "example"
location_nameKarakterláncKötelező

A raktárhely neve.

Példa: "example"
on_handEgész számKötelező

Fizikai készletmennyiség.

Példa: 10

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.
dataCodeContentData Kötelező

A sikeres válasz adatai.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example-request"}

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.
dataDigitalUploadData Kötelező

A sikeres válasz adatai.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example-request"}

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.
dataImportData Kötelező

A sikeres válasz adatai.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example-request"}

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__.

Példa: [{"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

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.
dataPoolData Kötelező

A sikeres válasz adatai.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example-request"}

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.
dataStockDetailData Kötelező

Példaválasz · StockDetailData.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example"}

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.
dataUnitsData Kötelező

A sikeres válasz adatai.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

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: 512
Példa: "DEMO-ONE"
delivery_idKarakterlánc nullNem kötelező

Szállítás vagy rendelési kiosztás azonosítója.

Karakterlánc:format: "uuid"
Példa: null
kindKarakterláncNem kötelező

Az adatstruktúra változata, a megengedett értékek szerint.

const: "code"
Alapértelmezett: "code"Példa: "code"
payload_idKarakterláncKötelező

Tartalomazonosító; nem nyilvános letöltési URL.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000004"
unit_idKarakterláncKötelező

Egy egyedi kód vagy fájl azonosítója.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000003"

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"
Példa: "00000000-0000-4000-8000-000000000001"
consumer_kindKarakterláncKötelező

A feltöltés célja: digital_import / digital_unit.

Korlátozások
enum
["digital_import", "digital_unit"]
Példa: "digital_import"
filenameKarakterláncKötelező

Fájl

minLength: 1maxLength: 255
Példa: "codes.txt"
purposeKarakterláncKötelező

digital_import: TXT/CSV; digital_unit: egyenként eladott fájl.

Korlátozások
enum
["digital_unit", "digital_import"]
Példa: "digital_import"
sha256KarakterláncKötelező

SHA-256 (hex, 64)

Korlátozások
pattern
"^[0-9a-f]{64}$"
Példa: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesEgész számKötelező

Méret bájtban

minimum: 1maximum: 262144000
Példa: 18

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"
Példa: "00000000-0000-4000-8000-000000000001"
consumer_kindKarakterláncKötelező

A feltöltés célja: digital_import / digital_unit.

Korlátozások
enum
["digital_import", "digital_unit"]
Példa: "digital_import"
expires_atKarakterláncKötelező

A feltöltés vagy import lejárati ideje.

format: "date-time"
Példa: "2026-11-03T13:00:00Z"
filenameKarakterláncKötelező

Fájl

Példa: "codes.txt"
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000002"
product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"
purposeKarakterláncKötelező

digital_import: TXT/CSV; digital_unit: egyenként eladott fájl.

Korlátozások
enum
["digital_unit", "digital_import"]
Példa: "digital_import"
received_bytesEgész számKötelező

Feltöltés… · Méret bájtban

Példa: 18
sha256KarakterláncKötelező

SHA-256 (hex, 64)

Példa: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesEgész számKötelező

Méret bájtban

Példa: 18
statusKarakterláncKötelező

Az adott művelet által elfogadott állapot.

Példa: "ready"

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"
Példa: "2026-11-03T12:00:00Z"
expected_delivery_versionEgész számKötelező

Szállítási verzió; új szállításnál 0.

minimum: 0maximum: 0
Példa: 0
expected_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: 9223372036854775807
Példa: 0
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: 9223372036854775807
Példa: 2
location_idKarakterláncKötelező

Raktárhely-azonosító.

Korlátozások
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Példa: "location-digital"
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.

Alapértelmezett: falsePélda: true
statusKarakterláncKötelező

Az adott művelet által elfogadott állapot.

Korlátozások
enum
["planned", "received"]
Példa: "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}$"
Példa: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idKarakterláncKötelező

Raktárazonosító.

Korlátozások
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Példa: "warehouse-main"

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: 1000
Példa: 2
kindKarakterláncKötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások
enum
["code", "file"]
Példa: "code"

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.

Példa: null
delivery_statusKarakterlánc nullKötelező

Szállítási állapot: planned / received; jóváhagyás előtt null.

Példa: null
delivery_versionEgész szám nullKötelező

A raktári szállítás jelenlegi verziója.

Példa: null
expected_countEgész számKötelező

Elvárt darabszám; csak teljes köteg fogadható el.

Példa: 2
expires_atKarakterláncKötelező

A feltöltés vagy import lejárati ideje.

format: "date-time"
Példa: "2026-11-03T13:00:00Z"
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000001"
kindKarakterláncKötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások
enum
["code", "file"]
Példa: "code"
product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"
statusKarakterláncKötelező

Az adott művelet által elfogadott állapot.

Példa: "validated"
validated_countEgész számKötelező

A legutóbbi sikeres ellenőrzésben elfogadott darabszám.

Példa: 2
validation_digestKarakterlánc nullKötelező

Az ellenőrzés ellenőrzőösszege; jóváhagyáskor változatlanul küldd.

Példa: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 2

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: 9223372036854775807
Példa: 1
expected_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: 9223372036854775807
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: 9223372036854775807
Példa: 3
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.

Alapértelmezett: false

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: 9223372036854775807
Példa: 1
formatKarakterlánc nullNem kötelező

Kódlista: txt / csv; fájlokhoz upload_ids.

Korlátozások · Karakterlánc 1
enum
["txt", "csv"]
Példa: "txt"
source_upload_idKarakterlánc nullNem kötelező

Ehhez az importhoz tartozó kész, privát TXT/CSV-feltöltés.

Karakterlánc:format: "uuid"
Példa: "00000000-0000-4000-8000-000000000002"
upload_idsTömb <Karakterlánc> nullNem kötelező

Az import 1–100 kész, privát fájlfeltöltése.

Tömb:minItems: 1maxItems: 100
Tö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: 9223372036854775807
Példa: 1
expected_order_versionEgész számKötelező

A kiosztási sorrend verziója, nem a vevő rendeléséé.

minimum: 0maximum: 9223372036854775807
Példa: 1
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: 9223372036854775807
Példa: 3
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Withdraw a revoked license"

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: 9223372036854775807
Példa: 1
manual_reservedEgész számKötelező

Kézzel lefoglalt mennyiség.

minimum: 0maximum: 2147483647
Példa: 1
reasonKarakterláncNem kötelező

A módosításhoz rögzített indok.

maxLength: 500
Alapértelmezett: ""

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"]
Alapértelmezett: "disabled"Példa: "order_link"
enabledLogikai értékKötelező

Jelzi, hogy a beállítás engedélyezett-e.

Példa: true
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: 9223372036854775807
Példa: 0
retention_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
Példa: null

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.

Példa: 1
heldEgész számKötelező

Rendelésekhez lefoglalt, még ki nem adott egységek.

Példa: 0
issuedEgész számKötelező

Kifizetett vásárlásokhoz már kiadott egységek.

Példa: 1
plannedEgész számKötelező

Jóváhagyott, még át nem vett szállítások egységei.

Példa: 0
retiredEgész számKötelező

Visszavont egységek az előzményekben.

Példa: 0
stagedEgész számKötelező

Befejezetlen importok egységei, még nem készlet.

Példa: 0

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.

Példa: true
countsPoolCounts Kötelező

Egységek száma készletállapotonként.

Példa: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
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"]
Példa: "order_link"
enabledLogikai értékKötelező

Jelzi, hogy a beállítás engedélyezett-e.

Példa: true
order_versionEgész számKötelező

A készlet kiosztási sorrendjének verziója.

Példa: 2
product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"
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.

Példa: null
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

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: 9223372036854775807
Példa: 1
reasonKarakterláncNem kötelező

A módosításhoz rögzített indok.

maxLength: 500
Alapértelmezett: ""
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.

minimum: -1maximum: 2147483647
Példa: 1

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: 9223372036854775807
Példa: 0
locationsTömb <LocationQuantity > Kötelező

Raktárhelyek.

minItems: 1maxItems: 100
Példa: [{"location_id":"example","on_hand":1}]
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Example"
target_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}$"
Példa: "example"
target_typeKarakterláncKötelező

Jelzi, hogy a művelet termékre vagy variánsra vonatkozik-e.

Korlátozások
enum
["product", "variant"]
Példa: "product"
warehouse_idKarakterláncKötelező

Raktárazonosító.

Korlátozások
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Példa: "example"

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: 9223372036854775807
Példa: 1
locationsTömb <LocationQuantity > Kötelező

Raktárhelyek.

minItems: 1maxItems: 100
Példa: [{"location_id":"example","on_hand":1}]
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Example"

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.

Példa: true
availableEgész szám nullKötelező

Értékesíthető mennyiség; a null korlátlan mennyiséget jelöl.

Példa: 5
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (StockData).

Példa: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedEgész számKötelező

Kézzel lefoglalt mennyiség.

Példa: 2
on_handEgész számKötelező

Fizikai készletmennyiség.

Példa: 10
reservedEgész számKötelező

Rendelések által lefoglalt mennyiség.

Példa: 3
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.

Példa: 10
target_idKarakterláncKötelező

A művelettel érintett termék vagy variáns azonosítója.

Példa: "example"
target_typeKarakterláncKötelező

Jelzi, hogy a művelet termékre vagy variánsra vonatkozik-e.

Korlátozások
enum
["product", "variant"]
Példa: "product"
total_reservedEgész számKötelező

Összes lefoglalt mennyiség.

Példa: 5
updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1
warehouse_idKarakterláncKötelező

Raktárazonosító.

Példa: "example"

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.

Példa: true
allocationsTömb <AllocationData > Kötelező

Raktárhelyekhez rendelt mennyiségek.

Példa: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]
availableEgész szám nullKötelező

Értékesíthető mennyiség; a null korlátlan mennyiséget jelöl.

Példa: 5
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (StockDetailData).

Példa: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedEgész számKötelező

Kézzel lefoglalt mennyiség.

Példa: 2
on_handEgész számKötelező

Fizikai készletmennyiség.

Példa: 10
reservedEgész számKötelező

Rendelések által lefoglalt mennyiség.

Példa: 3
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.

Példa: 10
target_idKarakterláncKötelező

A művelettel érintett termék vagy variáns azonosítója.

Példa: "example"
target_typeKarakterláncKötelező

Jelzi, hogy a művelet termékre vagy variánsra vonatkozik-e.

Korlátozások
enum
["product", "variant"]
Példa: "product"
total_reservedEgész számKötelező

Összes lefoglalt mennyiség.

Példa: 5
updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1
warehouse_idKarakterláncKötelező

Raktárazonosító.

Példa: "example"

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.

Példa: "present"
delivery_idKarakterlánc nullKötelező

Szállítás vagy rendelési kiosztás azonosítója.

Példa: "delivery-example"
filenameKarakterlánc nullKötelező

Fájl

Példa: null
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000003"
issued_atKarakterlánc nullKötelező

Első kiadás; előtte null.

Karakterlánc:format: "date-time"
Példa: null
kindKarakterláncKötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások
enum
["file", "code"]
Példa: "code"
location_idKarakterlánc nullKötelező

Raktárhely-azonosító.

Példa: "location-digital"
mime_typeKarakterlánc nullKötelező

A média tartalomtípusa.

Példa: null
payload_idKarakterláncKötelező

Tartalomazonosító; nem nyilvános letöltési URL.

format: "uuid"
Példa: "00000000-0000-4000-8000-000000000004"
product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"
size_bytesEgész szám nullKötelező

Méret bájtban

Példa: null
sort_orderEgész számKötelező

Pozíció a rendezett gyűjteményben.

Példa: 1
stateKarakterláncKötelező

Állapot

Példa: "available"
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1
warehouse_idKarakterlánc nullKötelező

Raktárazonosító.

Példa: "warehouse-main"

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: 1
Példa: 1
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Withdraw a revoked license"

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: 1
Példa: 1
unit_idsTömb <Karakterlánc> Kötelező

A szűretlen oldal összes egysége a kívánt sorrendben.

minItems: 2maxItems: 100
Tömb:format: "uuid"
Példa: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
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: 512
Példa: "SYNTHETIC-REPLACEMENT"
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: 1
Példa: 1
reasonKarakterláncKötelező

A módosításhoz rögzített indok.

minLength: 1maxLength: 500
Példa: "Replace an invalid activation code"
upload_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.

Példa: 2
totalEgész számKötelező

Teljes összeg.

Példa: 1
unitsTömb <UnitData > Kötelező

Az egységek metaadatai; a tartalom külön jogosult kérést igényel.

Példa: [{"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"}]

További mezők: Igen