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.
location_idReťazecPovinnéIdentifikátor skladového umiestnenia.
location_nameReťazecPovinnéNázov skladového umiestnenia.
on_handCelé čísloPovinnéFyzické skladové množstvo.
Ď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.
dataCodeContentDataPovinnéObsah úspešnej odpovede.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Ď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.
dataDigitalUploadDataPovinnéObsah úspešnej odpovede.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Ďalšie polia: Nie
ApiResponse[ImportData]
ApiResponse_ImportData_ · Skontrolujte stav, verziu a výsledok overenia. Koncept patrí API kľúču, ktorý ho vytvoril.
dataImportDataPovinnéObsah úspešnej odpovede.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Ď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__.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Ďalšie polia: Nie
ApiResponse[PoolData]
ApiResponse_PoolData_ · Pred zmenou načítajte nastavenia a počty. Odpoveď neobsahuje kódy ani obsah súborov.
dataPoolDataPovinnéObsah úspešnej odpovede.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Ď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.
dataStockDetailDataPovinnéPríklad odpovede · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Ďalšie polia: Nie
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Načítajte najviac 100 jednotiek na stránku. Zoznam obsahuje metadáta bez odhalenia kódov.
dataUnitsDataPovinnéObsah úspešnej odpovede.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Ď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:512delivery_idReťazec nullVoliteľnéID dodávky alebo pridelenia objednávky.
Reťazec:format:"uuid"kindReťazecVoliteľnéVariant dátovej štruktúry opísaný povolenými hodnotami.
const:"code"payload_idReťazecPovinnéID obsahu; nejde o verejný odkaz na stiahnutie.
format:"uuid"unit_idReťazecPovinnéID jedného individuálneho kódu alebo súboru.
format:"uuid"
Ď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"consumer_kindReťazecPovinnéPriradenie uploadu: digital_import / digital_unit.
Obmedzenia
enum["digital_import", "digital_unit"]
filenameReťazecPovinnéSúbor
minLength:1maxLength:255purposeReťazecPovinnédigital_import: TXT/CSV; digital_unit: jednotlivo predávaný súbor.
Obmedzenia
enum["digital_unit", "digital_import"]
sha256ReťazecPovinnéSHA-256 (hex, 64)
Obmedzenia
pattern"^[0-9a-f]{64}$"
size_bytesCelé čísloPovinnéVeľkosť v bajtoch
minimum:1maximum:262144000
Ď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"consumer_kindReťazecPovinnéPriradenie uploadu: digital_import / digital_unit.
Obmedzenia
enum["digital_import", "digital_unit"]
expires_atReťazecPovinnéČas vypršania tohto nahrávania alebo importu.
format:"date-time"filenameReťazecPovinnéSúbor
idReťazecPovinnéIdentifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.
format:"uuid"product_idReťazecPovinnéIdentifikátor produktu.
purposeReťazecPovinnédigital_import: TXT/CSV; digital_unit: jednotlivo predávaný súbor.
Obmedzenia
enum["digital_unit", "digital_import"]
received_bytesCelé čísloPovinnéNahrávanie… · Veľkosť v bajtoch
sha256ReťazecPovinnéSHA-256 (hex, 64)
size_bytesCelé čísloPovinnéVeľkosť v bajtoch
statusReťazecPovinnéStav prijímaný touto konkrétnou operáciou.
Ď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"expected_delivery_versionCelé čísloPovinnéVerzia dodávky; 0 pre novú dodávku.
minimum:0maximum:0expected_sales_limit_versionCelé číslo nullVoliteľnéVerzia predajného limitu; nutná pri publish_for_sale=true.
Celé číslo:minimum:0maximum:9223372036854775807expected_versionCelé čísloPovinnéVerzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.
minimum:1maximum:9223372036854775807location_idReťazecPovinnéIdentifikátor skladového umiestnenia.
Obmedzenia
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleLogická hodnotaVoliteľnétrue zvýši aj konečný predajný limit; false ho nezmení.
statusReťazecPovinnéStav prijímaný touto konkrétnou operáciou.
Obmedzenia
enum["planned", "received"]
validation_digestReťazecPovinnéKontrolný súčet overenia; pri potvrdení odošlite bez zmeny.
Obmedzenia
pattern"^[0-9a-f]{64}$"
warehouse_idReťazecPovinnéIdentifikátor skladu.
Obmedzenia
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Ď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:1000kindReťazecPovinnéVariant dátovej štruktúry opísaný povolenými hodnotami.
Obmedzenia
enum["code", "file"]
Ď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.
delivery_statusReťazec nullPovinnéStav dodávky: planned / received; pred potvrdením null.
delivery_versionCelé číslo nullPovinnéAktuálna verzia skladovej dodávky.
expected_countCelé čísloPovinnéOčakávaný počet; prijíma sa iba celá dávka.
expires_atReťazecPovinnéČas vypršania tohto nahrávania alebo importu.
format:"date-time"idReťazecPovinnéIdentifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.
format:"uuid"kindReťazecPovinnéVariant dátovej štruktúry opísaný povolenými hodnotami.
Obmedzenia
enum["code", "file"]
product_idReťazecPovinnéIdentifikátor produktu.
statusReťazecPovinnéStav prijímaný touto konkrétnou operáciou.
validated_countCelé čísloPovinnéPočet jednotiek prijatých pri poslednom úspešnom overení.
validation_digestReťazec nullPovinnéKontrolný súčet overenia; pri potvrdení odošlite bez zmeny.
versionCelé čísloPovinnéVerzia zdroja používaná na riadenie súbežných zmien.
Ď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:9223372036854775807expected_sales_limit_versionCelé číslo nullVoliteľnéVerzia predajného limitu; nutná pri publish_for_sale=true.
Celé číslo:minimum:0maximum:9223372036854775807expected_versionCelé čísloPovinnéVerzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.
minimum:1maximum:9223372036854775807publish_for_saleLogická hodnotaVoliteľnétrue zvýši aj konečný predajný limit; false ho nezmení.
Ď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:9223372036854775807formatReťazec nullVoliteľnéZoznam kódov: txt / csv; pre súbory použite upload_ids.
Obmedzenia · Reťazec 1
enum["txt", "csv"]
source_upload_idReťazec nullVoliteľnéHotový súkromný TXT/CSV upload tohto importu.
Reťazec:format:"uuid"upload_idsPole <Reťazec> nullVoliteľné1–100 hotových súkromných uploadov súborov tohto importu.
Pole:minItems:1maxItems:100Pole / 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:9223372036854775807expected_order_versionCelé čísloPovinnéVerzia poradia prideľovania, nie zákazníckej objednávky.
minimum:0maximum:9223372036854775807expected_versionCelé čísloPovinnéVerzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.
minimum:1maximum:9223372036854775807reasonReťazecPovinnéDôvod zaznamenaný pri zmene.
minLength:1maxLength:500
Ď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:9223372036854775807manual_reservedCelé čísloPovinnéRučne rezervované množstvo.
minimum:0maximum:2147483647reasonReťazecVoliteľnéDôvod zaznamenaný pri zmene.
maxLength:500
Ď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"]
enabledLogická hodnotaPovinnéČi je nastavenie zapnuté.
expected_versionCelé čísloPovinnéVerzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.
minimum:0maximum:9223372036854775807retention_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
Ď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é.
heldCelé čísloPovinnéJednotky rezervované pre objednávky, dosiaľ nevydané.
issuedCelé čísloPovinnéJednotky už vydané pre zaplatené nákupy.
plannedCelé čísloPovinnéJednotky potvrdených, dosiaľ neprijatých dodávok.
retiredCelé čísloPovinnéVyradené jednotky zachované v histórii.
stagedCelé čísloPovinnéJednotky nedokončených importov, zatiaľ nie sú zásobou.
Ď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.
countsPoolCountsPovinnéPočty jednotiek podľa stavu zásoby.
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"]
enabledLogická hodnotaPovinnéČi je nastavenie zapnuté.
order_versionCelé čísloPovinnéVerzia poradia prideľovania v zásobe.
product_idReťazecPovinnéIdentifikátor produktu.
retention_daysCelé číslo nullPovinnénull: bez obmedzenia; 1–3650 dní od prvého prístupu. Kódy sa automaticky nemažú.
versionCelé čísloPovinnéVerzia zdroja používaná na riadenie súbežných zmien.
Ď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:9223372036854775807reasonReťazecVoliteľnéDôvod zaznamenaný pri zmene.
maxLength:500sellable_limitCelé čísloPovinnéPredajný limit: -1 znamená neobmedzený predaj a 0 zakazuje dostupný predaj.
minimum:-1maximum:2147483647
Ď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:9223372036854775807locationsPole <LocationQuantity> PovinnéSkladové umiestnenia.
minItems:1maxItems:100reasonReťazecPovinnéDôvod zaznamenaný pri zmene.
minLength:1maxLength:500target_idReťazecPovinnéIdentifikátor produktu alebo variantu, ktorého sa operácia týka.
Obmedzenia
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeReťazecPovinnéČi sa operácia týka produktu alebo variantu.
Obmedzenia
enum["product", "variant"]
warehouse_idReťazecPovinnéIdentifikátor skladu.
Obmedzenia
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Ď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:9223372036854775807locationsPole <LocationQuantity> PovinnéSkladové umiestnenia.
minItems:1maxItems:100reasonReťazecPovinnéDôvod zaznamenaný pri zmene.
minLength:1maxLength:500
Ď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.
availableCelé číslo nullPovinnéMnožstvo dostupné na predaj; null znamená neobmedzené množstvo.
idReťazecPovinnéIdentifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (StockData).
manual_reservedCelé čísloPovinnéRučne rezervované množstvo.
on_handCelé čísloPovinnéFyzické skladové množstvo.
reservedCelé čísloPovinnéMnožstvo rezervované objednávkami.
sellable_limitCelé čísloPovinnéPredajný limit: -1 znamená neobmedzený predaj a 0 zakazuje dostupný predaj.
target_idReťazecPovinnéIdentifikátor produktu alebo variantu, ktorého sa operácia týka.
target_typeReťazecPovinnéČi sa operácia týka produktu alebo variantu.
Obmedzenia
enum["product", "variant"]
total_reservedCelé čísloPovinnéCelkové rezervované množstvo.
updated_atReťazecPovinnéČas poslednej aktualizácie.
format:"date-time"versionCelé čísloPovinnéVerzia zdroja používaná na riadenie súbežných zmien.
warehouse_idReťazecPovinnéIdentifikátor skladu.
Ď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.
allocationsPole <AllocationData> PovinnéMnožstvá priradené skladovým umiestneniam.
availableCelé číslo nullPovinnéMnožstvo dostupné na predaj; null znamená neobmedzené množstvo.
idReťazecPovinnéIdentifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (StockDetailData).
manual_reservedCelé čísloPovinnéRučne rezervované množstvo.
on_handCelé čísloPovinnéFyzické skladové množstvo.
reservedCelé čísloPovinnéMnožstvo rezervované objednávkami.
sellable_limitCelé čísloPovinnéPredajný limit: -1 znamená neobmedzený predaj a 0 zakazuje dostupný predaj.
target_idReťazecPovinnéIdentifikátor produktu alebo variantu, ktorého sa operácia týka.
target_typeReťazecPovinnéČi sa operácia týka produktu alebo variantu.
Obmedzenia
enum["product", "variant"]
total_reservedCelé čísloPovinnéCelkové rezervované množstvo.
updated_atReťazecPovinnéČas poslednej aktualizácie.
format:"date-time"versionCelé čísloPovinnéVerzia zdroja používaná na riadenie súbežných zmien.
warehouse_idReťazecPovinnéIdentifikátor skladu.
Ď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.
delivery_idReťazec nullPovinnéID dodávky alebo pridelenia objednávky.
filenameReťazec nullPovinnéSúbor
idReťazecPovinnéIdentifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.
format:"uuid"issued_atReťazec nullPovinnéPrvé vydanie; pred ním null.
Reťazec:format:"date-time"kindReťazecPovinnéVariant dátovej štruktúry opísaný povolenými hodnotami.
Obmedzenia
enum["file", "code"]
location_idReťazec nullPovinnéIdentifikátor skladového umiestnenia.
mime_typeReťazec nullPovinnéTyp obsahu média.
payload_idReťazecPovinnéID obsahu; nejde o verejný odkaz na stiahnutie.
format:"uuid"product_idReťazecPovinnéIdentifikátor produktu.
size_bytesCelé číslo nullPovinnéVeľkosť v bajtoch
sort_orderCelé čísloPovinnéPozícia v zoradenom zozname.
stateReťazecPovinnéStav
versionCelé čísloPovinnéVerzia zdroja používaná na riadenie súbežných zmien.
warehouse_idReťazec nullPovinnéIdentifikátor skladu.
Ď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:1reasonReťazecPovinnéDôvod zaznamenaný pri zmene.
minLength:1maxLength:500
Ď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:1unit_idsPole <Reťazec> PovinnéVšetky jednotky nefiltrovanej stránky v požadovanom poradí.
minItems:2maxItems:100Pole:format:"uuid"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:512expected_versionCelé čísloPovinnéVerzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.
minimum:1reasonReťazecPovinnéDôvod zaznamenaný pri zmene.
minLength:1maxLength:500upload_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.
totalCelé čísloPovinnéCelková suma.
unitsPole <UnitData> PovinnéMetadáta jednotiek; obsah vyžaduje samostatnú oprávnenú požiadavku.
Ďalšie polia: Áno