Dataskjemaer: Leveranser

Dataskjemaer: Leveranser. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Hent — Leveranser — Svar

ApiResponse_DeliveryDetailData_ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataDeliveryDetailData Obligatorisk: Eksempel på svar · DeliveryDetailData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

Eksempel: {"request_id":"example"}

Ytterligere felt: Nei

Vis liste — Leveranser — Svar

ApiResponse_list_DeliveryData__ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

dataArray <DeliveryData > Obligatorisk: Eksempel på svar · ApiResponse_list_DeliveryData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Ytterligere felt: Nei

Opprett — Leveranser — Forespørselsinnhold

DeliveryCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

format: "date-time"

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

increases_stockBoolsk verdiValgfritt

Om mottak av leveransen øker lagerbeholdningen.

Standard: true

location_idStrengObligatorisk

Identifikator for lagerplassering.

Begrensninger

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

Eksempel: "example"

notesStrengValgfritt

Ytterligere merknader.

maxLength: 2000

Standard: ""

quantityHeltallObligatorisk

Antall enheter.

minimum: 1maximum: 2147483647

Eksempel: 1

reasonStrengValgfritt

Registrert begrunnelse for endringen.

maxLength: 500

Standard: ""

statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Begrensninger

enum: ["planned", "received"]

Eksempel: "planned"

target_idStrengObligatorisk

Identifikator for produktet eller varianten operasjonen påvirker.

Begrensninger

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

Eksempel: "example"

target_typeStrengObligatorisk

Om operasjonen gjelder et produkt eller en variant.

Begrensninger

enum: ["product", "variant"]

Eksempel: "product"

warehouse_idStrengObligatorisk

Lageridentifikator.

Begrensninger

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

Eksempel: "example"

Ytterligere felt: Nei

Vis liste — Leveranser — Svar

DeliveryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

deleted_atStreng nullObligatorisk

Slettingstidspunkt, hvis det finnes.

Streng:format: "date-time"

Eksempel: null

delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

format: "date-time"

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

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (DeliveryData).

Eksempel: "example"

increases_stockBoolsk verdiObligatorisk

Om mottak av leveransen øker lagerbeholdningen.

Eksempel: true

location_idStrengObligatorisk

Identifikator for lagerplassering.

Eksempel: "example"

quantityHeltallObligatorisk

Antall enheter.

Eksempel: 1

received_atStreng nullObligatorisk

Dato og tidspunkt da leveransen ble mottatt.

Streng:format: "date-time"

Eksempel: null

record_statusStrengObligatorisk

Lagret oppføringsstatus.

Begrensninger

enum: ["active", "deleted"]

Eksempel: "active"

statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Begrensninger

enum: ["planned", "received"]

Eksempel: "planned"

stock_applied_atStreng nullObligatorisk

Dato og tidspunkt da leveransens lagerendring ble utført.

Streng:format: "date-time"

Eksempel: null

target_idStrengObligatorisk

Identifikator for produktet eller varianten operasjonen påvirker.

Eksempel: "example"

target_typeStrengObligatorisk

Om operasjonen gjelder et produkt eller en variant.

Begrensninger

enum: ["product", "variant"]

Eksempel: "product"

updated_atStreng nullObligatorisk

Tidspunkt for siste oppdatering.

Streng:format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Ytterligere felt: Nei

Hent — Leveranser — Svar

DeliveryDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

deleted_atStreng nullObligatorisk

Slettingstidspunkt, hvis det finnes.

Streng:format: "date-time"

Eksempel: null

delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

format: "date-time"

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

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (DeliveryDetailData).

Eksempel: "example"

increases_stockBoolsk verdiObligatorisk

Om mottak av leveransen øker lagerbeholdningen.

Eksempel: true

location_idStrengObligatorisk

Identifikator for lagerplassering.

Eksempel: "example"

notesStreng nullObligatorisk

Ytterligere merknader.

Eksempel: "example"

quantityHeltallObligatorisk

Antall enheter.

Eksempel: 1

received_atStreng nullObligatorisk

Dato og tidspunkt da leveransen ble mottatt.

Streng:format: "date-time"

Eksempel: null

record_statusStrengObligatorisk

Lagret oppføringsstatus.

Begrensninger

enum: ["active", "deleted"]

Eksempel: "active"

statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Begrensninger

enum: ["planned", "received"]

Eksempel: "planned"

stock_applied_atStreng nullObligatorisk

Dato og tidspunkt da leveransens lagerendring ble utført.

Streng:format: "date-time"

Eksempel: null

target_idStrengObligatorisk

Identifikator for produktet eller varianten operasjonen påvirker.

Eksempel: "example"

target_typeStrengObligatorisk

Om operasjonen gjelder et produkt eller en variant.

Begrensninger

enum: ["product", "variant"]

Eksempel: "product"

updated_atStreng nullObligatorisk

Tidspunkt for siste oppdatering.

Streng:format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Ytterligere felt: Nei