Gegevensschema’s: Leveringen

Gegevensschema’s: Leveringen. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Ophalen — Leveringen — Antwoord

ApiResponse_DeliveryDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataDeliveryDetailData Verplicht: Voorbeeldantwoord · DeliveryDetailData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

Lijst ophalen — Leveringen — Antwoord

ApiResponse_list_DeliveryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <DeliveryData > Verplicht: Voorbeeldantwoord · ApiResponse_list_DeliveryData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Aanmaken — Leveringen — Verzoekinhoud

DeliveryCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

delivered_atTekenreeksVerplicht

Leveringsdatum en -tijd.

format: "date-time"

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

increases_stockBooleaanse waardeOptioneel

Of ontvangst van de levering de voorraad verhoogt.

Standaard: true

location_idTekenreeksVerplicht

Identificatie van de magazijnlocatie.

Beperkingen

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

Voorbeeld: "example"

notesTekenreeksOptioneel

Aanvullende opmerkingen.

maxLength: 2000

Standaard: ""

quantityGeheel getalVerplicht

Aantal eenheden.

minimum: 1maximum: 2147483647

Voorbeeld: 1

reasonTekenreeksOptioneel

Vastgelegde reden voor de wijziging.

maxLength: 500

Standaard: ""

statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Beperkingen

enum: ["planned", "received"]

Voorbeeld: "planned"

target_idTekenreeksVerplicht

Identificatie van het product of de variant waarop de bewerking betrekking heeft.

Beperkingen

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

Voorbeeld: "example"

target_typeTekenreeksVerplicht

Of de bewerking betrekking heeft op een product of een variant.

Beperkingen

enum: ["product", "variant"]

Voorbeeld: "product"

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Beperkingen

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

Voorbeeld: "example"

Aanvullende velden: Nee

Lijst ophalen — Leveringen — Antwoord

DeliveryData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

deleted_atTekenreeks nullVerplicht

Tijdstip van verwijdering, indien aanwezig.

Tekenreeks:format: "date-time"

Voorbeeld: null

delivered_atTekenreeksVerplicht

Leveringsdatum en -tijd.

format: "date-time"

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

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (DeliveryData).

Voorbeeld: "example"

increases_stockBooleaanse waardeVerplicht

Of ontvangst van de levering de voorraad verhoogt.

Voorbeeld: true

location_idTekenreeksVerplicht

Identificatie van de magazijnlocatie.

Voorbeeld: "example"

quantityGeheel getalVerplicht

Aantal eenheden.

Voorbeeld: 1

received_atTekenreeks nullVerplicht

Datum en tijd waarop de levering is ontvangen.

Tekenreeks:format: "date-time"

Voorbeeld: null

record_statusTekenreeksVerplicht

Opgeslagen recordstatus.

Beperkingen

enum: ["active", "deleted"]

Voorbeeld: "active"

statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Beperkingen

enum: ["planned", "received"]

Voorbeeld: "planned"

stock_applied_atTekenreeks nullVerplicht

Datum en tijd waarop de voorraadwijziging van de levering is verwerkt.

Tekenreeks:format: "date-time"

Voorbeeld: null

target_idTekenreeksVerplicht

Identificatie van het product of de variant waarop de bewerking betrekking heeft.

Voorbeeld: "example"

target_typeTekenreeksVerplicht

Of de bewerking betrekking heeft op een product of een variant.

Beperkingen

enum: ["product", "variant"]

Voorbeeld: "product"

updated_atTekenreeks nullVerplicht

Tijdstip van de meest recente wijziging.

Tekenreeks:format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Voorbeeld: "example"

Aanvullende velden: Nee

Ophalen — Leveringen — Antwoord

DeliveryDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

deleted_atTekenreeks nullVerplicht

Tijdstip van verwijdering, indien aanwezig.

Tekenreeks:format: "date-time"

Voorbeeld: null

delivered_atTekenreeksVerplicht

Leveringsdatum en -tijd.

format: "date-time"

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

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (DeliveryDetailData).

Voorbeeld: "example"

increases_stockBooleaanse waardeVerplicht

Of ontvangst van de levering de voorraad verhoogt.

Voorbeeld: true

location_idTekenreeksVerplicht

Identificatie van de magazijnlocatie.

Voorbeeld: "example"

notesTekenreeks nullVerplicht

Aanvullende opmerkingen.

Voorbeeld: "example"

quantityGeheel getalVerplicht

Aantal eenheden.

Voorbeeld: 1

received_atTekenreeks nullVerplicht

Datum en tijd waarop de levering is ontvangen.

Tekenreeks:format: "date-time"

Voorbeeld: null

record_statusTekenreeksVerplicht

Opgeslagen recordstatus.

Beperkingen

enum: ["active", "deleted"]

Voorbeeld: "active"

statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Beperkingen

enum: ["planned", "received"]

Voorbeeld: "planned"

stock_applied_atTekenreeks nullVerplicht

Datum en tijd waarop de voorraadwijziging van de levering is verwerkt.

Tekenreeks:format: "date-time"

Voorbeeld: null

target_idTekenreeksVerplicht

Identificatie van het product of de variant waarop de bewerking betrekking heeft.

Voorbeeld: "example"

target_typeTekenreeksVerplicht

Of de bewerking betrekking heeft op een product of een variant.

Beperkingen

enum: ["product", "variant"]

Voorbeeld: "product"

updated_atTekenreeks nullVerplicht

Tijdstip van de meest recente wijziging.

Tekenreeks:format: "date-time"

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

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Voorbeeld: "example"

Aanvullende velden: Nee