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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Ein Code wird als JSON ausgegeben, eine Datei als Datenstrom. Jede Anfrage benötigt Bearer und die Berechtigung reveal.

dataCodeContentData Erforderlich: Nutzdaten einer erfolgreichen Antwort.

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

Beispiel: {"request_id":"example-request"}

Zusätzliche Felder: Nein

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Prüfe, ob Größe, Prüfsumme und Format stimmen. Ein fertiger Upload bedeutet noch keinen Wareneingang.

dataDigitalUploadData Erforderlich: Nutzdaten einer erfolgreichen Antwort.

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

Beispiel: {"request_id":"example-request"}

Zusätzliche Felder: Nein

ApiResponse[ImportData]

ApiResponse_ImportData_ · Lies Status, Version und Prüfergebnis. Der Entwurf gehört dem API-Schlüssel, der ihn angelegt hat.

dataImportData Erforderlich: Nutzdaten einer erfolgreichen Antwort.

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

Beispiel: {"request_id":"example-request"}

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Lies Einstellungen und Bestände vor einer Änderung. Die Antwort enthält keine Codes oder Dateiinhalte.

dataPoolData Erforderlich: Nutzdaten einer erfolgreichen Antwort.

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

Beispiel: {"request_id":"example-request"}

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Lies höchstens 100 Einheiten pro Seite. Die Liste enthält Metadaten, aber keine geheimen Codes.

dataUnitsData Erforderlich: Nutzdaten einer erfolgreichen Antwort.

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

Beispiel: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Zusätzliche Felder: Nein

CodeContentData

CodeContentData · Ein Code wird als JSON ausgegeben, eine Datei als Datenstrom. Jede Anfrage benötigt Bearer und die Berechtigung reveal.

codeZeichenfolgeErforderlich: Der genaue digitale Code. Großschreibung und innere Leerzeichen beibehalten.

minLength: 1maxLength: 512

Beispiel: "DEMO-ONE"
delivery_idZeichenfolge nullOptional: ID der Lieferung oder Bestellzuteilung.

Zeichenfolge:format: "uuid"

Beispiel: null
kindZeichenfolgeOptional: Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

const: "code"

Standardwert: "code"Beispiel: "code"
payload_idZeichenfolgeErforderlich: ID des Inhalts; keine öffentliche Downloadadresse.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000004"
unit_idZeichenfolgeErforderlich: ID eines einzelnen Codes oder einer Datei.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000003"

Zusätzliche Felder: Nein

DigitalUploadCreate

DigitalUploadCreate · Reserviere Speicher für eine Datei und ordne sie einem Import oder einer zu ersetzenden Einheit zu.

consumer_idZeichenfolgeErforderlich

ID des zugehörigen Imports oder der Einheit.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000001"

consumer_kindZeichenfolgeErforderlich

Upload-Zuordnung: digital_import / digital_unit.

Einschränkungen

enum: ["digital_import", "digital_unit"]

Beispiel: "digital_import"

filenameZeichenfolgeErforderlich

Datei

minLength: 1maxLength: 255

Beispiel: "codes.txt"

purposeZeichenfolgeErforderlich

digital_import: TXT/CSV; digital_unit: einzeln verkaufte Datei.

Einschränkungen

enum: ["digital_unit", "digital_import"]

Beispiel: "digital_import"

sha256ZeichenfolgeErforderlich

SHA-256 (hex, 64)

Einschränkungen

pattern: "^[0-9a-f]{64}$"

Beispiel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesGanzzahlErforderlich

Größe in Bytes

minimum: 1maximum: 262144000

Beispiel: 18

Zusätzliche Felder: Nein

DigitalUploadData

DigitalUploadData · Prüfe, ob Größe, Prüfsumme und Format stimmen. Ein fertiger Upload bedeutet noch keinen Wareneingang.

consumer_idZeichenfolgeErforderlich

ID des zugehörigen Imports oder der Einheit.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000001"

consumer_kindZeichenfolgeErforderlich

Upload-Zuordnung: digital_import / digital_unit.

Einschränkungen

enum: ["digital_import", "digital_unit"]

Beispiel: "digital_import"

expires_atZeichenfolgeErforderlich

Ablaufzeit dieses Uploads oder Imports.

format: "date-time"

Beispiel: "2026-11-03T13:00:00Z"

filenameZeichenfolgeErforderlich

Datei

Beispiel: "codes.txt"

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000002"

product_idZeichenfolgeErforderlich

Produktkennung.

Beispiel: "example"

purposeZeichenfolgeErforderlich

digital_import: TXT/CSV; digital_unit: einzeln verkaufte Datei.

Einschränkungen

enum: ["digital_unit", "digital_import"]

Beispiel: "digital_import"

received_bytesGanzzahlErforderlich

Wird hochgeladen… · Größe in Bytes

Beispiel: 18

sha256ZeichenfolgeErforderlich

SHA-256 (hex, 64)

Beispiel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesGanzzahlErforderlich

Größe in Bytes

Beispiel: 18

statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Beispiel: "ready"

Zusätzliche Felder: Nein

ImportCommit

ImportCommit · Erzeuge aus der geprüften Charge eine geplante oder eingegangene Lieferung. Eine geplante Lieferung ist noch nicht verkaufbar.

delivered_atZeichenfolgeErforderlich

Datum und Uhrzeit der Lieferung.

format: "date-time"

Beispiel: "2026-11-03T12:00:00Z"

expected_delivery_versionGanzzahlErforderlich

Lieferungsversion; 0 bei neuer Lieferung.

minimum: 0maximum: 0

Beispiel: 0

expected_sales_limit_versionGanzzahl nullOptional

Version des Verkaufslimits; erforderlich bei publish_for_sale=true.

Ganzzahl:minimum: 0maximum: 9223372036854775807

Beispiel: 0

expected_versionGanzzahlErforderlich

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

minimum: 1maximum: 9223372036854775807

Beispiel: 2

location_idZeichenfolgeErforderlich

Kennung des Lagerorts.

Einschränkungen

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

Beispiel: "location-digital"

publish_for_saleBoolescher WertOptional

true erhöht auch das endliche Verkaufslimit; false lässt es unverändert.

Standardwert: falseBeispiel: true

statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Einschränkungen

enum: ["planned", "received"]

Beispiel: "received"

validation_digestZeichenfolgeErforderlich

Prüfsumme der Validierung; unverändert zur Bestätigung senden.

Einschränkungen

pattern: "^[0-9a-f]{64}$"

Beispiel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idZeichenfolgeErforderlich

Lagerkennung.

Einschränkungen

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

Beispiel: "warehouse-main"

Zusätzliche Felder: Nein

ImportCreate

ImportCreate · Lege einen Entwurf für höchstens 1000 Codes oder 100 Dateien an. Dadurch entsteht noch kein verkaufbarer Bestand.

countGanzzahlErforderlich

Genaue Anzahl der Einheiten dieser Charge.

minimum: 1maximum: 1000

Beispiel: 2

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["code", "file"]

Beispiel: "code"

Zusätzliche Felder: Nein

ImportData

ImportData · Lies Status, Version und Prüfergebnis. Der Entwurf gehört dem API-Schlüssel, der ihn angelegt hat.

delivery_idZeichenfolge nullErforderlich

ID der Lieferung oder Bestellzuteilung.

Beispiel: null

delivery_statusZeichenfolge nullErforderlich

Lieferstatus: planned / received; vorher null.

Beispiel: null

delivery_versionGanzzahl nullErforderlich

Aktuelle Version der Lagerlieferung.

Beispiel: null

expected_countGanzzahlErforderlich

Erwartete Anzahl; nur vollständige Chargen sind gültig.

Beispiel: 2

expires_atZeichenfolgeErforderlich

Ablaufzeit dieses Uploads oder Imports.

format: "date-time"

Beispiel: "2026-11-03T13:00:00Z"

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000001"

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["code", "file"]

Beispiel: "code"

product_idZeichenfolgeErforderlich

Produktkennung.

Beispiel: "example"

statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Beispiel: "validated"

validated_countGanzzahlErforderlich

Anzahl bei der letzten erfolgreichen Prüfung akzeptierter Einheiten.

Beispiel: 2

validation_digestZeichenfolge nullErforderlich

Prüfsumme der Validierung; unverändert zur Bestätigung senden.

Beispiel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 2

Zusätzliche Felder: Nein

ImportReceive

ImportReceive · Nimm die vorhandene Lieferung an, ohne ihre Codes oder Dateien erneut zu importieren.

expected_delivery_versionGanzzahlErforderlich: Lieferungsversion; 0 bei neuer Lieferung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1
expected_sales_limit_versionGanzzahl nullOptional: Version des Verkaufslimits; erforderlich bei publish_for_sale=true.

Ganzzahl:minimum: 0maximum: 9223372036854775807
expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 3
publish_for_saleBoolescher WertOptional: true erhöht auch das endliche Verkaufslimit; false lässt es unverändert.

Standardwert: false

Zusätzliche Felder: Nein

ImportValidate

ImportValidate · Prüfe die gesamte Charge. Duplikate oder ungültige Einträge lehnen die Charge ab; Codes werden nicht gekürzt.

code_columnZeichenfolge nullOptional

CSV-Spalte mit Codes; code verwenden.

Zeichenfolge:const: "code"

expected_versionGanzzahlErforderlich

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

minimum: 1maximum: 9223372036854775807

Beispiel: 1

formatZeichenfolge nullOptional

Codeliste: txt / csv; bei Dateien upload_ids verwenden.

Einschränkungen · Zeichenfolge 1

enum: ["txt", "csv"]

Beispiel: "txt"

source_upload_idZeichenfolge nullOptional

Fertiger privater TXT/CSV-Upload dieses Imports.

Zeichenfolge:format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000002"

upload_idsArray <Zeichenfolge> nullOptional

1–100 fertige private Datei-Uploads dieses Imports.

Array:minItems: 1maxItems: 100

Array / Array:format: "uuid"

Zusätzliche Felder: Nein

ImportWithdrawal

ImportWithdrawal · Ziehe nur freie Einheiten zurück. Reservierte und ausgegebene Einheiten bleiben ihren Bestellungen zugeordnet.

expected_delivery_versionGanzzahlErforderlich: Lieferungsversion; 0 bei neuer Lieferung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1
expected_order_versionGanzzahlErforderlich: Version der Zuteilungsreihenfolge, nicht der Kundenbestellung.

minimum: 0maximum: 9223372036854775807

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

minimum: 1maximum: 9223372036854775807

Beispiel: 3
reasonZeichenfolgeErforderlich: Für die Änderung gespeicherte Begründung.

minLength: 1maxLength: 500

Beispiel: "Withdraw a revoked license"

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

PoolChange

PoolChange · Aktiviere einzelne Codes oder Dateien ab Professional. Das Abschalten erhält den Zugriff auf frühere Käufe.

email_modeZeichenfolgeOptional

disabled: keine E-Mail; order_link: Bestelllink; code_text: zusätzlich Codes möglich.

Einschränkungen

enum: ["disabled", "order_link", "code_text"]

Standardwert: "disabled"Beispiel: "order_link"

enabledBoolescher WertErforderlich

Gibt an, ob diese Einstellung aktiviert ist.

Beispiel: true

expected_versionGanzzahlErforderlich

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

minimum: 0maximum: 9223372036854775807

Beispiel: 0

retention_daysGanzzahl nullOptional

null: unbegrenzt; 1–3650 Tage ab erstem Zugriff. Keine automatische Codelöschung.

Ganzzahl:minimum: 1maximum: 3650

Beispiel: null

Zusätzliche Felder: Nein

PoolCounts

PoolCounts · Lies Einstellungen und Bestände vor einer Änderung. Die Antwort enthält keine Codes oder Dateiinhalte.

availableGanzzahlErforderlich: Anzahl freier Einheiten, die weder reserviert noch ausgegeben sind.

Beispiel: 1
heldGanzzahlErforderlich: Für Bestellungen reserviert, noch nicht ausgegeben.

Beispiel: 0
issuedGanzzahlErforderlich: Bereits an bezahlte Käufe ausgegebene Einheiten.

Beispiel: 1
plannedGanzzahlErforderlich: Einheiten bestätigter, noch nicht eingegangener Lieferungen.

Beispiel: 0
retiredGanzzahlErforderlich: Zurückgezogene Einheiten in der Historie.

Beispiel: 0
stagedGanzzahlErforderlich: Einheiten unfertiger Importe, noch kein Bestand.

Beispiel: 0

Zusätzliche Felder: Nein

PoolData

PoolData · Lies Einstellungen und Bestände vor einer Änderung. Die Antwort enthält keine Codes oder Dateiinhalte.

configuredBoolescher WertErforderlich

Ob Pool-Einstellungen gespeichert wurden.

Beispiel: true

countsPoolCounts Erforderlich

Anzahl der Einheiten je Bestandsstatus.

Beispiel: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeZeichenfolgeErforderlich

disabled: keine E-Mail; order_link: Bestelllink; code_text: zusätzlich Codes möglich.

Einschränkungen

enum: ["disabled", "order_link", "code_text"]

Beispiel: "order_link"

enabledBoolescher WertErforderlich

Gibt an, ob diese Einstellung aktiviert ist.

Beispiel: true

order_versionGanzzahlErforderlich

Version der Zuteilungsreihenfolge im Pool.

Beispiel: 2

product_idZeichenfolgeErforderlich

Produktkennung.

Beispiel: "example"

retention_daysGanzzahl nullErforderlich

null: unbegrenzt; 1–3650 Tage ab erstem Zugriff. Keine automatische Codelöschung.

Beispiel: null

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

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

UnitData

UnitData · Lies höchstens 100 Einheiten pro Seite. Die Liste enthält Metadaten, aber keine geheimen Codes.

content_stateZeichenfolgeErforderlich

Inhaltsstatus: present / deleting / deleted.

Beispiel: "present"

delivery_idZeichenfolge nullErforderlich

ID der Lieferung oder Bestellzuteilung.

Beispiel: "delivery-example"

filenameZeichenfolge nullErforderlich

Datei

Beispiel: null

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000003"

issued_atZeichenfolge nullErforderlich

Erste Ausgabe; vorher null.

Zeichenfolge:format: "date-time"

Beispiel: null

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["file", "code"]

Beispiel: "code"

location_idZeichenfolge nullErforderlich

Kennung des Lagerorts.

Beispiel: "location-digital"

mime_typeZeichenfolge nullErforderlich

Inhaltstyp des Mediums.

Beispiel: null

payload_idZeichenfolgeErforderlich

ID des Inhalts; keine öffentliche Downloadadresse.

format: "uuid"

Beispiel: "00000000-0000-4000-8000-000000000004"

product_idZeichenfolgeErforderlich

Produktkennung.

Beispiel: "example"

size_bytesGanzzahl nullErforderlich

Größe in Bytes

Beispiel: null

sort_orderGanzzahlErforderlich

Position in der geordneten Sammlung.

Beispiel: 1

stateZeichenfolgeErforderlich

Status

Beispiel: "available"

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

warehouse_idZeichenfolge nullErforderlich

Lagerkennung.

Beispiel: "warehouse-main"

Zusätzliche Felder: Nein

UnitDeletion

UnitDeletion · Entferne einen unverkauften Code oder eine Datei mit Begründung. Reservierte oder ausgegebene Einheiten sind ausgeschlossen.

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

minimum: 1

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

minLength: 1maxLength: 500

Beispiel: "Withdraw a revoked license"

Zusätzliche Felder: Nein

UnitReorder

UnitReorder · Sende die vollständige ungefilterte Seite in der gewünschten Reihenfolge. Veraltete Versionen liefern 409.

expected_order_versionGanzzahlErforderlich: Version der Zuteilungsreihenfolge, nicht der Kundenbestellung.

minimum: 1

Beispiel: 1
unit_idsArray <Zeichenfolge> Erforderlich: Alle Einheiten der ungefilterten Seite in gewünschter Reihenfolge.

minItems: 2maxItems: 100
Array:format: "uuid"

Beispiel: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorZeichenfolge nullOptional: Cursor der ungefilterten Seite; null für die erste Seite.

Zeichenfolge:maxLength: 1024

Zusätzliche Felder: Nein

UnitReplacement

UnitReplacement · Ersetze Code oder Datei ohne Änderung der Reihenfolge. Die Lagerhistorie hält die Änderung fest.

codeZeichenfolge nullOptional: Der genaue digitale Code. Großschreibung und innere Leerzeichen beibehalten.

Zeichenfolge:minLength: 1maxLength: 512

Beispiel: "SYNTHETIC-REPLACEMENT"
expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1

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

minLength: 1maxLength: 500

Beispiel: "Replace an invalid activation code"
upload_idZeichenfolge nullOptional: Ressourcenkennung; unverändert aus der Antwort übernehmen. · upload_id

Zeichenfolge:format: "uuid"

Zusätzliche Felder: Nein

UnitsData

UnitsData · Lies höchstens 100 Einheiten pro Seite. Die Liste enthält Metadaten, aber keine geheimen Codes.

order_versionGanzzahlErforderlich: Version der Zuteilungsreihenfolge im Pool.

Beispiel: 2
totalGanzzahlErforderlich: Gesamtbetrag.

Beispiel: 1
unitsArray <UnitData > Erforderlich: Einheiten-Metadaten; Inhalte erfordern eine eigene berechtigte Anfrage.

Beispiel: [{"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"}]

Zusätzliche Felder: Ja