Datenschemas: Lieferungen

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

Datenschemas

Abrufen — Lieferungen — Antwort

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

dataDeliveryDetailData Erforderlich: Beispielantwort · DeliveryDetailData.

Beispiel: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Auflisten — Lieferungen — Antwort

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

dataArray <DeliveryData > Erforderlich: Beispielantwort · ApiResponse_list_DeliveryData__.

Beispiel: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Erstellen — Lieferungen — Anfrageinhalt

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

delivered_atZeichenfolgeErforderlich

Datum und Uhrzeit der Lieferung.

format: "date-time"

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

increases_stockBoolescher WertOptional

Gibt an, ob der Empfang der Lieferung den Bestand erhöht.

Standardwert: true

location_idZeichenfolgeErforderlich

Kennung des Lagerorts.

Einschränkungen

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

Beispiel: "example"

notesZeichenfolgeOptional

Zusätzliche Anmerkungen.

maxLength: 2000

Standardwert: ""

quantityGanzzahlErforderlich

Anzahl der Einheiten.

minimum: 1maximum: 2147483647

Beispiel: 1

reasonZeichenfolgeOptional

Für die Änderung gespeicherte Begründung.

maxLength: 500

Standardwert: ""

statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Einschränkungen

enum: ["planned", "received"]

Beispiel: "planned"

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

Auflisten — Lieferungen — Antwort

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

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

deleted_atZeichenfolge nullErforderlich

Zeitpunkt der Löschung, sofern vorhanden.

Zeichenfolge:format: "date-time"

Beispiel: null

delivered_atZeichenfolgeErforderlich

Datum und Uhrzeit der Lieferung.

format: "date-time"

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

idZeichenfolgeErforderlich

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

Beispiel: "example"

increases_stockBoolescher WertErforderlich

Gibt an, ob der Empfang der Lieferung den Bestand erhöht.

Beispiel: true

location_idZeichenfolgeErforderlich

Kennung des Lagerorts.

Beispiel: "example"

quantityGanzzahlErforderlich

Anzahl der Einheiten.

Beispiel: 1

received_atZeichenfolge nullErforderlich

Datum und Uhrzeit des Wareneingangs.

Zeichenfolge:format: "date-time"

Beispiel: null

record_statusZeichenfolgeErforderlich

Gespeicherter Datensatzstatus.

Einschränkungen

enum: ["active", "deleted"]

Beispiel: "active"

statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Einschränkungen

enum: ["planned", "received"]

Beispiel: "planned"

stock_applied_atZeichenfolge nullErforderlich

Zeitpunkt der durch die Lieferung bewirkten Bestandsänderung.

Zeichenfolge:format: "date-time"

Beispiel: null

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"

updated_atZeichenfolge nullErforderlich

Zeitpunkt der letzten Änderung.

Zeichenfolge: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 — Lieferungen — Antwort

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

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

deleted_atZeichenfolge nullErforderlich

Zeitpunkt der Löschung, sofern vorhanden.

Zeichenfolge:format: "date-time"

Beispiel: null

delivered_atZeichenfolgeErforderlich

Datum und Uhrzeit der Lieferung.

format: "date-time"

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

idZeichenfolgeErforderlich

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

Beispiel: "example"

increases_stockBoolescher WertErforderlich

Gibt an, ob der Empfang der Lieferung den Bestand erhöht.

Beispiel: true

location_idZeichenfolgeErforderlich

Kennung des Lagerorts.

Beispiel: "example"

notesZeichenfolge nullErforderlich

Zusätzliche Anmerkungen.

Beispiel: "example"

quantityGanzzahlErforderlich

Anzahl der Einheiten.

Beispiel: 1

received_atZeichenfolge nullErforderlich

Datum und Uhrzeit des Wareneingangs.

Zeichenfolge:format: "date-time"

Beispiel: null

record_statusZeichenfolgeErforderlich

Gespeicherter Datensatzstatus.

Einschränkungen

enum: ["active", "deleted"]

Beispiel: "active"

statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Einschränkungen

enum: ["planned", "received"]

Beispiel: "planned"

stock_applied_atZeichenfolge nullErforderlich

Zeitpunkt der durch die Lieferung bewirkten Bestandsänderung.

Zeichenfolge:format: "date-time"

Beispiel: null

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"

updated_atZeichenfolge nullErforderlich

Zeitpunkt der letzten Änderung.

Zeichenfolge: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