Datenschemas: Lagerbestände

Datenschemas: Lagerbestände. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

Den Lagerorten zugewiesene Mengen

AllocationData · Schema · Datenschemas: Lagerbestände

location_codeZeichenfolgeErforderlich: Code des Lagerorts.

Beispiel: "example"
location_idZeichenfolgeErforderlich: Kennung des Lagerorts.

Beispiel: "example"
location_nameZeichenfolgeErforderlich: Name des Lagerorts.

Beispiel: "example"
on_handGanzzahlErforderlich: Physischer Lagerbestand.

Beispiel: 10

Zusätzliche Felder: Nein

Auflisten · Bestände — Lagerbestände — Antwort

ApiResponse_list_StockData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <StockData > Erforderlich: Beispielantwort · ApiResponse_list_StockData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

Beispiel: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Zusätzliche Felder: Nein

Abrufen · Bestände — Lagerbestände — Antwort

ApiResponse_StockDetailData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataStockDetailData Erforderlich: Beispielantwort · StockDetailData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

Beispiel: {"request_id":"example"}

Zusätzliche Felder: Nein

Aktualisieren · Manuelle Reservierung — Lagerbestände — Anfrageinhalt

ManualReservationUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1
manual_reservedGanzzahlErforderlich: Manuell reservierte Menge.

minimum: 0maximum: 2147483647

Beispiel: 1
reasonZeichenfolgeOptional: Für die Änderung gespeicherte Begründung.

maxLength: 500

Standardwert: ""

Zusätzliche Felder: Nein

Aktualisieren · Verkaufslimit — Lagerbestände — Anfrageinhalt

SalesLimitUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1
reasonZeichenfolgeOptional: Für die Änderung gespeicherte Begründung.

maxLength: 500

Standardwert: ""
sellable_limitGanzzahlErforderlich: Verkaufslimit: -1 bedeutet unbegrenzt, 0 verhindert verfügbare Verkäufe.

minimum: -1maximum: 2147483647

Beispiel: 1

Zusätzliche Felder: Nein

Erstellen · Bestandskorrektur — Lagerbestände — Anfrageinhalt

StockAdjustmentCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 0maximum: 9223372036854775807

Beispiel: 0

locationsArray <LocationQuantity > Erforderlich

Lagerorte.

minItems: 1maxItems: 100

Beispiel: [{"location_id":"example","on_hand":1}]

reasonZeichenfolgeErforderlich

Für die Änderung gespeicherte Begründung.

minLength: 1maxLength: 500

Beispiel: "Example"

target_idZeichenfolgeErforderlich

Kennung des von der Operation betroffenen Produkts oder der Variante.

Einschränkungen

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Beispiel: "example"

target_typeZeichenfolgeErforderlich

Gibt an, ob die Operation ein Produkt oder eine Variante betrifft.

Einschränkungen

enum: ["product", "variant"]

Beispiel: "product"

warehouse_idZeichenfolgeErforderlich

Lagerkennung.

Einschränkungen

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Beispiel: "example"

Zusätzliche Felder: Nein

Aktualisieren · Bestände — Lagerbestände — Anfrageinhalt

StockAdjustmentUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1
locationsArray <LocationQuantity > Erforderlich: Lagerorte.

minItems: 1maxItems: 100

Beispiel: [{"location_id":"example","on_hand":1}]
reasonZeichenfolgeErforderlich: Für die Änderung gespeicherte Begründung.

minLength: 1maxLength: 500

Beispiel: "Example"

Zusätzliche Felder: Nein

Auflisten · Bestände — Lagerbestände — Antwort

StockData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

activeBoolescher WertErforderlich

Gibt an, ob die Ressource aktiv ist.

Beispiel: true

availableGanzzahl nullErforderlich

Verkaufsfähige Menge; null bedeutet unbegrenzt.

Beispiel: 5

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (StockData).

Beispiel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedGanzzahlErforderlich

Manuell reservierte Menge.

Beispiel: 2

on_handGanzzahlErforderlich

Physischer Lagerbestand.

Beispiel: 10

reservedGanzzahlErforderlich

Durch Bestellungen reservierte Menge.

Beispiel: 3

sellable_limitGanzzahlErforderlich

Verkaufslimit: -1 bedeutet unbegrenzt, 0 verhindert verfügbare Verkäufe.

Beispiel: 10

target_idZeichenfolgeErforderlich

Kennung des von der Operation betroffenen Produkts oder der Variante.

Beispiel: "example"

target_typeZeichenfolgeErforderlich

Gibt an, ob die Operation ein Produkt oder eine Variante betrifft.

Einschränkungen

enum: ["product", "variant"]

Beispiel: "product"

total_reservedGanzzahlErforderlich

Insgesamt reservierte Menge.

Beispiel: 5

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

warehouse_idZeichenfolgeErforderlich

Lagerkennung.

Beispiel: "example"

Zusätzliche Felder: Nein

Abrufen · Bestände — Lagerbestände — Antwort

StockDetailData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

activeBoolescher WertErforderlich

Gibt an, ob die Ressource aktiv ist.

Beispiel: true

allocationsArray <AllocationData > Erforderlich

Den Lagerorten zugewiesene Mengen.

Beispiel: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableGanzzahl nullErforderlich

Verkaufsfähige Menge; null bedeutet unbegrenzt.

Beispiel: 5

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (StockDetailData).

Beispiel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedGanzzahlErforderlich

Manuell reservierte Menge.

Beispiel: 2

on_handGanzzahlErforderlich

Physischer Lagerbestand.

Beispiel: 10

reservedGanzzahlErforderlich

Durch Bestellungen reservierte Menge.

Beispiel: 3

sellable_limitGanzzahlErforderlich

Verkaufslimit: -1 bedeutet unbegrenzt, 0 verhindert verfügbare Verkäufe.

Beispiel: 10

target_idZeichenfolgeErforderlich

Kennung des von der Operation betroffenen Produkts oder der Variante.

Beispiel: "example"

target_typeZeichenfolgeErforderlich

Gibt an, ob die Operation ein Produkt oder eine Variante betrifft.

Einschränkungen

enum: ["product", "variant"]

Beispiel: "product"

total_reservedGanzzahlErforderlich

Insgesamt reservierte Menge.

Beispiel: 5

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

warehouse_idZeichenfolgeErforderlich

Lagerkennung.

Beispiel: "example"

Zusätzliche Felder: Nein