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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Kodiċi jiġi rritornat bħala JSON u fajl bħala dejta binarja. Kull talba teħtieġ Bearer u l-permess reveal.

dataCodeContentData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Iċċekkja d-daqs, iċ-checksum u l-format. Upload lest ma jfissirx li l-kunsinna ġiet riċevuta.

dataDigitalUploadData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

ApiResponse[ImportData]

ApiResponse_ImportData_ · Iċċekkja l-istat, il-verżjoni u l-validazzjoni. L-abbozz jappartjeni għaċ-ċavetta API li ħolqitu.

dataImportData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

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

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Aqra s-settings u l-kwantitajiet qabel tibdilhom. It-tweġiba ma tinkludix kodiċijiet jew kontenut ta’ fajls.

dataPoolData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

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

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Aqra sa 100 unità kull paġna. Il-lista turi metadata mingħajr ma tikxef kodiċijiet.

dataUnitsData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

CodeContentData

CodeContentData · Kodiċi jiġi rritornat bħala JSON u fajl bħala dejta binarja. Kull talba teħtieġ Bearer u l-permess reveal.

codeStringObbligatorju: Il-kodiċi diġitali eżatt. Żomm l-ittri kbar u żgħar u l-ispazji interni.

minLength: 1maxLength: 512

Eżempju: "DEMO-ONE"
delivery_idString nullMhux obbligatorju: ID tal-kunsinna jew tal-allokazzjoni tal-ordni.

String:format: "uuid"

Eżempju: null
kindStringMhux obbligatorju: Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

const: "code"

Valur predefinit: "code"Eżempju: "code"
payload_idStringObbligatorju: ID tal-kontenut; mhuwiex URL pubbliku għat-tniżżil.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000004"
unit_idStringObbligatorju: ID ta’ kodiċi jew fajl individwali.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000003"

Oqsma addizzjonali: Le

DigitalUploadCreate

DigitalUploadCreate · Irriżerva spazju għal fajl u għaqqdu ma’ importazzjoni jew l-unità li se tinbidel.

consumer_idStringObbligatorju

ID tal-importazzjoni jew unità marbuta.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000001"

consumer_kindStringObbligatorju

Rabta tal-upload: digital_import / digital_unit.

Restrizzjonijiet

enum: ["digital_import", "digital_unit"]

Eżempju: "digital_import"

filenameStringObbligatorju

Fajl

minLength: 1maxLength: 255

Eżempju: "codes.txt"

purposeStringObbligatorju

digital_import: TXT/CSV; digital_unit: fajl mibjugħ individwalment.

Restrizzjonijiet

enum: ["digital_unit", "digital_import"]

Eżempju: "digital_import"

sha256StringObbligatorju

SHA-256 (hex, 64)

Restrizzjonijiet

pattern: "^[0-9a-f]{64}$"

Eżempju: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNumru sħiħObbligatorju

Daqs f’bytes

minimum: 1maximum: 262144000

Eżempju: 18

Oqsma addizzjonali: Le

DigitalUploadData

DigitalUploadData · Iċċekkja d-daqs, iċ-checksum u l-format. Upload lest ma jfissirx li l-kunsinna ġiet riċevuta.

consumer_idStringObbligatorju

ID tal-importazzjoni jew unità marbuta.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000001"

consumer_kindStringObbligatorju

Rabta tal-upload: digital_import / digital_unit.

Restrizzjonijiet

enum: ["digital_import", "digital_unit"]

Eżempju: "digital_import"

expires_atStringObbligatorju

Il-ħin tal-iskadenza ta’ dan it-tlugħ jew import.

format: "date-time"

Eżempju: "2026-11-03T13:00:00Z"

filenameStringObbligatorju

Fajl

Eżempju: "codes.txt"

idStringObbligatorju

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

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000002"

product_idStringObbligatorju

Identifikatur tal-prodott.

Eżempju: "example"

purposeStringObbligatorju

digital_import: TXT/CSV; digital_unit: fajl mibjugħ individwalment.

Restrizzjonijiet

enum: ["digital_unit", "digital_import"]

Eżempju: "digital_import"

received_bytesNumru sħiħObbligatorju

Qed jittellgħu… · Daqs f’bytes

Eżempju: 18

sha256StringObbligatorju

SHA-256 (hex, 64)

Eżempju: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNumru sħiħObbligatorju

Daqs f’bytes

Eżempju: 18

statusStringObbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Eżempju: "ready"

Oqsma addizzjonali: Le

ImportCommit

ImportCommit · Oħloq kunsinna ppjanata jew riċevuta mil-lott ivvalidat. Unitajiet ippjanati għadhom mhux għall-bejgħ.

delivered_atStringObbligatorju

Data u ħin tal-kunsinna.

format: "date-time"

Eżempju: "2026-11-03T12:00:00Z"

expected_delivery_versionNumru sħiħObbligatorju

Verżjoni tal-kunsinna; 0 għal kunsinna ġdida.

minimum: 0maximum: 0

Eżempju: 0

expected_sales_limit_versionNumru sħiħ nullMhux obbligatorju

Verżjoni tal-limitu tal-bejgħ; meħtieġa ma’ publish_for_sale=true.

Numru sħiħ:minimum: 0maximum: 9223372036854775807

Eżempju: 0

expected_versionNumru sħiħObbligatorju

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

minimum: 1maximum: 9223372036854775807

Eżempju: 2

location_idStringObbligatorju

Identifikatur tal-post fil-maħżen.

Restrizzjonijiet

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

Eżempju: "location-digital"

publish_for_saleBooleanMhux obbligatorju

true iżid ukoll il-limitu finit tal-bejgħ; false ma jbiddlux.

Valur predefinit: falseEżempju: true

statusStringObbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Restrizzjonijiet

enum: ["planned", "received"]

Eżempju: "received"

validation_digestStringObbligatorju

Checksum tal-validazzjoni; ibgħatha bla tibdil fil-konferma.

Restrizzjonijiet

pattern: "^[0-9a-f]{64}$"

Eżempju: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Restrizzjonijiet

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

Eżempju: "warehouse-main"

Oqsma addizzjonali: Le

ImportCreate

ImportCreate · Ipprepara abbozz b’sa 1000 kodiċi jew 100 fajl. L-istokk għall-bejgħ għadu ma jiżdiedx.

countNumru sħiħObbligatorju

Numru eżatt ta’ unitajiet fil-lott.

minimum: 1maximum: 1000

Eżempju: 2

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["code", "file"]

Eżempju: "code"

Oqsma addizzjonali: Le

ImportData

ImportData · Iċċekkja l-istat, il-verżjoni u l-validazzjoni. L-abbozz jappartjeni għaċ-ċavetta API li ħolqitu.

delivery_idString nullObbligatorju

ID tal-kunsinna jew tal-allokazzjoni tal-ordni.

Eżempju: null

delivery_statusString nullObbligatorju

Stat tal-kunsinna: planned / received; null qabel il-konferma.

Eżempju: null

delivery_versionNumru sħiħ nullObbligatorju

Verżjoni attwali tal-kunsinna fil-maħżen.

Eżempju: null

expected_countNumru sħiħObbligatorju

Numru mistenni; jiġi aċċettat biss il-lott kollu.

Eżempju: 2

expires_atStringObbligatorju

Il-ħin tal-iskadenza ta’ dan it-tlugħ jew import.

format: "date-time"

Eżempju: "2026-11-03T13:00:00Z"

idStringObbligatorju

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

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000001"

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["code", "file"]

Eżempju: "code"

product_idStringObbligatorju

Identifikatur tal-prodott.

Eżempju: "example"

statusStringObbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Eżempju: "validated"

validated_countNumru sħiħObbligatorju

Numru ta’ unitajiet aċċettati fl-aħħar validazzjoni b’suċċess.

Eżempju: 2

validation_digestString nullObbligatorju

Checksum tal-validazzjoni; ibgħatha bla tibdil fil-konferma.

Eżempju: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionNumru sħiħObbligatorju

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

Eżempju: 2

Oqsma addizzjonali: Le

ImportReceive

ImportReceive · Irċievi l-unitajiet eżistenti mingħajr ma terġa’ timporta l-kodiċijiet jew il-fajls.

expected_delivery_versionNumru sħiħObbligatorju: Verżjoni tal-kunsinna; 0 għal kunsinna ġdida.

minimum: 1maximum: 9223372036854775807

Eżempju: 1
expected_sales_limit_versionNumru sħiħ nullMhux obbligatorju: Verżjoni tal-limitu tal-bejgħ; meħtieġa ma’ publish_for_sale=true.

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

minimum: 1maximum: 9223372036854775807

Eżempju: 3
publish_for_saleBooleanMhux obbligatorju: true iżid ukoll il-limitu finit tal-bejgħ; false ma jbiddlux.

Valur predefinit: false

Oqsma addizzjonali: Le

ImportValidate

ImportValidate · Iċċekkja l-lott kollu. Duplikat jew entrata invalida jirrifjuta l-lott; il-kodiċijiet ma jitqassrux.

code_columnString nullMhux obbligatorju

Kolonna CSV bil-kodiċijiet; uża code.

String:const: "code"

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

formatString nullMhux obbligatorju

Lista ta’ kodiċijiet: txt / csv; uża upload_ids għall-fajls.

Restrizzjonijiet · String 1

enum: ["txt", "csv"]

Eżempju: "txt"

source_upload_idString nullMhux obbligatorju

Upload privat TXT/CSV lest għal din l-importazzjoni.

String:format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000002"

upload_idsArray <String> nullMhux obbligatorju

1–100 upload privat ta’ fajls lesti għal din l-importazzjoni.

Array:minItems: 1maxItems: 100

Array / Array:format: "uuid"

Oqsma addizzjonali: Le

ImportWithdrawal

ImportWithdrawal · Irtira biss unitajiet ħielsa. Dawk riżervati u allokati jibqgħu marbuta mal-ordnijiet tagħhom.

expected_delivery_versionNumru sħiħObbligatorju: Verżjoni tal-kunsinna; 0 għal kunsinna ġdida.

minimum: 1maximum: 9223372036854775807

Eżempju: 1
expected_order_versionNumru sħiħObbligatorju: Verżjoni tas-sekwenza tal-allokazzjoni, mhux tal-ordni tal-klijent.

minimum: 0maximum: 9223372036854775807

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

minimum: 1maximum: 9223372036854775807

Eżempju: 3
reasonStringObbligatorju: Raġuni rreġistrata għall-bidla.

minLength: 1maxLength: 500

Eżempju: "Withdraw a revoked license"

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

PoolChange

PoolChange · Attiva kodiċijiet jew fajls individwali minn Professional ’il fuq. Id-diżattivazzjoni żżomm l-aċċess għax-xiri preċedenti.

email_modeStringMhux obbligatorju

disabled: bla e-mail; order_link: link għall-ordni; code_text: jistgħu jiżdiedu kodiċijiet.

Restrizzjonijiet

enum: ["disabled", "order_link", "code_text"]

Valur predefinit: "disabled"Eżempju: "order_link"

enabledBooleanObbligatorju

Jekk dan l-issettjar huwiex attivat.

Eżempju: true

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

retention_daysNumru sħiħ nullMhux obbligatorju

null: bla skadenza; 1–3650 jum mill-ewwel aċċess. Kodiċijiet ma jitħassrux awtomatikament.

Numru sħiħ:minimum: 1maximum: 3650

Eżempju: null

Oqsma addizzjonali: Le

PoolCounts

PoolCounts · Aqra s-settings u l-kwantitajiet qabel tibdilhom. It-tweġiba ma tinkludix kodiċijiet jew kontenut ta’ fajls.

availableNumru sħiħObbligatorju: Għadd ta’ unitajiet ħielsa li ma ġewx riservati jew mogħtija.

Eżempju: 1
heldNumru sħiħObbligatorju: Unitajiet riżervati għall-ordnijiet, għadhom mhux mogħtija.

Eżempju: 0
issuedNumru sħiħObbligatorju: Unitajiet diġà mogħtija għal xiri mħallas.

Eżempju: 1
plannedNumru sħiħObbligatorju: Unitajiet ta’ kunsinni kkonfermati li għadhom mhux riċevuti.

Eżempju: 0
retiredNumru sħiħObbligatorju: Unitajiet irtirati miżmuma fl-istorja.

Eżempju: 0
stagedNumru sħiħObbligatorju: Unitajiet ta’ importazzjonijiet mhux lesti, għadhom mhux stokk.

Eżempju: 0

Oqsma addizzjonali: Le

PoolData

PoolData · Aqra s-settings u l-kwantitajiet qabel tibdilhom. It-tweġiba ma tinkludix kodiċijiet jew kontenut ta’ fajls.

configuredBooleanObbligatorju

Jekk is-settings tal-istokk diġitali ġew salvati.

Eżempju: true

countsPoolCounts Obbligatorju

Numru ta’ unitajiet skont l-istat tal-istokk.

Eżempju: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeStringObbligatorju

disabled: bla e-mail; order_link: link għall-ordni; code_text: jistgħu jiżdiedu kodiċijiet.

Restrizzjonijiet

enum: ["disabled", "order_link", "code_text"]

Eżempju: "order_link"

enabledBooleanObbligatorju

Jekk dan l-issettjar huwiex attivat.

Eżempju: true

order_versionNumru sħiħObbligatorju

Verżjoni tas-sekwenza tal-allokazzjoni tal-istokk.

Eżempju: 2

product_idStringObbligatorju

Identifikatur tal-prodott.

Eżempju: "example"

retention_daysNumru sħiħ nullObbligatorju

null: bla skadenza; 1–3650 jum mill-ewwel aċċess. Kodiċijiet ma jitħassrux awtomatikament.

Eżempju: null

versionNumru sħiħObbligatorju

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

Eżempju: 1

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

UnitData

UnitData · Aqra sa 100 unità kull paġna. Il-lista turi metadata mingħajr ma tikxef kodiċijiet.

content_stateStringObbligatorju

Stat tal-kontenut: present / deleting / deleted.

Eżempju: "present"

delivery_idString nullObbligatorju

ID tal-kunsinna jew tal-allokazzjoni tal-ordni.

Eżempju: "delivery-example"

filenameString nullObbligatorju

Fajl

Eżempju: null

idStringObbligatorju

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

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000003"

issued_atString nullObbligatorju

L-ewwel għoti; null qablu.

String:format: "date-time"

Eżempju: null

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["file", "code"]

Eżempju: "code"

location_idString nullObbligatorju

Identifikatur tal-post fil-maħżen.

Eżempju: "location-digital"

mime_typeString nullObbligatorju

Tip tal-kontenut tal-midja.

Eżempju: null

payload_idStringObbligatorju

ID tal-kontenut; mhuwiex URL pubbliku għat-tniżżil.

format: "uuid"

Eżempju: "00000000-0000-4000-8000-000000000004"

product_idStringObbligatorju

Identifikatur tal-prodott.

Eżempju: "example"

size_bytesNumru sħiħ nullObbligatorju

Daqs f’bytes

Eżempju: null

sort_orderNumru sħiħObbligatorju

Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1

stateStringObbligatorju

Stat

Eżempju: "available"

versionNumru sħiħObbligatorju

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

Eżempju: 1

warehouse_idString nullObbligatorju

Identifikatur tal-maħżen.

Eżempju: "warehouse-main"

Oqsma addizzjonali: Le

UnitDeletion

UnitDeletion · Neħħi kodiċi jew fajl mhux mibjugħ b’raġuni. Unitajiet riżervati jew allokati jiġu miċħuda.

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

minimum: 1

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

minLength: 1maxLength: 500

Eżempju: "Withdraw a revoked license"

Oqsma addizzjonali: Le

UnitReorder

UnitReorder · Ibgħat il-paġna sħiħa mingħajr filtri fl-ordni mixtieqa. Verżjoni skaduta tirritorna 409.

expected_order_versionNumru sħiħObbligatorju: Verżjoni tas-sekwenza tal-allokazzjoni, mhux tal-ordni tal-klijent.

minimum: 1

Eżempju: 1
unit_idsArray <String> Obbligatorju: L-unitajiet kollha tal-paġna mingħajr filtri fl-ordni mixtieqa.

minItems: 2maxItems: 100
Array:format: "uuid"

Eżempju: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorString nullMhux obbligatorju: Cursor tal-paġna mingħajr filtri; null għall-ewwel paġna.

String:maxLength: 1024

Oqsma addizzjonali: Le

UnitReplacement

UnitReplacement · Ibdel il-kodiċi jew fajl mingħajr ma tbiddel il-pożizzjoni. Il-bidla tinżamm fl-istorja tal-maħżen.

codeString nullMhux obbligatorju: Il-kodiċi diġitali eżatt. Żomm l-ittri kbar u żgħar u l-ispazji interni.

String:minLength: 1maxLength: 512

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

minimum: 1

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

minLength: 1maxLength: 500

Eżempju: "Replace an invalid activation code"
upload_idString nullMhux obbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. · upload_id

String:format: "uuid"

Oqsma addizzjonali: Le

UnitsData

UnitsData · Aqra sa 100 unità kull paġna. Il-lista turi metadata mingħajr ma tikxef kodiċijiet.

order_versionNumru sħiħObbligatorju: Verżjoni tas-sekwenza tal-allokazzjoni tal-istokk.

Eżempju: 2
totalNumru sħiħObbligatorju: Ammont totali.

Eżempju: 1
unitsArray <UnitData > Obbligatorju: Metadata tal-unitajiet; il-kontenut jeħtieġ talba awtorizzata separata.

Eżempju: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Oqsma addizzjonali: Iva