Dataskemaer: Lagerbeholdning

Dataskemaer: Lagerbeholdning. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Mængder tildelt lagerplaceringer

AllocationData · Skema · Dataskemaer: Lagerbeholdning

location_codeStrengObligatorisk: Kode for lagerplacering.

Eksempel: "example"
location_idStrengObligatorisk: Identifikator for lagerplacering.

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

Eksempel: "example"
on_handHeltalObligatorisk: Fysisk lagermængde.

Eksempel: 10

Yderligere felter: Nej

Vis liste · Lagerbeholdning — Lagerbeholdning — Svar

ApiResponse_list_StockData__ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Hent · Lagerbeholdning — Lagerbeholdning — Svar

ApiResponse_StockDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Opdater · Manuel reservation — Lagerbeholdning — Forespørgselsindhold

ManualReservationUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

expected_versionHeltalObligatorisk: Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
manual_reservedHeltalObligatorisk: Manuelt reserveret mængde.

minimum: 0maximum: 2147483647

Eksempel: 1
reasonStrengValgfrit: Registreret begrundelse for ændringen.

maxLength: 500

Standard: ""

Yderligere felter: Nej

Opdater · Salgsgrænse — Lagerbeholdning — Forespørgselsindhold

SalesLimitUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

expected_versionHeltalObligatorisk: Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
reasonStrengValgfrit: Registreret begrundelse for ændringen.

maxLength: 500

Standard: ""
sellable_limitHeltalObligatorisk: Salgsgrænse: -1 betyder ubegrænset, og 0 deaktiverer tilgængeligt salg.

minimum: -1maximum: 2147483647

Eksempel: 1

Yderligere felter: Nej

Opret · Lagerregulering — Lagerbeholdning — Forespørgselsindhold

StockAdjustmentCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 0maximum: 9223372036854775807

Eksempel: 0

locationsArray <LocationQuantity > Obligatorisk

Lagerplaceringer.

minItems: 1maxItems: 100

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

reasonStrengObligatorisk

Registreret begrundelse for ændringen.

minLength: 1maxLength: 500

Eksempel: "Example"

target_idStrengObligatorisk

Identifikator for produktet eller varianten, som operationen påvirker.

Begrænsninger

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

Eksempel: "example"

target_typeStrengObligatorisk

Om operationen vedrører et produkt eller en variant.

Begrænsninger

enum: ["product", "variant"]

Eksempel: "product"

warehouse_idStrengObligatorisk

Lageridentifikator.

Begrænsninger

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

Eksempel: "example"

Yderligere felter: Nej

Opdater · Lagerbeholdning — Lagerbeholdning — Forespørgselsindhold

StockAdjustmentUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

expected_versionHeltalObligatorisk: Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
locationsArray <LocationQuantity > Obligatorisk: Lagerplaceringer.

minItems: 1maxItems: 100

Eksempel: [{"location_id":"example","on_hand":1}]
reasonStrengObligatorisk: Registreret begrundelse for ændringen.

minLength: 1maxLength: 500

Eksempel: "Example"

Yderligere felter: Nej

Vis liste · Lagerbeholdning — Lagerbeholdning — Svar

StockData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

activeBoolesk værdiObligatorisk

Om ressourcen er aktiv.

Eksempel: true

availableHeltal nullObligatorisk

Mængde tilgængelig for salg; null betyder ubegrænset mængde.

Eksempel: 5

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (StockData).

Eksempel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedHeltalObligatorisk

Manuelt reserveret mængde.

Eksempel: 2

on_handHeltalObligatorisk

Fysisk lagermængde.

Eksempel: 10

reservedHeltalObligatorisk

Mængde reserveret af ordrer.

Eksempel: 3

sellable_limitHeltalObligatorisk

Salgsgrænse: -1 betyder ubegrænset, og 0 deaktiverer tilgængeligt salg.

Eksempel: 10

target_idStrengObligatorisk

Identifikator for produktet eller varianten, som operationen påvirker.

Eksempel: "example"

target_typeStrengObligatorisk

Om operationen vedrører et produkt eller en variant.

Begrænsninger

enum: ["product", "variant"]

Eksempel: "product"

total_reservedHeltalObligatorisk

Samlet reserveret mængde.

Eksempel: 5

updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

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

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Yderligere felter: Nej

Hent · Lagerbeholdning — Lagerbeholdning — Svar

StockDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

activeBoolesk værdiObligatorisk

Om ressourcen er aktiv.

Eksempel: true

allocationsArray <AllocationData > Obligatorisk

Mængder tildelt lagerplaceringer.

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

availableHeltal nullObligatorisk

Mængde tilgængelig for salg; null betyder ubegrænset mængde.

Eksempel: 5

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (StockDetailData).

Eksempel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedHeltalObligatorisk

Manuelt reserveret mængde.

Eksempel: 2

on_handHeltalObligatorisk

Fysisk lagermængde.

Eksempel: 10

reservedHeltalObligatorisk

Mængde reserveret af ordrer.

Eksempel: 3

sellable_limitHeltalObligatorisk

Salgsgrænse: -1 betyder ubegrænset, og 0 deaktiverer tilgængeligt salg.

Eksempel: 10

target_idStrengObligatorisk

Identifikator for produktet eller varianten, som operationen påvirker.

Eksempel: "example"

target_typeStrengObligatorisk

Om operationen vedrører et produkt eller en variant.

Begrænsninger

enum: ["product", "variant"]

Eksempel: "product"

total_reservedHeltalObligatorisk

Samlet reserveret mængde.

Eksempel: 5

updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

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

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

warehouse_idStrengObligatorisk

Lageridentifikator.

Eksempel: "example"

Yderligere felter: Nej