Skemi tad-data: Stokk

Skemi tad-data: Stokk. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Kwantitajiet assenjati lill-postijiet tal-maħżen

AllocationData · Skema · Skemi tad-data: Stokk

location_codeStringObbligatorju: Kodiċi tal-post fil-maħżen.

Eżempju: "example"
location_idStringObbligatorju: Identifikatur tal-post fil-maħżen.

Eżempju: "example"
location_nameStringObbligatorju: Isem tal-post fil-maħżen.

Eżempju: "example"
on_handNumru sħiħObbligatorju: Kwantità fiżika tal-istokk.

Eżempju: 10

Oqsma addizzjonali: Le

Elenka · Stokk — Stokk — Risposta

ApiResponse_list_StockData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <StockData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_StockData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Ikseb · Stokk — Stokk — Risposta

ApiResponse_StockDetailData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataStockDetailData Obbligatorju: Eżempju ta’ tweġiba · StockDetailData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"request_id":"example"}

Oqsma addizzjonali: Le

Aġġorna · Riżerva manwali — Stokk — Kontenut tat-talba

ManualReservationUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju: Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1
manual_reservedNumru sħiħObbligatorju: Kwantità riżervata manwalment.

minimum: 0maximum: 2147483647

Eżempju: 1
reasonStringMhux obbligatorju: Raġuni rreġistrata għall-bidla.

maxLength: 500

Valur predefinit: ""

Oqsma addizzjonali: Le

Aġġorna · Limitu tal-bejgħ — Stokk — Kontenut tat-talba

SalesLimitUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju: Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1
reasonStringMhux obbligatorju: Raġuni rreġistrata għall-bidla.

maxLength: 500

Valur predefinit: ""
sellable_limitNumru sħiħObbligatorju: Limitu tal-bejgħ: -1 ifisser bla limitu u 0 jiddiżattiva l-bejgħ disponibbli.

minimum: -1maximum: 2147483647

Eżempju: 1

Oqsma addizzjonali: Le

Oħloq · Aġġustament tal-istokk — Stokk — Kontenut tat-talba

StockAdjustmentCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 0maximum: 9223372036854775807

Eżempju: 0

locationsArray <LocationQuantity > Obbligatorju

Postijiet fil-maħżen.

minItems: 1maxItems: 100

Eżempju: [{"location_id":"example","on_hand":1}]

reasonStringObbligatorju

Raġuni rreġistrata għall-bidla.

minLength: 1maxLength: 500

Eżempju: "Example"

target_idStringObbligatorju

Identifikatur tal-prodott jew tal-varjant affettwat mill-operazzjoni.

Restrizzjonijiet

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

Eżempju: "example"

target_typeStringObbligatorju

Jekk l-operazzjoni tirrigwardax prodott jew varjant.

Restrizzjonijiet

enum: ["product", "variant"]

Eżempju: "product"

warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Restrizzjonijiet

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

Eżempju: "example"

Oqsma addizzjonali: Le

Aġġorna · Stokk — Stokk — Kontenut tat-talba

StockAdjustmentUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju: Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1
locationsArray <LocationQuantity > Obbligatorju: Postijiet fil-maħżen.

minItems: 1maxItems: 100

Eżempju: [{"location_id":"example","on_hand":1}]
reasonStringObbligatorju: Raġuni rreġistrata għall-bidla.

minLength: 1maxLength: 500

Eżempju: "Example"

Oqsma addizzjonali: Le

Elenka · Stokk — Stokk — Risposta

StockData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

activeBooleanObbligatorju

Jekk ir-riżorsa hijiex attiva.

Eżempju: true

availableNumru sħiħ nullObbligatorju

Kwantità disponibbli għall-bejgħ; null jirrappreżenta kwantità bla limitu.

Eżempju: 5

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (StockData).

Eżempju: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNumru sħiħObbligatorju

Kwantità riżervata manwalment.

Eżempju: 2

on_handNumru sħiħObbligatorju

Kwantità fiżika tal-istokk.

Eżempju: 10

reservedNumru sħiħObbligatorju

Kwantità riżervata mill-ordnijiet.

Eżempju: 3

sellable_limitNumru sħiħObbligatorju

Limitu tal-bejgħ: -1 ifisser bla limitu u 0 jiddiżattiva l-bejgħ disponibbli.

Eżempju: 10

target_idStringObbligatorju

Identifikatur tal-prodott jew tal-varjant affettwat mill-operazzjoni.

Eżempju: "example"

target_typeStringObbligatorju

Jekk l-operazzjoni tirrigwardax prodott jew varjant.

Restrizzjonijiet

enum: ["product", "variant"]

Eżempju: "product"

total_reservedNumru sħiħObbligatorju

Kwantità totali riżervata.

Eżempju: 5

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Eżempju: "example"

Oqsma addizzjonali: Le

Ikseb · Stokk — Stokk — Risposta

StockDetailData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

activeBooleanObbligatorju

Jekk ir-riżorsa hijiex attiva.

Eżempju: true

allocationsArray <AllocationData > Obbligatorju

Kwantitajiet assenjati lill-postijiet tal-maħżen.

Eżempju: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableNumru sħiħ nullObbligatorju

Kwantità disponibbli għall-bejgħ; null jirrappreżenta kwantità bla limitu.

Eżempju: 5

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (StockDetailData).

Eżempju: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNumru sħiħObbligatorju

Kwantità riżervata manwalment.

Eżempju: 2

on_handNumru sħiħObbligatorju

Kwantità fiżika tal-istokk.

Eżempju: 10

reservedNumru sħiħObbligatorju

Kwantità riżervata mill-ordnijiet.

Eżempju: 3

sellable_limitNumru sħiħObbligatorju

Limitu tal-bejgħ: -1 ifisser bla limitu u 0 jiddiżattiva l-bejgħ disponibbli.

Eżempju: 10

target_idStringObbligatorju

Identifikatur tal-prodott jew tal-varjant affettwat mill-operazzjoni.

Eżempju: "example"

target_typeStringObbligatorju

Jekk l-operazzjoni tirrigwardax prodott jew varjant.

Restrizzjonijiet

enum: ["product", "variant"]

Eżempju: "product"

total_reservedNumru sħiħObbligatorju

Kwantità totali riżervata.

Eżempju: 5

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Eżempju: "example"

Oqsma addizzjonali: Le