Datascheman: Leveranser

Datascheman: Leveranser. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Hämta — Leveranser — Svar

ApiResponse_DeliveryDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataDeliveryDetailData Obligatoriskt: Exempel på svar · DeliveryDetailData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

Lista — Leveranser — Svar

ApiResponse_list_DeliveryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <DeliveryData > Obligatoriskt: Exempel på svar · ApiResponse_list_DeliveryData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Skapa — Leveranser — Begärans innehåll

DeliveryCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

delivered_atSträngObligatoriskt

Datum och tid för leverans.

format: "date-time"

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

increases_stockBooleskt värdeValfritt

Anger om mottagandet av leveransen ökar lagersaldot.

Standardvärde: true

location_idSträngObligatoriskt

Lagerplatsens identifierare.

Begränsningar

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

Exempel: "example"

notesSträngValfritt

Ytterligare anteckningar.

maxLength: 2000

Standardvärde: ""

quantityHeltalObligatoriskt

Antal enheter.

minimum: 1maximum: 2147483647

Exempel: 1

reasonSträngValfritt

Registrerad orsak till ändringen.

maxLength: 500

Standardvärde: ""

statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Begränsningar

enum: ["planned", "received"]

Exempel: "planned"

target_idSträngObligatoriskt

Identifierare för produkten eller varianten som operationen gäller.

Begränsningar

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

Exempel: "example"

target_typeSträngObligatoriskt

Anger om operationen gäller en produkt eller en variant.

Begränsningar

enum: ["product", "variant"]

Exempel: "product"

warehouse_idSträngObligatoriskt

Lagrets identifierare.

Begränsningar

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

Exempel: "example"

Ytterligare fält: Nej

Lista — Leveranser — Svar

DeliveryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

deleted_atSträng nullObligatoriskt

Tidpunkt för borttagning, om den finns.

Sträng:format: "date-time"

Exempel: null

delivered_atSträngObligatoriskt

Datum och tid för leverans.

format: "date-time"

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

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (DeliveryData).

Exempel: "example"

increases_stockBooleskt värdeObligatoriskt

Anger om mottagandet av leveransen ökar lagersaldot.

Exempel: true

location_idSträngObligatoriskt

Lagerplatsens identifierare.

Exempel: "example"

quantityHeltalObligatoriskt

Antal enheter.

Exempel: 1

received_atSträng nullObligatoriskt

Datum och tid när leveransen togs emot.

Sträng:format: "date-time"

Exempel: null

record_statusSträngObligatoriskt

Sparad poststatus.

Begränsningar

enum: ["active", "deleted"]

Exempel: "active"

statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Begränsningar

enum: ["planned", "received"]

Exempel: "planned"

stock_applied_atSträng nullObligatoriskt

Datum och tid när leveransens lagerändring genomfördes.

Sträng:format: "date-time"

Exempel: null

target_idSträngObligatoriskt

Identifierare för produkten eller varianten som operationen gäller.

Exempel: "example"

target_typeSträngObligatoriskt

Anger om operationen gäller en produkt eller en variant.

Begränsningar

enum: ["product", "variant"]

Exempel: "product"

updated_atSträng nullObligatoriskt

Tidpunkt för senaste uppdatering.

Sträng:format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

warehouse_idSträngObligatoriskt

Lagrets identifierare.

Exempel: "example"

Ytterligare fält: Nej

Hämta — Leveranser — Svar

DeliveryDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

deleted_atSträng nullObligatoriskt

Tidpunkt för borttagning, om den finns.

Sträng:format: "date-time"

Exempel: null

delivered_atSträngObligatoriskt

Datum och tid för leverans.

format: "date-time"

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

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (DeliveryDetailData).

Exempel: "example"

increases_stockBooleskt värdeObligatoriskt

Anger om mottagandet av leveransen ökar lagersaldot.

Exempel: true

location_idSträngObligatoriskt

Lagerplatsens identifierare.

Exempel: "example"

notesSträng nullObligatoriskt

Ytterligare anteckningar.

Exempel: "example"

quantityHeltalObligatoriskt

Antal enheter.

Exempel: 1

received_atSträng nullObligatoriskt

Datum och tid när leveransen togs emot.

Sträng:format: "date-time"

Exempel: null

record_statusSträngObligatoriskt

Sparad poststatus.

Begränsningar

enum: ["active", "deleted"]

Exempel: "active"

statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Begränsningar

enum: ["planned", "received"]

Exempel: "planned"

stock_applied_atSträng nullObligatoriskt

Datum och tid när leveransens lagerändring genomfördes.

Sträng:format: "date-time"

Exempel: null

target_idSträngObligatoriskt

Identifierare för produkten eller varianten som operationen gäller.

Exempel: "example"

target_typeSträngObligatoriskt

Anger om operationen gäller en produkt eller en variant.

Begränsningar

enum: ["product", "variant"]

Exempel: "product"

updated_atSträng nullObligatoriskt

Tidpunkt för senaste uppdatering.

Sträng:format: "date-time"

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

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

warehouse_idSträngObligatoriskt

Lagrets identifierare.

Exempel: "example"

Ytterligare fält: Nej