Přejít na obsah
ShopentlyLearn

Datová schémata: Zásoby

Datová schémata: Zásoby. Pole, typy a omezení dat přijímaných nebo vracených API.

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í.

Příklad: "example"
location_idŘetězecPovinné

Identifikátor skladového umístění.

Příklad: "example"
location_nameŘetězecPovinné

Název skladového umístění.

Příklad: "example"
on_handCelé čísloPovinné

Fyzické skladové množství.

Příklad: 10

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.
dataCodeContentData Povinné

Obsah úspěšné odpovědi.

Pří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é

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

Další pole: Ne

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Zkontrolujte velikost, kontrolní součet a formát. Hotový upload ještě neznamená přijatou dodávku.
dataDigitalUploadData Povinné

Obsah úspěšné odpovědi.

Pří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é

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

Další pole: Ne

ApiResponse[ImportData]

ApiResponse_ImportData_ · Zkontrolujte stav, verzi a výsledek ověření. Koncept patří API klíči, který jej vytvořil.
dataImportData Povinné

Obsah úspěšné odpovědi.

Pří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é

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

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__.

Pří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é

Metadata odpovědi.

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

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ů.
dataPoolData Povinné

Obsah úspěšné odpovědi.

Pří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é

Metadata odpovědi.

Příklad: {"request_id":"example-request"}

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.
dataStockDetailData Povinné

Příklad odpovědi · StockDetailData.

Pří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é

Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Načtěte nejvýše 100 jednotek na stránku. Seznam obsahuje metadata bez odhalení kódů.
dataUnitsData Povinné

Obsah úspěšné odpovědi.

Pří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é

Metadata odpovědi.

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

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: 512
Příklad: "DEMO-ONE"
delivery_idŘetězec nullVolitelné

ID dodávky nebo přidělení objednávky.

Řetězec:format: "uuid"
Příklad: null
kindŘetězecVolitelné

Varianta datové struktury popsaná povolenými hodnotami.

const: "code"
Výchozí hodnota: "code"Příklad: "code"
payload_idŘetězecPovinné

ID obsahu; nejde o veřejný odkaz ke stažení.

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000004"
unit_idŘetězecPovinné

ID jednoho individuálního kódu nebo souboru.

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

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"
Příklad: "00000000-0000-4000-8000-000000000001"
consumer_kindŘetězecPovinné

Přiřazení uploadu: digital_import / digital_unit.

Omezení
enum
["digital_import", "digital_unit"]
Příklad: "digital_import"
filenameŘetězecPovinné

Soubor

minLength: 1maxLength: 255
Příklad: "codes.txt"
purposeŘetězecPovinné

digital_import: TXT/CSV; digital_unit: jednotlivě prodávaný soubor.

Omezení
enum
["digital_unit", "digital_import"]
Příklad: "digital_import"
sha256ŘetězecPovinné

SHA-256 (hex, 64)

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

Velikost v bajtech

minimum: 1maximum: 262144000
Příklad: 18

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"
Příklad: "00000000-0000-4000-8000-000000000001"
consumer_kindŘetězecPovinné

Přiřazení uploadu: digital_import / digital_unit.

Omezení
enum
["digital_import", "digital_unit"]
Příklad: "digital_import"
expires_atŘetězecPovinné

Doba vypršení tohoto nahrávání nebo importu.

format: "date-time"
Příklad: "2026-11-03T13:00:00Z"
filenameŘetězecPovinné

Soubor

Příklad: "codes.txt"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000002"
product_idŘetězecPovinné

Identifikátor produktu.

Příklad: "example"
purposeŘetězecPovinné

digital_import: TXT/CSV; digital_unit: jednotlivě prodávaný soubor.

Omezení
enum
["digital_unit", "digital_import"]
Příklad: "digital_import"
received_bytesCelé čísloPovinné

Nahrávání… · Velikost v bajtech

Příklad: 18
sha256ŘetězecPovinné

SHA-256 (hex, 64)

Příklad: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesCelé čísloPovinné

Velikost v bajtech

Příklad: 18
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Příklad: "ready"

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"
Příklad: "2026-11-03T12:00:00Z"
expected_delivery_versionCelé čísloPovinné

Verze dodávky; 0 pro novou dodávku.

minimum: 0maximum: 0
Příklad: 0
expected_sales_limit_versionCelé číslo nullVolitelné

Verze prodejního limitu; nutná při publish_for_sale=true.

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

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807
Příklad: 2
location_idŘetězecPovinné

Identifikátor skladového umístění.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "location-digital"
publish_for_saleLogická hodnotaVolitelné

true zvýší i konečný prodejní limit; false jej nezmění.

Výchozí hodnota: falsePříklad: true
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení
enum
["planned", "received"]
Příklad: "received"
validation_digestŘetězecPovinné

Kontrolní součet ověření; při potvrzení odešlete beze změny.

Omezení
pattern
"^[0-9a-f]{64}$"
Příklad: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idŘetězecPovinné

Identifikátor skladu.

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

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: 1000
Příklad: 2
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["code", "file"]
Příklad: "code"

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.

Příklad: null
delivery_statusŘetězec nullPovinné

Stav dodávky: planned / received; před potvrzením null.

Příklad: null
delivery_versionCelé číslo nullPovinné

Aktuální verze skladové dodávky.

Příklad: null
expected_countCelé čísloPovinné

Očekávaný počet; přijímá se pouze celá dávka.

Příklad: 2
expires_atŘetězecPovinné

Doba vypršení tohoto nahrávání nebo importu.

format: "date-time"
Příklad: "2026-11-03T13:00:00Z"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000001"
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["code", "file"]
Příklad: "code"
product_idŘetězecPovinné

Identifikátor produktu.

Příklad: "example"
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Příklad: "validated"
validated_countCelé čísloPovinné

Počet jednotek přijatých při posledním úspěšném ověření.

Příklad: 2
validation_digestŘetězec nullPovinné

Kontrolní součet ověření; při potvrzení odešlete beze změny.

Příklad: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 2

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: 9223372036854775807
Příklad: 1
expected_sales_limit_versionCelé číslo nullVolitelné

Verze prodejního limitu; nutná při publish_for_sale=true.

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

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807
Příklad: 3
publish_for_saleLogická hodnotaVolitelné

true zvýší i konečný prodejní limit; false jej nezmění.

Výchozí hodnota: false

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: 9223372036854775807
Příklad: 1
formatŘetězec nullVolitelné

Seznam kódů: txt / csv; pro soubory použijte upload_ids.

Omezení · Řetězec 1
enum
["txt", "csv"]
Příklad: "txt"
source_upload_idŘetězec nullVolitelné

Hotový soukromý TXT/CSV upload tohoto importu.

Řetězec:format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000002"
upload_idsPole <Řetězec> nullVolitelné

1–100 hotových soukromých uploadů souborů tohoto importu.

Pole:minItems: 1maxItems: 100
Pole / 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: 9223372036854775807
Příklad: 1
expected_order_versionCelé čísloPovinné

Verze pořadí přidělování, nikoli zákaznické objednávky.

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

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807
Příklad: 3
reasonŘetězecPovinné

Důvod zaznamenaný u změny.

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

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: 9223372036854775807
Příklad: 1
manual_reservedCelé čísloPovinné

Ručně rezervované množství.

minimum: 0maximum: 2147483647
Příklad: 1
reasonŘetězecVolitelné

Důvod zaznamenaný u změny.

maxLength: 500
Výchozí hodnota: ""

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"]
Výchozí hodnota: "disabled"Příklad: "order_link"
enabledLogická hodnotaPovinné

Zda je nastavení zapnuto.

Příklad: true
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 0maximum: 9223372036854775807
Příklad: 0
retention_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
Příklad: null

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é.

Příklad: 1
heldCelé čísloPovinné

Jednotky rezervované pro objednávky, dosud nevydané.

Příklad: 0
issuedCelé čísloPovinné

Jednotky již vydané pro zaplacené nákupy.

Příklad: 1
plannedCelé čísloPovinné

Jednotky potvrzených, dosud nepřijatých dodávek.

Příklad: 0
retiredCelé čísloPovinné

Vyřazené jednotky zachované v historii.

Příklad: 0
stagedCelé čísloPovinné

Jednotky nedokončených importů, dosud nejsou zásobou.

Příklad: 0

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.

Příklad: true
countsPoolCounts Povinné

Počty jednotek podle stavu zásoby.

Příklad: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
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"]
Příklad: "order_link"
enabledLogická hodnotaPovinné

Zda je nastavení zapnuto.

Příklad: true
order_versionCelé čísloPovinné

Verze pořadí přidělování v zásobě.

Příklad: 2
product_idŘetězecPovinné

Identifikátor produktu.

Příklad: "example"
retention_daysCelé číslo nullPovinné

null: bez omezení; 1–3650 dní od prvního přístupu. Kódy se automaticky nemažou.

Příklad: null
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

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: 9223372036854775807
Příklad: 1
reasonŘetězecVolitelné

Důvod zaznamenaný u změny.

maxLength: 500
Výchozí hodnota: ""
sellable_limitCelé čísloPovinné

Prodejní limit: -1 znamená neomezený prodej a 0 zakazuje dostupný prodej.

minimum: -1maximum: 2147483647
Příklad: 1

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: 9223372036854775807
Příklad: 0
locationsPole <LocationQuantity > Povinné

Skladová umístění.

minItems: 1maxItems: 100
Příklad: [{"location_id":"example","on_hand":1}]
reasonŘetězecPovinné

Důvod zaznamenaný u změny.

minLength: 1maxLength: 500
Příklad: "Example"
target_idŘetězecPovinné

Identifikátor produktu nebo varianty, které se operace týká.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"
target_typeŘetězecPovinné

Zda se operace týká produktu, nebo varianty.

Omezení
enum
["product", "variant"]
Příklad: "product"
warehouse_idŘetězecPovinné

Identifikátor skladu.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"

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: 9223372036854775807
Příklad: 1
locationsPole <LocationQuantity > Povinné

Skladová umístění.

minItems: 1maxItems: 100
Příklad: [{"location_id":"example","on_hand":1}]
reasonŘetězecPovinné

Důvod zaznamenaný u změny.

minLength: 1maxLength: 500
Příklad: "Example"

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í.

Příklad: true
availableCelé číslo nullPovinné

Množství dostupné k prodeji; null znamená neomezené množství.

Příklad: 5
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (StockData).

Příklad: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedCelé čísloPovinné

Ručně rezervované množství.

Příklad: 2
on_handCelé čísloPovinné

Fyzické skladové množství.

Příklad: 10
reservedCelé čísloPovinné

Množství rezervované objednávkami.

Příklad: 3
sellable_limitCelé čísloPovinné

Prodejní limit: -1 znamená neomezený prodej a 0 zakazuje dostupný prodej.

Příklad: 10
target_idŘetězecPovinné

Identifikátor produktu nebo varianty, které se operace týká.

Příklad: "example"
target_typeŘetězecPovinné

Zda se operace týká produktu, nebo varianty.

Omezení
enum
["product", "variant"]
Příklad: "product"
total_reservedCelé čísloPovinné

Celkové rezervované množství.

Příklad: 5
updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1
warehouse_idŘetězecPovinné

Identifikátor skladu.

Příklad: "example"

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í.

Příklad: true
allocationsPole <AllocationData > Povinné

Množství přiřazená skladovým umístěním.

Příklad: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]
availableCelé číslo nullPovinné

Množství dostupné k prodeji; null znamená neomezené množství.

Příklad: 5
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (StockDetailData).

Příklad: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedCelé čísloPovinné

Ručně rezervované množství.

Příklad: 2
on_handCelé čísloPovinné

Fyzické skladové množství.

Příklad: 10
reservedCelé čísloPovinné

Množství rezervované objednávkami.

Příklad: 3
sellable_limitCelé čísloPovinné

Prodejní limit: -1 znamená neomezený prodej a 0 zakazuje dostupný prodej.

Příklad: 10
target_idŘetězecPovinné

Identifikátor produktu nebo varianty, které se operace týká.

Příklad: "example"
target_typeŘetězecPovinné

Zda se operace týká produktu, nebo varianty.

Omezení
enum
["product", "variant"]
Příklad: "product"
total_reservedCelé čísloPovinné

Celkové rezervované množství.

Příklad: 5
updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1
warehouse_idŘetězecPovinné

Identifikátor skladu.

Příklad: "example"

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.

Příklad: "present"
delivery_idŘetězec nullPovinné

ID dodávky nebo přidělení objednávky.

Příklad: "delivery-example"
filenameŘetězec nullPovinné

Soubor

Příklad: null
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000003"
issued_atŘetězec nullPovinné

První vydání; před ním null.

Řetězec:format: "date-time"
Příklad: null
kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení
enum
["file", "code"]
Příklad: "code"
location_idŘetězec nullPovinné

Identifikátor skladového umístění.

Příklad: "location-digital"
mime_typeŘetězec nullPovinné

Typ obsahu média.

Příklad: null
payload_idŘetězecPovinné

ID obsahu; nejde o veřejný odkaz ke stažení.

format: "uuid"
Příklad: "00000000-0000-4000-8000-000000000004"
product_idŘetězecPovinné

Identifikátor produktu.

Příklad: "example"
size_bytesCelé číslo nullPovinné

Velikost v bajtech

Příklad: null
sort_orderCelé čísloPovinné

Pozice v seřazeném seznamu.

Příklad: 1
stateŘetězecPovinné

Stav

Příklad: "available"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1
warehouse_idŘetězec nullPovinné

Identifikátor skladu.

Příklad: "warehouse-main"

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: 1
Příklad: 1
reasonŘetězecPovinné

Důvod zaznamenaný u změny.

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

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: 1
Příklad: 1
unit_idsPole <Řetězec> Povinné

Všechny jednotky nefiltrované stránky v požadovaném pořadí.

minItems: 2maxItems: 100
Pole:format: "uuid"
Příklad: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
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: 512
Příklad: "SYNTHETIC-REPLACEMENT"
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1
Příklad: 1
reasonŘetězecPovinné

Důvod zaznamenaný u změny.

minLength: 1maxLength: 500
Příklad: "Replace an invalid activation code"
upload_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ě.

Příklad: 2
totalCelé čísloPovinné

Celková částka.

Příklad: 1
unitsPole <UnitData > Povinné

Metadata jednotek; obsah vyžaduje samostatný oprávněný požadavek.

Pří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"}]

Další pole: Ano