Datascheman: Lager

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

Datascheman

Kvantiteter tilldelade till lagerplatser

AllocationData · Schema · Datascheman: Lager

location_codeSträngObligatoriskt: Lagerplatsens kod.

Exempel: "example"
location_idSträngObligatoriskt: Lagerplatsens identifierare.

Exempel: "example"
location_nameSträngObligatoriskt: Lagerplatsens namn.

Exempel: "example"
on_handHeltalObligatoriskt: Fysiskt antal i lager.

Exempel: 10

Ytterligare fält: Nej

Lista · Lagersaldo — Lager — Svar

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

dataArray <StockData > Obligatoriskt: Exempel på svar · ApiResponse_list_StockData__.

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

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

Ytterligare fält: Nej

Hämta · Lagersaldo — Lager — Svar

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

dataStockDetailData Obligatoriskt: Exempel på svar · StockDetailData.

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

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

Uppdatera · Manuell reservation — Lager — Begärans innehåll

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

expected_versionHeltalObligatoriskt: Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1
manual_reservedHeltalObligatoriskt: Manuellt reserverat antal.

minimum: 0maximum: 2147483647

Exempel: 1
reasonSträngValfritt: Registrerad orsak till ändringen.

maxLength: 500

Standardvärde: ""

Ytterligare fält: Nej

Uppdatera · Försäljningsgräns — Lager — Begärans innehåll

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

expected_versionHeltalObligatoriskt: Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1
reasonSträngValfritt: Registrerad orsak till ändringen.

maxLength: 500

Standardvärde: ""
sellable_limitHeltalObligatoriskt: Försäljningsgräns: -1 betyder obegränsat och 0 förhindrar tillgänglig försäljning.

minimum: -1maximum: 2147483647

Exempel: 1

Ytterligare fält: Nej

Skapa · Lagerjustering — Lager — Begärans innehåll

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

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 0maximum: 9223372036854775807

Exempel: 0

locationsArray <LocationQuantity > Obligatoriskt

Lagerplatser.

minItems: 1maxItems: 100

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

reasonSträngObligatoriskt

Registrerad orsak till ändringen.

minLength: 1maxLength: 500

Exempel: "Example"

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

Uppdatera · Lagersaldo — Lager — Begärans innehåll

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

expected_versionHeltalObligatoriskt: Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1
locationsArray <LocationQuantity > Obligatoriskt: Lagerplatser.

minItems: 1maxItems: 100

Exempel: [{"location_id":"example","on_hand":1}]
reasonSträngObligatoriskt: Registrerad orsak till ändringen.

minLength: 1maxLength: 500

Exempel: "Example"

Ytterligare fält: Nej

Lista · Lagersaldo — Lager — Svar

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

activeBooleskt värdeObligatoriskt

Anger om resursen är aktiv.

Exempel: true

availableHeltal nullObligatoriskt

Antal tillgängliga för försäljning; null betyder obegränsat antal.

Exempel: 5

idSträngObligatoriskt

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

Exempel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedHeltalObligatoriskt

Manuellt reserverat antal.

Exempel: 2

on_handHeltalObligatoriskt

Fysiskt antal i lager.

Exempel: 10

reservedHeltalObligatoriskt

Antal reserverade av beställningar.

Exempel: 3

sellable_limitHeltalObligatoriskt

Försäljningsgräns: -1 betyder obegränsat och 0 förhindrar tillgänglig försäljning.

Exempel: 10

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"

total_reservedHeltalObligatoriskt

Totalt reserverat antal.

Exempel: 5

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

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 · Lagersaldo — Lager — Svar

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

activeBooleskt värdeObligatoriskt

Anger om resursen är aktiv.

Exempel: true

allocationsArray <AllocationData > Obligatoriskt

Kvantiteter tilldelade till lagerplatser.

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

availableHeltal nullObligatoriskt

Antal tillgängliga för försäljning; null betyder obegränsat antal.

Exempel: 5

idSträngObligatoriskt

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

Exempel: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedHeltalObligatoriskt

Manuellt reserverat antal.

Exempel: 2

on_handHeltalObligatoriskt

Fysiskt antal i lager.

Exempel: 10

reservedHeltalObligatoriskt

Antal reserverade av beställningar.

Exempel: 3

sellable_limitHeltalObligatoriskt

Försäljningsgräns: -1 betyder obegränsat och 0 förhindrar tillgänglig försäljning.

Exempel: 10

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"

total_reservedHeltalObligatoriskt

Totalt reserverat antal.

Exempel: 5

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

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