Preskočiť na obsah
ShopentlyLearn

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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Kód sa vracia ako JSON, súbor ako binárne dáta. Každá požiadavka vyžaduje Bearer a oprávnenie reveal.
dataCodeContentData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Skontrolujte veľkosť, kontrolný súčet a formát. Hotový upload ešte neznamená prijatú dodávku.
dataDigitalUploadData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

ApiResponse[ImportData]

ApiResponse_ImportData_ · Skontrolujte stav, verziu a výsledok overenia. Koncept patrí API kľúču, ktorý ho vytvoril.
dataImportData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

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

Ď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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Pred zmenou načítajte nastavenia a počty. Odpoveď neobsahuje kódy ani obsah súborov.
dataPoolData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

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

Ď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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Načítajte najviac 100 jednotiek na stránku. Zoznam obsahuje metadáta bez odhalenia kódov.
dataUnitsData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

CodeContentData

CodeContentData · Kód sa vracia ako JSON, súbor ako binárne dáta. Každá požiadavka vyžaduje Bearer a oprávnenie reveal.
codeReťazecPovinné

Presné znenie digitálneho kódu. Zachovajte veľkosť písmen a vnútorné medzery.

minLength: 1maxLength: 512
Príklad: "DEMO-ONE"
delivery_idReťazec nullVoliteľné

ID dodávky alebo pridelenia objednávky.

Reťazec:format: "uuid"
Príklad: null
kindReťazecVoliteľné

Variant dátovej štruktúry opísaný povolenými hodnotami.

const: "code"
Predvolená hodnota: "code"Príklad: "code"
payload_idReťazecPovinné

ID obsahu; nejde o verejný odkaz na stiahnutie.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000004"
unit_idReťazecPovinné

ID jedného individuálneho kódu alebo súboru.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000003"

Ďalšie polia: Nie

DigitalUploadCreate

DigitalUploadCreate · Rezervujte priestor pre súbor a priraďte ho k importu alebo nahrádzanej jednotke.
consumer_idReťazecPovinné

ID súvisiaceho importu alebo jednotky.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000001"
consumer_kindReťazecPovinné

Priradenie uploadu: digital_import / digital_unit.

Obmedzenia
enum
["digital_import", "digital_unit"]
Príklad: "digital_import"
filenameReťazecPovinné

Súbor

minLength: 1maxLength: 255
Príklad: "codes.txt"
purposeReťazecPovinné

digital_import: TXT/CSV; digital_unit: jednotlivo predávaný súbor.

Obmedzenia
enum
["digital_unit", "digital_import"]
Príklad: "digital_import"
sha256ReťazecPovinné

SHA-256 (hex, 64)

Obmedzenia
pattern
"^[0-9a-f]{64}$"
Príklad: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesCelé čísloPovinné

Veľkosť v bajtoch

minimum: 1maximum: 262144000
Príklad: 18

Ďalšie polia: Nie

DigitalUploadData

DigitalUploadData · Skontrolujte veľkosť, kontrolný súčet a formát. Hotový upload ešte neznamená prijatú dodávku.
consumer_idReťazecPovinné

ID súvisiaceho importu alebo jednotky.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000001"
consumer_kindReťazecPovinné

Priradenie uploadu: digital_import / digital_unit.

Obmedzenia
enum
["digital_import", "digital_unit"]
Príklad: "digital_import"
expires_atReťazecPovinné

Čas vypršania tohto nahrávania alebo importu.

format: "date-time"
Príklad: "2026-11-03T13:00:00Z"
filenameReťazecPovinné

Súbor

Príklad: "codes.txt"
idReťazecPovinné

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

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000002"
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "example"
purposeReťazecPovinné

digital_import: TXT/CSV; digital_unit: jednotlivo predávaný súbor.

Obmedzenia
enum
["digital_unit", "digital_import"]
Príklad: "digital_import"
received_bytesCelé čísloPovinné

Nahrávanie… · Veľkosť v bajtoch

Príklad: 18
sha256ReťazecPovinné

SHA-256 (hex, 64)

Príklad: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesCelé čísloPovinné

Veľkosť v bajtoch

Príklad: 18
statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Príklad: "ready"

Ďalšie polia: Nie

ImportCommit

ImportCommit · Z overenej dávky vytvorte plánovanú alebo prijatú dodávku. Plánované jednotky sa ešte nedajú predávať.
delivered_atReťazecPovinné

Dátum a čas dodania.

format: "date-time"
Príklad: "2026-11-03T12:00:00Z"
expected_delivery_versionCelé čísloPovinné

Verzia dodávky; 0 pre novú dodávku.

minimum: 0maximum: 0
Príklad: 0
expected_sales_limit_versionCelé číslo nullVoliteľné

Verzia predajného limitu; nutná pri publish_for_sale=true.

Celé číslo:minimum: 0maximum: 9223372036854775807
Príklad: 0
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Príklad: 2
location_idReťazecPovinné

Identifikátor skladového umiestnenia.

Obmedzenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Príklad: "location-digital"
publish_for_saleLogická hodnotaVoliteľné

true zvýši aj konečný predajný limit; false ho nezmení.

Predvolená hodnota: falsePríklad: true
statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Obmedzenia
enum
["planned", "received"]
Príklad: "received"
validation_digestReťazecPovinné

Kontrolný súčet overenia; pri potvrdení odošlite bez zmeny.

Obmedzenia
pattern
"^[0-9a-f]{64}$"
Príklad: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idReťazecPovinné

Identifikátor skladu.

Obmedzenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Príklad: "warehouse-main"

Ďalšie polia: Nie

ImportCreate

ImportCreate · Pripravte koncept s najviac 1000 kódmi alebo 100 súbormi. Predajná zásoba sa zatiaľ nezvýši.
countCelé čísloPovinné

Presný počet jednotiek v dávke.

minimum: 1maximum: 1000
Príklad: 2
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["code", "file"]
Príklad: "code"

Ďalšie polia: Nie

ImportData

ImportData · Skontrolujte stav, verziu a výsledok overenia. Koncept patrí API kľúču, ktorý ho vytvoril.
delivery_idReťazec nullPovinné

ID dodávky alebo pridelenia objednávky.

Príklad: null
delivery_statusReťazec nullPovinné

Stav dodávky: planned / received; pred potvrdením null.

Príklad: null
delivery_versionCelé číslo nullPovinné

Aktuálna verzia skladovej dodávky.

Príklad: null
expected_countCelé čísloPovinné

Očakávaný počet; prijíma sa iba celá dávka.

Príklad: 2
expires_atReťazecPovinné

Čas vypršania tohto nahrávania alebo importu.

format: "date-time"
Príklad: "2026-11-03T13:00:00Z"
idReťazecPovinné

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

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000001"
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["code", "file"]
Príklad: "code"
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "example"
statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Príklad: "validated"
validated_countCelé čísloPovinné

Počet jednotiek prijatých pri poslednom úspešnom overení.

Príklad: 2
validation_digestReťazec nullPovinné

Kontrolný súčet overenia; pri potvrdení odošlite bez zmeny.

Príklad: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionCelé čísloPovinné

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

Príklad: 2

Ďalšie polia: Nie

ImportReceive

ImportReceive · Prijmite existujúce jednotky bez opätovného importu kódov či súborov.
expected_delivery_versionCelé čísloPovinné

Verzia dodávky; 0 pre novú dodávku.

minimum: 1maximum: 9223372036854775807
Príklad: 1
expected_sales_limit_versionCelé číslo nullVoliteľné

Verzia predajného limitu; nutná pri publish_for_sale=true.

Celé číslo:minimum: 0maximum: 9223372036854775807
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Príklad: 3
publish_for_saleLogická hodnotaVoliteľné

true zvýši aj konečný predajný limit; false ho nezmení.

Predvolená hodnota: false

Ďalšie polia: Nie

ImportValidate

ImportValidate · Skontrolujte celú dávku. Duplicita alebo neplatná položka odmietne dávku; kódy sa neskracujú.
code_columnReťazec nullVoliteľné

Stĺpec CSV s kódmi; použite code.

Reťazec:const: "code"
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Príklad: 1
formatReťazec nullVoliteľné

Zoznam kódov: txt / csv; pre súbory použite upload_ids.

Obmedzenia · Reťazec 1
enum
["txt", "csv"]
Príklad: "txt"
source_upload_idReťazec nullVoliteľné

Hotový súkromný TXT/CSV upload tohto importu.

Reťazec:format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000002"
upload_idsPole <Reťazec> nullVoliteľné

1–100 hotových súkromných uploadov súborov tohto importu.

Pole:minItems: 1maxItems: 100
Pole / Pole:format: "uuid"

Ďalšie polia: Nie

ImportWithdrawal

ImportWithdrawal · Odoberte iba voľné jednotky. Rezervované a pridelené jednotky zostávajú pri objednávkach.
expected_delivery_versionCelé čísloPovinné

Verzia dodávky; 0 pre novú dodávku.

minimum: 1maximum: 9223372036854775807
Príklad: 1
expected_order_versionCelé čísloPovinné

Verzia poradia prideľovania, nie zákazníckej objednávky.

minimum: 0maximum: 9223372036854775807
Príklad: 1
expected_versionCelé čísloPovinné

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

minimum: 1maximum: 9223372036854775807
Príklad: 3
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500
Príklad: "Withdraw a revoked license"

Ď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

PoolChange

PoolChange · Zapnite jednotlivé kódy alebo súbory od plánu Professional. Vypnutie zachová prístup k predchádzajúcim nákupom.
email_modeReťazecVoliteľné

disabled: bez e-mailu; order_link: odkaz na objednávku; code_text: prípadne aj kódy.

Obmedzenia
enum
["disabled", "order_link", "code_text"]
Predvolená hodnota: "disabled"Príklad: "order_link"
enabledLogická hodnotaPovinné

Či je nastavenie zapnuté.

Príklad: true
expected_versionCelé čísloPovinné

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

minimum: 0maximum: 9223372036854775807
Príklad: 0
retention_daysCelé číslo nullVoliteľné

null: bez obmedzenia; 1–3650 dní od prvého prístupu. Kódy sa automaticky nemažú.

Celé číslo:minimum: 1maximum: 3650
Príklad: null

Ďalšie polia: Nie

PoolCounts

PoolCounts · Pred zmenou načítajte nastavenia a počty. Odpoveď neobsahuje kódy ani obsah súborov.
availableCelé čísloPovinné

Počet voľných jednotiek, ktoré nie sú rezervované ani vydané.

Príklad: 1
heldCelé čísloPovinné

Jednotky rezervované pre objednávky, dosiaľ nevydané.

Príklad: 0
issuedCelé čísloPovinné

Jednotky už vydané pre zaplatené nákupy.

Príklad: 1
plannedCelé čísloPovinné

Jednotky potvrdených, dosiaľ neprijatých dodávok.

Príklad: 0
retiredCelé čísloPovinné

Vyradené jednotky zachované v histórii.

Príklad: 0
stagedCelé čísloPovinné

Jednotky nedokončených importov, zatiaľ nie sú zásobou.

Príklad: 0

Ďalšie polia: Nie

PoolData

PoolData · Pred zmenou načítajte nastavenia a počty. Odpoveď neobsahuje kódy ani obsah súborov.
configuredLogická hodnotaPovinné

Či boli uložené nastavenia digitálnej zásoby.

Príklad: true
countsPoolCounts Povinné

Počty jednotiek podľa stavu zásoby.

Príklad: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
email_modeReťazecPovinné

disabled: bez e-mailu; order_link: odkaz na objednávku; code_text: prípadne aj kódy.

Obmedzenia
enum
["disabled", "order_link", "code_text"]
Príklad: "order_link"
enabledLogická hodnotaPovinné

Či je nastavenie zapnuté.

Príklad: true
order_versionCelé čísloPovinné

Verzia poradia prideľovania v zásobe.

Príklad: 2
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "example"
retention_daysCelé číslo nullPovinné

null: bez obmedzenia; 1–3650 dní od prvého prístupu. Kódy sa automaticky nemažú.

Príklad: null
versionCelé čísloPovinné

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

Príklad: 1

Ď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

UnitData

UnitData · Načítajte najviac 100 jednotiek na stránku. Zoznam obsahuje metadáta bez odhalenia kódov.
content_stateReťazecPovinné

Stav obsahu: present / deleting / deleted.

Príklad: "present"
delivery_idReťazec nullPovinné

ID dodávky alebo pridelenia objednávky.

Príklad: "delivery-example"
filenameReťazec nullPovinné

Súbor

Príklad: null
idReťazecPovinné

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

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000003"
issued_atReťazec nullPovinné

Prvé vydanie; pred ním null.

Reťazec:format: "date-time"
Príklad: null
kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia
enum
["file", "code"]
Príklad: "code"
location_idReťazec nullPovinné

Identifikátor skladového umiestnenia.

Príklad: "location-digital"
mime_typeReťazec nullPovinné

Typ obsahu média.

Príklad: null
payload_idReťazecPovinné

ID obsahu; nejde o verejný odkaz na stiahnutie.

format: "uuid"
Príklad: "00000000-0000-4000-8000-000000000004"
product_idReťazecPovinné

Identifikátor produktu.

Príklad: "example"
size_bytesCelé číslo nullPovinné

Veľkosť v bajtoch

Príklad: null
sort_orderCelé čísloPovinné

Pozícia v zoradenom zozname.

Príklad: 1
stateReťazecPovinné

Stav

Príklad: "available"
versionCelé čísloPovinné

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

Príklad: 1
warehouse_idReťazec nullPovinné

Identifikátor skladu.

Príklad: "warehouse-main"

Ďalšie polia: Nie

UnitDeletion

UnitDeletion · Odoberte nepredaný kód alebo súbor s uvedením dôvodu. Rezervované či pridelené jednotky sa odmietnu.
expected_versionCelé čísloPovinné

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

minimum: 1
Príklad: 1
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500
Príklad: "Withdraw a revoked license"

Ďalšie polia: Nie

UnitReorder

UnitReorder · Odošlite celú nefiltrovanú stránku v požadovanom poradí. Zastaraná verzia vráti 409.
expected_order_versionCelé čísloPovinné

Verzia poradia prideľovania, nie zákazníckej objednávky.

minimum: 1
Príklad: 1
unit_idsPole <Reťazec> Povinné

Všetky jednotky nefiltrovanej stránky v požadovanom poradí.

minItems: 2maxItems: 100
Pole:format: "uuid"
Príklad: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorReťazec nullVoliteľné

Kurzor nefiltrovanej stránky; null pre prvú stránku.

Reťazec:maxLength: 1024

Ďalšie polia: Nie

UnitReplacement

UnitReplacement · Nahraďte kód alebo súbor bez zmeny poradia. Zmena zostane v histórii skladu.
codeReťazec nullVoliteľné

Presné znenie digitálneho kódu. Zachovajte veľkosť písmen a vnútorné medzery.

Reťazec:minLength: 1maxLength: 512
Príklad: "SYNTHETIC-REPLACEMENT"
expected_versionCelé čísloPovinné

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

minimum: 1
Príklad: 1
reasonReťazecPovinné

Dôvod zaznamenaný pri zmene.

minLength: 1maxLength: 500
Príklad: "Replace an invalid activation code"
upload_idReťazec nullVoliteľné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. · upload_id

Reťazec:format: "uuid"

Ďalšie polia: Nie

UnitsData

UnitsData · Načítajte najviac 100 jednotiek na stránku. Zoznam obsahuje metadáta bez odhalenia kódov.
order_versionCelé čísloPovinné

Verzia poradia prideľovania v zásobe.

Príklad: 2
totalCelé čísloPovinné

Celková suma.

Príklad: 1
unitsPole <UnitData > Povinné

Metadáta jednotiek; obsah vyžaduje samostatnú oprávnenú požiadavku.

Príklad: [{"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"}]

Ďalšie polia: Áno