Datová schémata
Množství přiřazená skladovým umístěním
AllocationData · Schéma · Datová schémata: Zásoby
location_codeŘetězecPovinnéKód skladového umístění.
location_idŘetězecPovinnéIdentifikátor skladového umístění.
location_nameŘetězecPovinnéNázev skladového umístění.
on_handCelé čísloPovinnéFyzické skladové množství.
Další pole: Ne
ApiResponse[CodeContentData]
ApiResponse_CodeContentData_ · Kód se vrací jako JSON, soubor jako binární data. Každý požadavek vyžaduje Bearer a oprávnění reveal.
dataCodeContentDataPovinnéObsah úspěšné odpovědi.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetadata odpovědi.
Další pole: Ne
ApiResponse[DigitalUploadData]
ApiResponse_DigitalUploadData_ · Zkontrolujte velikost, kontrolní součet a formát. Hotový upload ještě neznamená přijatou dodávku.
dataDigitalUploadDataPovinnéObsah úspěšné odpovědi.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetadata odpovědi.
Další pole: Ne
ApiResponse[ImportData]
ApiResponse_ImportData_ · Zkontrolujte stav, verzi a výsledek ověření. Koncept patří API klíči, který jej vytvořil.
dataImportDataPovinnéObsah úspěšné odpovědi.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetadata odpovědi.
Další pole: Ne
Vypsat · Zásoby — Zásoby — Odpověď
ApiResponse_list_StockData__ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataPole <StockData> PovinnéPříklad odpovědi · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetadata odpovědi.
Další pole: Ne
ApiResponse[PoolData]
ApiResponse_PoolData_ · Před změnou načtěte nastavení a počty. Odpověď neobsahuje kódy ani obsah souborů.
dataPoolDataPovinnéObsah úspěšné odpovědi.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetadata odpovědi.
Další pole: Ne
Načíst · Zásoby — Zásoby — Odpověď
ApiResponse_StockDetailData_ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataStockDetailDataPovinnéPříklad odpovědi · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetadata odpovědi.
Další pole: Ne
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Načtěte nejvýše 100 jednotek na stránku. Seznam obsahuje metadata bez odhalení kódů.
dataUnitsDataPovinnéObsah úspěšné odpovědi.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetadata odpovědi.
Další pole: Ne
CodeContentData
CodeContentData · Kód se vrací jako JSON, soubor jako binární data. Každý požadavek vyžaduje Bearer a oprávnění reveal.
codeŘetězecPovinnéPřesné znění digitálního kódu. Zachovejte velikost písmen a vnitřní mezery.
minLength:1maxLength:512delivery_idŘetězec nullVolitelnéID dodávky nebo přidělení objednávky.
Řetězec:format:"uuid"kindŘetězecVolitelnéVarianta datové struktury popsaná povolenými hodnotami.
const:"code"payload_idŘetězecPovinnéID obsahu; nejde o veřejný odkaz ke stažení.
format:"uuid"unit_idŘetězecPovinnéID jednoho individuálního kódu nebo souboru.
format:"uuid"
Další pole: Ne
DigitalUploadCreate
DigitalUploadCreate · Rezervujte prostor pro soubor a přiřaďte jej k importu nebo nahrazované jednotce.
consumer_idŘetězecPovinnéID souvisejícího importu nebo jednotky.
format:"uuid"consumer_kindŘetězecPovinnéPřiřazení uploadu: digital_import / digital_unit.
Omezení
enum["digital_import", "digital_unit"]
filenameŘetězecPovinnéSoubor
minLength:1maxLength:255purposeŘetězecPovinnédigital_import: TXT/CSV; digital_unit: jednotlivě prodávaný soubor.
Omezení
enum["digital_unit", "digital_import"]
sha256ŘetězecPovinnéSHA-256 (hex, 64)
Omezení
pattern"^[0-9a-f]{64}$"
size_bytesCelé čísloPovinnéVelikost v bajtech
minimum:1maximum:262144000
Další pole: Ne
DigitalUploadData
DigitalUploadData · Zkontrolujte velikost, kontrolní součet a formát. Hotový upload ještě neznamená přijatou dodávku.
consumer_idŘetězecPovinnéID souvisejícího importu nebo jednotky.
format:"uuid"consumer_kindŘetězecPovinnéPřiřazení uploadu: digital_import / digital_unit.
Omezení
enum["digital_import", "digital_unit"]
expires_atŘetězecPovinnéDoba vypršení tohoto nahrávání nebo importu.
format:"date-time"filenameŘetězecPovinnéSoubor
idŘetězecPovinnéIdentifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.
format:"uuid"product_idŘetězecPovinnéIdentifikátor produktu.
purposeŘetězecPovinnédigital_import: TXT/CSV; digital_unit: jednotlivě prodávaný soubor.
Omezení
enum["digital_unit", "digital_import"]
received_bytesCelé čísloPovinnéNahrávání… · Velikost v bajtech
sha256ŘetězecPovinnéSHA-256 (hex, 64)
size_bytesCelé čísloPovinnéVelikost v bajtech
statusŘetězecPovinnéStav přijímaný touto konkrétní operací.
Další pole: Ne
ImportCommit
ImportCommit · Z ověřené dávky vytvořte plánovanou nebo přijatou dodávku. Plánované jednotky zatím nelze prodávat.
delivered_atŘetězecPovinnéDatum a čas dodání.
format:"date-time"expected_delivery_versionCelé čísloPovinnéVerze dodávky; 0 pro novou dodávku.
minimum:0maximum:0expected_sales_limit_versionCelé číslo nullVolitelnéVerze prodejního limitu; nutná při publish_for_sale=true.
Celé číslo:minimum:0maximum:9223372036854775807expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1maximum:9223372036854775807location_idŘetězecPovinnéIdentifikátor skladového umístění.
Omezení
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleLogická hodnotaVolitelnétrue zvýší i konečný prodejní limit; false jej nezmění.
statusŘetězecPovinnéStav přijímaný touto konkrétní operací.
Omezení
enum["planned", "received"]
validation_digestŘetězecPovinnéKontrolní součet ověření; při potvrzení odešlete beze změny.
Omezení
pattern"^[0-9a-f]{64}$"
warehouse_idŘetězecPovinnéIdentifikátor skladu.
Omezení
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Další pole: Ne
ImportCreate
ImportCreate · Připravte koncept s nejvýše 1000 kódy nebo 100 soubory. Prodejná zásoba se zatím nezvýší.
countCelé čísloPovinnéPřesný počet jednotek v dávce.
minimum:1maximum:1000kindŘetězecPovinnéVarianta datové struktury popsaná povolenými hodnotami.
Omezení
enum["code", "file"]
Další pole: Ne
ImportData
ImportData · Zkontrolujte stav, verzi a výsledek ověření. Koncept patří API klíči, který jej vytvořil.
delivery_idŘetězec nullPovinnéID dodávky nebo přidělení objednávky.
delivery_statusŘetězec nullPovinnéStav dodávky: planned / received; před potvrzením null.
delivery_versionCelé číslo nullPovinnéAktuální verze skladové dodávky.
expected_countCelé čísloPovinnéOčekávaný počet; přijímá se pouze celá dávka.
expires_atŘetězecPovinnéDoba vypršení tohoto nahrávání nebo importu.
format:"date-time"idŘetězecPovinnéIdentifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.
format:"uuid"kindŘetězecPovinnéVarianta datové struktury popsaná povolenými hodnotami.
Omezení
enum["code", "file"]
product_idŘetězecPovinnéIdentifikátor produktu.
statusŘetězecPovinnéStav přijímaný touto konkrétní operací.
validated_countCelé čísloPovinnéPočet jednotek přijatých při posledním úspěšném ověření.
validation_digestŘetězec nullPovinnéKontrolní součet ověření; při potvrzení odešlete beze změny.
versionCelé čísloPovinnéVerze zdroje používaná k řízení souběžných změn.
Další pole: Ne
ImportReceive
ImportReceive · Přijměte existující jednotky bez dalšího importu kódů či souborů.
expected_delivery_versionCelé čísloPovinnéVerze dodávky; 0 pro novou dodávku.
minimum:1maximum:9223372036854775807expected_sales_limit_versionCelé číslo nullVolitelnéVerze prodejního limitu; nutná při publish_for_sale=true.
Celé číslo:minimum:0maximum:9223372036854775807expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1maximum:9223372036854775807publish_for_saleLogická hodnotaVolitelnétrue zvýší i konečný prodejní limit; false jej nezmění.
Další pole: Ne
ImportValidate
ImportValidate · Zkontrolujte celou dávku. Duplicita nebo neplatná položka odmítne dávku; kódy se nezkracují.
code_columnŘetězec nullVolitelnéSloupec CSV s kódy; použijte code.
Řetězec:const:"code"expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1maximum:9223372036854775807formatŘetězec nullVolitelnéSeznam kódů: txt / csv; pro soubory použijte upload_ids.
Omezení · Řetězec 1
enum["txt", "csv"]
source_upload_idŘetězec nullVolitelnéHotový soukromý TXT/CSV upload tohoto importu.
Řetězec:format:"uuid"upload_idsPole <Řetězec> nullVolitelné1–100 hotových soukromých uploadů souborů tohoto importu.
Pole:minItems:1maxItems:100Pole / Pole:format:"uuid"
Další pole: Ne
ImportWithdrawal
ImportWithdrawal · Odeberte pouze volné jednotky. Rezervované a přidělené jednotky zůstávají spojeny s objednávkami.
expected_delivery_versionCelé čísloPovinnéVerze dodávky; 0 pro novou dodávku.
minimum:1maximum:9223372036854775807expected_order_versionCelé čísloPovinnéVerze pořadí přidělování, nikoli zákaznické objednávky.
minimum:0maximum:9223372036854775807expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1maximum:9223372036854775807reasonŘetězecPovinnéDůvod zaznamenaný u změny.
minLength:1maxLength:500
Další pole: Ne
Upravit · Ruční rezervace — Zásoby — Tělo požadavku
ManualReservationUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.
expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1maximum:9223372036854775807manual_reservedCelé čísloPovinnéRučně rezervované množství.
minimum:0maximum:2147483647reasonŘetězecVolitelnéDůvod zaznamenaný u změny.
maxLength:500
Další pole: Ne
PoolChange
PoolChange · Zapněte jednotlivé kódy nebo soubory od plánu Professional. Vypnutí zachová přístup k dřívějším nákupům.
email_modeŘetězecVolitelnédisabled: bez e-mailu; order_link: odkaz na objednávku; code_text: případně také kódy.
Omezení
enum["disabled", "order_link", "code_text"]
enabledLogická hodnotaPovinnéZda je nastavení zapnuto.
expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:0maximum:9223372036854775807retention_daysCelé číslo nullVolitelnénull: bez omezení; 1–3650 dní od prvního přístupu. Kódy se automaticky nemažou.
Celé číslo:minimum:1maximum:3650
Další pole: Ne
PoolCounts
PoolCounts · Před změnou načtěte nastavení a počty. Odpověď neobsahuje kódy ani obsah souborů.
availableCelé čísloPovinnéPočet volných jednotek, které nejsou rezervované ani vydané.
heldCelé čísloPovinnéJednotky rezervované pro objednávky, dosud nevydané.
issuedCelé čísloPovinnéJednotky již vydané pro zaplacené nákupy.
plannedCelé čísloPovinnéJednotky potvrzených, dosud nepřijatých dodávek.
retiredCelé čísloPovinnéVyřazené jednotky zachované v historii.
stagedCelé čísloPovinnéJednotky nedokončených importů, dosud nejsou zásobou.
Další pole: Ne
PoolData
PoolData · Před změnou načtěte nastavení a počty. Odpověď neobsahuje kódy ani obsah souborů.
configuredLogická hodnotaPovinnéZda bylo uloženo nastavení digitální zásoby.
countsPoolCountsPovinnéPočty jednotek podle stavu zásoby.
email_modeŘetězecPovinnédisabled: bez e-mailu; order_link: odkaz na objednávku; code_text: případně také kódy.
Omezení
enum["disabled", "order_link", "code_text"]
enabledLogická hodnotaPovinnéZda je nastavení zapnuto.
order_versionCelé čísloPovinnéVerze pořadí přidělování v zásobě.
product_idŘetězecPovinnéIdentifikátor produktu.
retention_daysCelé číslo nullPovinnénull: bez omezení; 1–3650 dní od prvního přístupu. Kódy se automaticky nemažou.
versionCelé čísloPovinnéVerze zdroje používaná k řízení souběžných změn.
Další pole: Ne
Upravit · Prodejní limit — Zásoby — Tělo požadavku
SalesLimitUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.
expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1maximum:9223372036854775807reasonŘetězecVolitelnéDůvod zaznamenaný u změny.
maxLength:500sellable_limitCelé čísloPovinnéProdejní limit: -1 znamená neomezený prodej a 0 zakazuje dostupný prodej.
minimum:-1maximum:2147483647
Další pole: Ne
Vytvořit · Korekce zásob — Zásoby — Tělo požadavku
StockAdjustmentCreate · Pole, typy a omezení dat přijímaných nebo vracených API.
expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:0maximum:9223372036854775807locationsPole <LocationQuantity> PovinnéSkladová umístění.
minItems:1maxItems:100reasonŘetězecPovinnéDůvod zaznamenaný u změny.
minLength:1maxLength:500target_idŘetězecPovinnéIdentifikátor produktu nebo varianty, které se operace týká.
Omezení
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeŘetězecPovinnéZda se operace týká produktu, nebo varianty.
Omezení
enum["product", "variant"]
warehouse_idŘetězecPovinnéIdentifikátor skladu.
Omezení
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Další pole: Ne
Upravit · Zásoby — Zásoby — Tělo požadavku
StockAdjustmentUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.
expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1maximum:9223372036854775807locationsPole <LocationQuantity> PovinnéSkladová umístění.
minItems:1maxItems:100reasonŘetězecPovinnéDůvod zaznamenaný u změny.
minLength:1maxLength:500
Další pole: Ne
Vypsat · Zásoby — Zásoby — Odpověď
StockData · Pole, typy a omezení dat přijímaných nebo vracených API.
activeLogická hodnotaPovinnéZda je zdroj aktivní.
availableCelé číslo nullPovinnéMnožství dostupné k prodeji; null znamená neomezené množství.
idŘetězecPovinnéIdentifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (StockData).
manual_reservedCelé čísloPovinnéRučně rezervované množství.
on_handCelé čísloPovinnéFyzické skladové množství.
reservedCelé čísloPovinnéMnožství rezervované objednávkami.
sellable_limitCelé čísloPovinnéProdejní limit: -1 znamená neomezený prodej a 0 zakazuje dostupný prodej.
target_idŘetězecPovinnéIdentifikátor produktu nebo varianty, které se operace týká.
target_typeŘetězecPovinnéZda se operace týká produktu, nebo varianty.
Omezení
enum["product", "variant"]
total_reservedCelé čísloPovinnéCelkové rezervované množství.
updated_atŘetězecPovinnéČas poslední aktualizace.
format:"date-time"versionCelé čísloPovinnéVerze zdroje používaná k řízení souběžných změn.
warehouse_idŘetězecPovinnéIdentifikátor skladu.
Další pole: Ne
Načíst · Zásoby — Zásoby — Odpověď
StockDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.
activeLogická hodnotaPovinnéZda je zdroj aktivní.
allocationsPole <AllocationData> PovinnéMnožství přiřazená skladovým umístěním.
availableCelé číslo nullPovinnéMnožství dostupné k prodeji; null znamená neomezené množství.
idŘetězecPovinnéIdentifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (StockDetailData).
manual_reservedCelé čísloPovinnéRučně rezervované množství.
on_handCelé čísloPovinnéFyzické skladové množství.
reservedCelé čísloPovinnéMnožství rezervované objednávkami.
sellable_limitCelé čísloPovinnéProdejní limit: -1 znamená neomezený prodej a 0 zakazuje dostupný prodej.
target_idŘetězecPovinnéIdentifikátor produktu nebo varianty, které se operace týká.
target_typeŘetězecPovinnéZda se operace týká produktu, nebo varianty.
Omezení
enum["product", "variant"]
total_reservedCelé čísloPovinnéCelkové rezervované množství.
updated_atŘetězecPovinnéČas poslední aktualizace.
format:"date-time"versionCelé čísloPovinnéVerze zdroje používaná k řízení souběžných změn.
warehouse_idŘetězecPovinnéIdentifikátor skladu.
Další pole: Ne
UnitData
UnitData · Načtěte nejvýše 100 jednotek na stránku. Seznam obsahuje metadata bez odhalení kódů.
content_stateŘetězecPovinnéStav obsahu: present / deleting / deleted.
delivery_idŘetězec nullPovinnéID dodávky nebo přidělení objednávky.
filenameŘetězec nullPovinnéSoubor
idŘetězecPovinnéIdentifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.
format:"uuid"issued_atŘetězec nullPovinnéPrvní vydání; před ním null.
Řetězec:format:"date-time"kindŘetězecPovinnéVarianta datové struktury popsaná povolenými hodnotami.
Omezení
enum["file", "code"]
location_idŘetězec nullPovinnéIdentifikátor skladového umístění.
mime_typeŘetězec nullPovinnéTyp obsahu média.
payload_idŘetězecPovinnéID obsahu; nejde o veřejný odkaz ke stažení.
format:"uuid"product_idŘetězecPovinnéIdentifikátor produktu.
size_bytesCelé číslo nullPovinnéVelikost v bajtech
sort_orderCelé čísloPovinnéPozice v seřazeném seznamu.
stateŘetězecPovinnéStav
versionCelé čísloPovinnéVerze zdroje používaná k řízení souběžných změn.
warehouse_idŘetězec nullPovinnéIdentifikátor skladu.
Další pole: Ne
UnitDeletion
UnitDeletion · Odeberte neprodaný kód nebo soubor s uvedením důvodu. Rezervované či přidělené jednotky jsou odmítnuty.
expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1reasonŘetězecPovinnéDůvod zaznamenaný u změny.
minLength:1maxLength:500
Další pole: Ne
UnitReorder
UnitReorder · Odešlete celou nefiltrovanou stránku v požadovaném pořadí. Zastaralá verze vrátí 409.
expected_order_versionCelé čísloPovinnéVerze pořadí přidělování, nikoli zákaznické objednávky.
minimum:1unit_idsPole <Řetězec> PovinnéVšechny jednotky nefiltrované stránky v požadovaném pořadí.
minItems:2maxItems:100Pole:format:"uuid"window_cursorŘetězec nullVolitelnéKurzor nefiltrované stránky; null pro první stránku.
Řetězec:maxLength:1024
Další pole: Ne
UnitReplacement
UnitReplacement · Nahraďte kód nebo soubor beze změny pořadí. Změna zůstává v historii skladu.
codeŘetězec nullVolitelnéPřesné znění digitálního kódu. Zachovejte velikost písmen a vnitřní mezery.
Řetězec:minLength:1maxLength:512expected_versionCelé čísloPovinnéVerze načtená před zápisem; při neshodě se aktualizace odmítne.
minimum:1reasonŘetězecPovinnéDůvod zaznamenaný u změny.
minLength:1maxLength:500upload_idŘetězec nullVolitelnéIdentifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. · upload_id
Řetězec:format:"uuid"
Další pole: Ne
UnitsData
UnitsData · Načtěte nejvýše 100 jednotek na stránku. Seznam obsahuje metadata bez odhalení kódů.
order_versionCelé čísloPovinnéVerze pořadí přidělování v zásobě.
totalCelé čísloPovinnéCelková částka.
unitsPole <UnitData> PovinnéMetadata jednotek; obsah vyžaduje samostatný oprávněný požadavek.
Další pole: Ano