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

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

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

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

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