Dátové schémy: Zásoby

Dátové schémy: Zásoby. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Množstvá priradené skladovým umiestneniam

AllocationData · Schéma · Dátové schémy: Zásoby

location_codeReťazecPovinné: Kód skladového umiestnenia.

Príklad: "example"
location_idReťazecPovinné: Identifikátor skladového umiestnenia.

Príklad: "example"
location_nameReťazecPovinné: Názov skladového umiestnenia.

Príklad: "example"
on_handCelé čísloPovinné: Fyzické skladové množstvo.

Príklad: 10

Ďalšie polia: Nie

Zobraziť zoznam · Zásoby — Zásoby — Odpoveď

ApiResponse_list_StockData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <StockData > Povinné: Príklad odpovede · ApiResponse_list_StockData__.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

Príklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ďalšie polia: Nie

Načítať · Zásoby — Zásoby — Odpoveď

ApiResponse_StockDetailData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataStockDetailData Povinné: Príklad odpovede · StockDetailData.

Príklad: {"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 Povinné: Metaúdaje odpovede.

Príklad: {"request_id":"example"}

Ďalšie polia: Nie

Upraviť · Ručná rezervácia — Zásoby — Telo požiadavky

ManualReservationUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

expected_versionCelé čísloPovinné: Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1
manual_reservedCelé čísloPovinné: Ručne rezervované množstvo.

minimum: 0maximum: 2147483647

Príklad: 1
reasonReťazecVoliteľné: Dôvod zaznamenaný pri zmene.

maxLength: 500

Predvolená hodnota: ""

Ďalšie polia: Nie

Upraviť · Limit predaja — Zásoby — Telo požiadavky

SalesLimitUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

expected_versionCelé čísloPovinné: Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1
reasonReťazecVoliteľné: Dôvod zaznamenaný pri zmene.

maxLength: 500

Predvolená hodnota: ""
sellable_limitCelé čísloPovinné: Predajný limit: -1 znamená neobmedzený predaj a 0 zakazuje dostupný predaj.

minimum: -1maximum: 2147483647

Príklad: 1

Ďalšie polia: Nie

Vytvoriť · Korekcia zásob — Zásoby — Telo požiadavky

StockAdjustmentCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 0maximum: 9223372036854775807

Príklad: 0

locationsPole <LocationQuantity > Povinné

Skladové umiestnenia.

minItems: 1maxItems: 100

Príklad: [{"location_id":"example","on_hand":1}]

reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500

Príklad: "Example"

target_idReťazecPovinné

Identifikátor produktu alebo variantu, ktorého sa operácia týka.

Obmedzenia

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Príklad: "example"

target_typeReťazecPovinné

Či sa operácia týka produktu alebo variantu.

Obmedzenia

enum: ["product", "variant"]

Príklad: "product"

warehouse_idReťazecPovinné

Identifikátor skladu.

Obmedzenia

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Príklad: "example"

Ďalšie polia: Nie

Upraviť · Zásoby — Zásoby — Telo požiadavky

StockAdjustmentUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

expected_versionCelé čísloPovinné: Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1
locationsPole <LocationQuantity > Povinné: Skladové umiestnenia.

minItems: 1maxItems: 100

Príklad: [{"location_id":"example","on_hand":1}]
reasonReťazecPovinné: Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500

Príklad: "Example"

Ďalšie polia: Nie

Zobraziť zoznam · Zásoby — Zásoby — Odpoveď

StockData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

activeLogická hodnotaPovinné

Či je zdroj aktívny.

Príklad: true

availableCelé číslo nullPovinné

Množstvo dostupné na predaj; null znamená neobmedzené množstvo.

Príklad: 5

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (StockData).

Príklad: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedCelé čísloPovinné

Ručne rezervované množstvo.

Príklad: 2

on_handCelé čísloPovinné

Fyzické skladové množstvo.

Príklad: 10

reservedCelé čísloPovinné

Množstvo rezervované objednávkami.

Príklad: 3

sellable_limitCelé čísloPovinné

Predajný limit: -1 znamená neobmedzený predaj a 0 zakazuje dostupný predaj.

Príklad: 10

target_idReťazecPovinné

Identifikátor produktu alebo variantu, ktorého sa operácia týka.

Príklad: "example"

target_typeReťazecPovinné

Či sa operácia týka produktu alebo variantu.

Obmedzenia

enum: ["product", "variant"]

Príklad: "product"

total_reservedCelé čísloPovinné

Celkové rezervované množstvo.

Príklad: 5

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

warehouse_idReťazecPovinné

Identifikátor skladu.

Príklad: "example"

Ďalšie polia: Nie

Načítať · Zásoby — Zásoby — Odpoveď

StockDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

activeLogická hodnotaPovinné

Či je zdroj aktívny.

Príklad: true

allocationsPole <AllocationData > Povinné

Množstvá priradené skladovým umiestneniam.

Príklad: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableCelé číslo nullPovinné

Množstvo dostupné na predaj; null znamená neobmedzené množstvo.

Príklad: 5

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (StockDetailData).

Príklad: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedCelé čísloPovinné

Ručne rezervované množstvo.

Príklad: 2

on_handCelé čísloPovinné

Fyzické skladové množstvo.

Príklad: 10

reservedCelé čísloPovinné

Množstvo rezervované objednávkami.

Príklad: 3

sellable_limitCelé čísloPovinné

Predajný limit: -1 znamená neobmedzený predaj a 0 zakazuje dostupný predaj.

Príklad: 10

target_idReťazecPovinné

Identifikátor produktu alebo variantu, ktorého sa operácia týka.

Príklad: "example"

target_typeReťazecPovinné

Či sa operácia týka produktu alebo variantu.

Obmedzenia

enum: ["product", "variant"]

Príklad: "product"

total_reservedCelé čísloPovinné

Celkové rezervované množstvo.

Príklad: 5

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

warehouse_idReťazecPovinné

Identifikátor skladu.

Príklad: "example"

Ďalšie polia: Nie