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

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

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

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

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