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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Koder returneres som JSON, filer som binære data. Hver forespørsel krever Bearer og rettigheten reveal.

dataCodeContentData Obligatorisk: Innholdet i et vellykket svar.

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

Eksempel: {"request_id":"example-request"}

Ytterligere felt: Nei

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Kontroller størrelse, kontrollsum og format. En ferdig opplasting betyr ikke at leveringen er mottatt.

dataDigitalUploadData Obligatorisk: Innholdet i et vellykket svar.

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

Eksempel: {"request_id":"example-request"}

Ytterligere felt: Nei

ApiResponse[ImportData]

ApiResponse_ImportData_ · Kontroller status, versjon og validering. Utkastet tilhører API-nøkkelen som opprettet det.

dataImportData Obligatorisk: Innholdet i et vellykket svar.

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

Eksempel: {"request_id":"example-request"}

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Les innstillinger og antall før endringer. Svaret inneholder ikke koder eller filinnhold.

dataPoolData Obligatorisk: Innholdet i et vellykket svar.

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

Eksempel: {"request_id":"example-request"}

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Les høyst 100 enheter per side. Listen viser metadata uten å avsløre kodene.

dataUnitsData Obligatorisk: Innholdet i et vellykket svar.

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

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

Ytterligere felt: Nei

CodeContentData

CodeContentData · Koder returneres som JSON, filer som binære data. Hver forespørsel krever Bearer og rettigheten reveal.

codeStrengObligatorisk: Den nøyaktige digitale koden. Bevar store bokstaver og mellomrom inne i koden.

minLength: 1maxLength: 512

Eksempel: "DEMO-ONE"
delivery_idStreng nullValgfritt: ID for levering eller bestillingstildeling.

Streng:format: "uuid"

Eksempel: null
kindStrengValgfritt: Variant av datastrukturen beskrevet av de tillatte verdiene.

const: "code"

Standard: "code"Eksempel: "code"
payload_idStrengObligatorisk: Innholds-ID; ikke en offentlig nedlastingsadresse.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000004"
unit_idStrengObligatorisk: ID for én individuell kode eller fil.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000003"

Ytterligere felt: Nei

DigitalUploadCreate

DigitalUploadCreate · Reserver plass til en fil og knytt den til en import eller enheten som skal erstattes.

consumer_idStrengObligatorisk

ID for tilknyttet import eller enhet.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000001"

consumer_kindStrengObligatorisk

Opplastingens tilknytning: digital_import / digital_unit.

Begrensninger

enum: ["digital_import", "digital_unit"]

Eksempel: "digital_import"

filenameStrengObligatorisk

Fil

minLength: 1maxLength: 255

Eksempel: "codes.txt"

purposeStrengObligatorisk

digital_import: TXT/CSV; digital_unit: individuelt solgt fil.

Begrensninger

enum: ["digital_unit", "digital_import"]

Eksempel: "digital_import"

sha256StrengObligatorisk

SHA-256 (hex, 64)

Begrensninger

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

Eksempel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesHeltallObligatorisk

Størrelse i byte

minimum: 1maximum: 262144000

Eksempel: 18

Ytterligere felt: Nei

DigitalUploadData

DigitalUploadData · Kontroller størrelse, kontrollsum og format. En ferdig opplasting betyr ikke at leveringen er mottatt.

consumer_idStrengObligatorisk

ID for tilknyttet import eller enhet.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000001"

consumer_kindStrengObligatorisk

Opplastingens tilknytning: digital_import / digital_unit.

Begrensninger

enum: ["digital_import", "digital_unit"]

Eksempel: "digital_import"

expires_atStrengObligatorisk

Utløpstidspunkt for denne opplastingen eller importen.

format: "date-time"

Eksempel: "2026-11-03T13:00:00Z"

filenameStrengObligatorisk

Fil

Eksempel: "codes.txt"

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000002"

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

purposeStrengObligatorisk

digital_import: TXT/CSV; digital_unit: individuelt solgt fil.

Begrensninger

enum: ["digital_unit", "digital_import"]

Eksempel: "digital_import"

received_bytesHeltallObligatorisk

Laster opp… · Størrelse i byte

Eksempel: 18

sha256StrengObligatorisk

SHA-256 (hex, 64)

Eksempel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesHeltallObligatorisk

Størrelse i byte

Eksempel: 18

statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Eksempel: "ready"

Ytterligere felt: Nei

ImportCommit

ImportCommit · Opprett en planlagt eller mottatt levering fra det validerte partiet. Planlagte enheter kan ikke selges ennå.

delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

format: "date-time"

Eksempel: "2026-11-03T12:00:00Z"

expected_delivery_versionHeltallObligatorisk

Leveringsversjon; 0 ved ny levering.

minimum: 0maximum: 0

Eksempel: 0

expected_sales_limit_versionHeltall nullValgfritt

Versjon av salgsgrensen; kreves ved publish_for_sale=true.

Heltall:minimum: 0maximum: 9223372036854775807

Eksempel: 0

expected_versionHeltallObligatorisk

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

minimum: 1maximum: 9223372036854775807

Eksempel: 2

location_idStrengObligatorisk

Identifikator for lagerplassering.

Begrensninger

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

Eksempel: "location-digital"

publish_for_saleBoolsk verdiValgfritt

true øker også den begrensede salgsgrensen; false lar den stå.

Standard: falseEksempel: true

statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Begrensninger

enum: ["planned", "received"]

Eksempel: "received"

validation_digestStrengObligatorisk

Valideringens kontrollsum; send uendret ved bekreftelse.

Begrensninger

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

Eksempel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idStrengObligatorisk

Lageridentifikator.

Begrensninger

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

Eksempel: "warehouse-main"

Ytterligere felt: Nei

ImportCreate

ImportCreate · Lag et utkast med høyst 1000 koder eller 100 filer. Salgbar beholdning øker ikke ennå.

countHeltallObligatorisk

Nøyaktig antall enheter i partiet.

minimum: 1maximum: 1000

Eksempel: 2

kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum: ["code", "file"]

Eksempel: "code"

Ytterligere felt: Nei

ImportData

ImportData · Kontroller status, versjon og validering. Utkastet tilhører API-nøkkelen som opprettet det.

delivery_idStreng nullObligatorisk

ID for levering eller bestillingstildeling.

Eksempel: null

delivery_statusStreng nullObligatorisk

Leveringsstatus: planned / received; null før bekreftelse.

Eksempel: null

delivery_versionHeltall nullObligatorisk

Gjeldende versjon av lagerleveringen.

Eksempel: null

expected_countHeltallObligatorisk

Forventet antall; bare hele partier godtas.

Eksempel: 2

expires_atStrengObligatorisk

Utløpstidspunkt for denne opplastingen eller importen.

format: "date-time"

Eksempel: "2026-11-03T13:00:00Z"

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000001"

kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum: ["code", "file"]

Eksempel: "code"

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Eksempel: "validated"

validated_countHeltallObligatorisk

Antall godtatte enheter ved siste vellykkede validering.

Eksempel: 2

validation_digestStreng nullObligatorisk

Valideringens kontrollsum; send uendret ved bekreftelse.

Eksempel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 2

Ytterligere felt: Nei

ImportReceive

ImportReceive · Motta eksisterende enheter uten å importere kodene eller filene på nytt.

expected_delivery_versionHeltallObligatorisk: Leveringsversjon; 0 ved ny levering.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
expected_sales_limit_versionHeltall nullValgfritt: Versjon av salgsgrensen; kreves ved publish_for_sale=true.

Heltall:minimum: 0maximum: 9223372036854775807
expected_versionHeltallObligatorisk: Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 3
publish_for_saleBoolsk verdiValgfritt: true øker også den begrensede salgsgrensen; false lar den stå.

Standard: false

Ytterligere felt: Nei

ImportValidate

ImportValidate · Kontroller hele partiet. Duplikater eller ugyldige oppføringer avviser partiet; koder avkortes aldri.

code_columnStreng nullValgfritt

CSV-kolonne med koder; bruk code.

Streng:const: "code"

expected_versionHeltallObligatorisk

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

minimum: 1maximum: 9223372036854775807

Eksempel: 1

formatStreng nullValgfritt

Kodeliste: txt / csv; bruk upload_ids for filer.

Begrensninger · Streng 1

enum: ["txt", "csv"]

Eksempel: "txt"

source_upload_idStreng nullValgfritt

Klar privat TXT/CSV-opplasting til denne importen.

Streng:format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000002"

upload_idsArray <Streng> nullValgfritt

1–100 klare private filopplastinger til denne importen.

Array:minItems: 1maxItems: 100

Array / Array:format: "uuid"

Ytterligere felt: Nei

ImportWithdrawal

ImportWithdrawal · Trekk bare tilbake ledige enheter. Reserverte og tildelte enheter forblir knyttet til bestillingene.

expected_delivery_versionHeltallObligatorisk: Leveringsversjon; 0 ved ny levering.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
expected_order_versionHeltallObligatorisk: Versjon av tildelingsrekkefølgen, ikke kundebestillingen.

minimum: 0maximum: 9223372036854775807

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

minimum: 1maximum: 9223372036854775807

Eksempel: 3
reasonStrengObligatorisk: Registrert begrunnelse for endringen.

minLength: 1maxLength: 500

Eksempel: "Withdraw a revoked license"

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

PoolChange

PoolChange · Aktiver individuelle koder eller filer fra Professional. Deaktivering beholder tilgangen til tidligere kjøp.

email_modeStrengValgfritt

disabled: ingen e-post; order_link: bestillingslenke; code_text: eventuelt også koder.

Begrensninger

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

Standard: "disabled"Eksempel: "order_link"

enabledBoolsk verdiObligatorisk

Om denne innstillingen er aktivert.

Eksempel: true

expected_versionHeltallObligatorisk

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

minimum: 0maximum: 9223372036854775807

Eksempel: 0

retention_daysHeltall nullValgfritt

null: uten utløp; 1–3650 dager fra første tilgang. Ingen automatisk sletting av koder.

Heltall:minimum: 1maximum: 3650

Eksempel: null

Ytterligere felt: Nei

PoolCounts

PoolCounts · Les innstillinger og antall før endringer. Svaret inneholder ikke koder eller filinnhold.

availableHeltallObligatorisk: Antall ledige enheter som verken er reservert eller utlevert.

Eksempel: 1
heldHeltallObligatorisk: Enheter reservert for bestillinger, ennå ikke utlevert.

Eksempel: 0
issuedHeltallObligatorisk: Enheter allerede utlevert til betalte kjøp.

Eksempel: 1
plannedHeltallObligatorisk: Enheter i bekreftede, ennå ikke mottatte leveringer.

Eksempel: 0
retiredHeltallObligatorisk: Tilbaketrukne enheter som beholdes i historikken.

Eksempel: 0
stagedHeltallObligatorisk: Enheter i uferdige importer, ennå ikke på lager.

Eksempel: 0

Ytterligere felt: Nei

PoolData

PoolData · Les innstillinger og antall før endringer. Svaret inneholder ikke koder eller filinnhold.

configuredBoolsk verdiObligatorisk

Om innstillingene for beholdningen er lagret.

Eksempel: true

countsPoolCounts Obligatorisk

Antall enheter per lagerstatus.

Eksempel: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeStrengObligatorisk

disabled: ingen e-post; order_link: bestillingslenke; code_text: eventuelt også koder.

Begrensninger

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

Eksempel: "order_link"

enabledBoolsk verdiObligatorisk

Om denne innstillingen er aktivert.

Eksempel: true

order_versionHeltallObligatorisk

Versjon av beholdningens tildelingsrekkefølge.

Eksempel: 2

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

retention_daysHeltall nullObligatorisk

null: uten utløp; 1–3650 dager fra første tilgang. Ingen automatisk sletting av koder.

Eksempel: null

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

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

UnitData

UnitData · Les høyst 100 enheter per side. Listen viser metadata uten å avsløre kodene.

content_stateStrengObligatorisk

Innholdsstatus: present / deleting / deleted.

Eksempel: "present"

delivery_idStreng nullObligatorisk

ID for levering eller bestillingstildeling.

Eksempel: "delivery-example"

filenameStreng nullObligatorisk

Fil

Eksempel: null

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000003"

issued_atStreng nullObligatorisk

Første utlevering; null før den.

Streng:format: "date-time"

Eksempel: null

kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum: ["file", "code"]

Eksempel: "code"

location_idStreng nullObligatorisk

Identifikator for lagerplassering.

Eksempel: "location-digital"

mime_typeStreng nullObligatorisk

Mediets innholdstype.

Eksempel: null

payload_idStrengObligatorisk

Innholds-ID; ikke en offentlig nedlastingsadresse.

format: "uuid"

Eksempel: "00000000-0000-4000-8000-000000000004"

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

size_bytesHeltall nullObligatorisk

Størrelse i byte

Eksempel: null

sort_orderHeltallObligatorisk

Plassering i den sorterte samlingen.

Eksempel: 1

stateStrengObligatorisk

Status

Eksempel: "available"

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

warehouse_idStreng nullObligatorisk

Lageridentifikator.

Eksempel: "warehouse-main"

Ytterligere felt: Nei

UnitDeletion

UnitDeletion · Fjern en usolgt kode eller fil med begrunnelse. Reserverte eller tildelte enheter avvises.

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

minimum: 1

Eksempel: 1
reasonStrengObligatorisk: Registrert begrunnelse for endringen.

minLength: 1maxLength: 500

Eksempel: "Withdraw a revoked license"

Ytterligere felt: Nei

UnitReorder

UnitReorder · Send hele den ufiltrerte siden i ønsket rekkefølge. En utdatert versjon gir 409.

expected_order_versionHeltallObligatorisk: Versjon av tildelingsrekkefølgen, ikke kundebestillingen.

minimum: 1

Eksempel: 1
unit_idsArray <Streng> Obligatorisk: Alle enhetene på den ufiltrerte siden i ønsket rekkefølge.

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

Eksempel: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorStreng nullValgfritt: Markør for den ufiltrerte siden; null for den første.

Streng:maxLength: 1024

Ytterligere felt: Nei

UnitReplacement

UnitReplacement · Erstatt kode eller fil uten å endre plasseringen. Endringen lagres i lagerhistorikken.

codeStreng nullValgfritt: Den nøyaktige digitale koden. Bevar store bokstaver og mellomrom inne i koden.

Streng:minLength: 1maxLength: 512

Eksempel: "SYNTHETIC-REPLACEMENT"
expected_versionHeltallObligatorisk: Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1

Eksempel: 1
reasonStrengObligatorisk: Registrert begrunnelse for endringen.

minLength: 1maxLength: 500

Eksempel: "Replace an invalid activation code"
upload_idStreng nullValgfritt: Ressursidentifikator; behold den slik den returneres. · upload_id

Streng:format: "uuid"

Ytterligere felt: Nei

UnitsData

UnitsData · Les høyst 100 enheter per side. Listen viser metadata uten å avsløre kodene.

order_versionHeltallObligatorisk: Versjon av beholdningens tildelingsrekkefølge.

Eksempel: 2
totalHeltallObligatorisk: Samlet beløp.

Eksempel: 1
unitsArray <UnitData > Obligatorisk: Enhetenes metadata; innhold krever en separat autorisert forespørsel.

Eksempel: [{"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"}]

Ytterligere felt: Ja