Dataskjemaer: Lagerbeholdning

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

Dataskjemaer

Mengder tilordnet lagerplasseringer

AllocationData · Skjema · Dataskjemaer: Lagerbeholdning

location_codeStrengObligatorisk: Kode for lagerplassering.

Eksempel: "example"
location_idStrengObligatorisk: Identifikator for lagerplassering.

Eksempel: "example"
location_nameStrengObligatorisk: Navn på lagerplassering.

Eksempel: "example"
on_handHeltallObligatorisk: Fysisk lagermengde.

Eksempel: 10

Ytterligere felt: Nei

Vis liste · Lagerbeholdning — Lagerbeholdning — Svar

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

dataArray <StockData > Obligatorisk: Eksempel på svar · ApiResponse_list_StockData__.

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

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

Ytterligere felt: Nei

Hent · Lagerbeholdning — Lagerbeholdning — Svar

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

dataStockDetailData Obligatorisk: Eksempel på svar · StockDetailData.

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

Eksempel: {"request_id":"example"}

Ytterligere felt: Nei

Oppdater · Manuell reservasjon — Lagerbeholdning — Forespørselsinnhold

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

expected_versionHeltallObligatorisk: Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
manual_reservedHeltallObligatorisk: Manuelt reservert mengde.

minimum: 0maximum: 2147483647

Eksempel: 1
reasonStrengValgfritt: Registrert begrunnelse for endringen.

maxLength: 500

Standard: ""

Ytterligere felt: Nei

Oppdater · Salgsgrense — Lagerbeholdning — Forespørselsinnhold

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

expected_versionHeltallObligatorisk: Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
reasonStrengValgfritt: Registrert begrunnelse for endringen.

maxLength: 500

Standard: ""
sellable_limitHeltallObligatorisk: Salgsgrense: -1 betyr ubegrenset, og 0 deaktiverer tilgjengelig salg.

minimum: -1maximum: 2147483647

Eksempel: 1

Ytterligere felt: Nei

Opprett · Lagerjustering — Lagerbeholdning — Forespørselsinnhold

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

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 0maximum: 9223372036854775807

Eksempel: 0

locationsArray <LocationQuantity > Obligatorisk

Lagerplasseringer.

minItems: 1maxItems: 100

Eksempel: [{"location_id":"example","on_hand":1}]

reasonStrengObligatorisk

Registrert begrunnelse for endringen.

minLength: 1maxLength: 500

Eksempel: "Example"

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

Oppdater · Lagerbeholdning — Lagerbeholdning — Forespørselsinnhold

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

expected_versionHeltallObligatorisk: Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
locationsArray <LocationQuantity > Obligatorisk: Lagerplasseringer.

minItems: 1maxItems: 100

Eksempel: [{"location_id":"example","on_hand":1}]
reasonStrengObligatorisk: Registrert begrunnelse for endringen.

minLength: 1maxLength: 500

Eksempel: "Example"

Ytterligere felt: Nei

Vis liste · Lagerbeholdning — Lagerbeholdning — Svar

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

activeBoolsk verdiObligatorisk

Om ressursen er aktiv.

Eksempel: true

availableHeltall nullObligatorisk

Mengde tilgjengelig for salg; null betyr ubegrenset mengde.

Eksempel: 5

idStrengObligatorisk

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

Eksempel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedHeltallObligatorisk

Manuelt reservert mengde.

Eksempel: 2

on_handHeltallObligatorisk

Fysisk lagermengde.

Eksempel: 10

reservedHeltallObligatorisk

Mengde reservert av ordrer.

Eksempel: 3

sellable_limitHeltallObligatorisk

Salgsgrense: -1 betyr ubegrenset, og 0 deaktiverer tilgjengelig salg.

Eksempel: 10

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"

total_reservedHeltallObligatorisk

Samlet reservert mengde.

Eksempel: 5

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

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 · Lagerbeholdning — Lagerbeholdning — Svar

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

activeBoolsk verdiObligatorisk

Om ressursen er aktiv.

Eksempel: true

allocationsArray <AllocationData > Obligatorisk

Mengder tilordnet lagerplasseringer.

Eksempel: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableHeltall nullObligatorisk

Mengde tilgjengelig for salg; null betyr ubegrenset mengde.

Eksempel: 5

idStrengObligatorisk

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

Eksempel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedHeltallObligatorisk

Manuelt reservert mengde.

Eksempel: 2

on_handHeltallObligatorisk

Fysisk lagermengde.

Eksempel: 10

reservedHeltallObligatorisk

Mengde reservert av ordrer.

Eksempel: 3

sellable_limitHeltallObligatorisk

Salgsgrense: -1 betyr ubegrenset, og 0 deaktiverer tilgjengelig salg.

Eksempel: 10

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"

total_reservedHeltallObligatorisk

Samlet reservert mengde.

Eksempel: 5

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Ytterligere felt: Nei