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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Koder returneres som JSON, filer som binære data. Hver anmodning kræver Bearer og rettigheden reveal.

dataCodeContentData Obligatorisk: Indholdet af 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"}

Yderligere felter: Nej

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Kontrollér størrelse, kontrolsum og format. En klar upload betyder ikke, at leveringen er modtaget.

dataDigitalUploadData Obligatorisk: Indholdet af 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"}

Yderligere felter: Nej

ApiResponse[ImportData]

ApiResponse_ImportData_ · Kontrollér status, version og validering. Kladden tilhører den API-nøgle, der oprettede den.

dataImportData Obligatorisk: Indholdet af 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"}

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Læs indstillinger og antal før ændringer. Svaret indeholder ikke koder eller filindhold.

dataPoolData Obligatorisk: Indholdet af 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"}

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Læs højst 100 enheder pr. side. Listen viser metadata uden at afsløre koderne.

dataUnitsData Obligatorisk: Indholdet af 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"}

Yderligere felter: Nej

CodeContentData

CodeContentData · Koder returneres som JSON, filer som binære data. Hver anmodning kræver Bearer og rettigheden reveal.

codeStrengObligatorisk: Den nøjagtige digitale kode. Bevar store bogstaver og mellemrum inde i koden.

minLength: 1maxLength: 512

Eksempel: "DEMO-ONE"
delivery_idStreng nullValgfrit: ID for levering eller ordretildeling.

Streng:format: "uuid"

Eksempel: null
kindStrengValgfrit: Variant af datastrukturen beskrevet ved de tilladte værdier.

const: "code"

Standard: "code"Eksempel: "code"
payload_idStrengObligatorisk: Indholds-ID; ikke en offentlig downloadadresse.

format: "uuid"

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

format: "uuid"

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

Yderligere felter: Nej

DigitalUploadCreate

DigitalUploadCreate · Reservér plads til en fil, og knyt den til en import eller enheden, der skal erstattes.

consumer_idStrengObligatorisk

ID for tilknyttet import eller enhed.

format: "uuid"

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

consumer_kindStrengObligatorisk

Uploadens tilknytning: digital_import / digital_unit.

Begrænsninger

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.

Begrænsninger

enum: ["digital_unit", "digital_import"]

Eksempel: "digital_import"

sha256StrengObligatorisk

SHA-256 (hex, 64)

Begrænsninger

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

Eksempel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesHeltalObligatorisk

Størrelse i byte

minimum: 1maximum: 262144000

Eksempel: 18

Yderligere felter: Nej

DigitalUploadData

DigitalUploadData · Kontrollér størrelse, kontrolsum og format. En klar upload betyder ikke, at leveringen er modtaget.

consumer_idStrengObligatorisk

ID for tilknyttet import eller enhed.

format: "uuid"

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

consumer_kindStrengObligatorisk

Uploadens tilknytning: digital_import / digital_unit.

Begrænsninger

enum: ["digital_import", "digital_unit"]

Eksempel: "digital_import"

expires_atStrengObligatorisk

Udløbstidspunkt for denne upload eller import.

format: "date-time"

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

filenameStrengObligatorisk

Fil

Eksempel: "codes.txt"

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"

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

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

purposeStrengObligatorisk

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

Begrænsninger

enum: ["digital_unit", "digital_import"]

Eksempel: "digital_import"

received_bytesHeltalObligatorisk

Uploader… · Størrelse i byte

Eksempel: 18

sha256StrengObligatorisk

SHA-256 (hex, 64)

Eksempel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesHeltalObligatorisk

Størrelse i byte

Eksempel: 18

statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Eksempel: "ready"

Yderligere felter: Nej

ImportCommit

ImportCommit · Opret en planlagt eller modtaget levering fra det validerede parti. Planlagte enheder kan endnu ikke sælges.

delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

format: "date-time"

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

expected_delivery_versionHeltalObligatorisk

Leveringsversion; 0 ved ny levering.

minimum: 0maximum: 0

Eksempel: 0

expected_sales_limit_versionHeltal nullValgfrit

Version af salgsgrænsen; kræves ved publish_for_sale=true.

Heltal:minimum: 0maximum: 9223372036854775807

Eksempel: 0

expected_versionHeltalObligatorisk

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

minimum: 1maximum: 9223372036854775807

Eksempel: 2

location_idStrengObligatorisk

Identifikator for lagerplacering.

Begrænsninger

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

Eksempel: "location-digital"

publish_for_saleBoolesk værdiValgfrit

true øger også den begrænsede salgsgrænse; false ændrer den ikke.

Standard: falseEksempel: true

statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger

enum: ["planned", "received"]

Eksempel: "received"

validation_digestStrengObligatorisk

Valideringens kontrolsum; send uændret ved bekræftelse.

Begrænsninger

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

Eksempel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idStrengObligatorisk

Lageridentifikator.

Begrænsninger

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

Eksempel: "warehouse-main"

Yderligere felter: Nej

ImportCreate

ImportCreate · Opret en kladde med højst 1000 koder eller 100 filer. Det øger endnu ikke lageret til salg.

countHeltalObligatorisk

Præcist antal enheder i partiet.

minimum: 1maximum: 1000

Eksempel: 2

kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum: ["code", "file"]

Eksempel: "code"

Yderligere felter: Nej

ImportData

ImportData · Kontrollér status, version og validering. Kladden tilhører den API-nøgle, der oprettede den.

delivery_idStreng nullObligatorisk

ID for levering eller ordretildeling.

Eksempel: null

delivery_statusStreng nullObligatorisk

Leveringsstatus: planned / received; null før bekræftelse.

Eksempel: null

delivery_versionHeltal nullObligatorisk

Aktuel version af lagerleveringen.

Eksempel: null

expected_countHeltalObligatorisk

Forventet antal; kun hele partier accepteres.

Eksempel: 2

expires_atStrengObligatorisk

Udløbstidspunkt for denne upload eller import.

format: "date-time"

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

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"

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

kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum: ["code", "file"]

Eksempel: "code"

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Eksempel: "validated"

validated_countHeltalObligatorisk

Antal accepterede enheder ved sidste vellykkede validering.

Eksempel: 2

validation_digestStreng nullObligatorisk

Valideringens kontrolsum; send uændret ved bekræftelse.

Eksempel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 2

Yderligere felter: Nej

ImportReceive

ImportReceive · Modtag eksisterende enheder uden at importere deres koder eller filer igen.

expected_delivery_versionHeltalObligatorisk: Leveringsversion; 0 ved ny levering.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
expected_sales_limit_versionHeltal nullValgfrit: Version af salgsgrænsen; kræves ved publish_for_sale=true.

Heltal:minimum: 0maximum: 9223372036854775807
expected_versionHeltalObligatorisk: Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 3
publish_for_saleBoolesk værdiValgfrit: true øger også den begrænsede salgsgrænse; false ændrer den ikke.

Standard: false

Yderligere felter: Nej

ImportValidate

ImportValidate · Kontrollér hele partiet. Dubletter eller ugyldige poster afviser partiet; koder afkortes aldrig.

code_columnStreng nullValgfrit

CSV-kolonne med koder; brug code.

Streng:const: "code"

expected_versionHeltalObligatorisk

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

minimum: 1maximum: 9223372036854775807

Eksempel: 1

formatStreng nullValgfrit

Kodeliste: txt / csv; brug upload_ids til filer.

Begrænsninger · Streng 1

enum: ["txt", "csv"]

Eksempel: "txt"

source_upload_idStreng nullValgfrit

Klar privat TXT/CSV-upload til denne import.

Streng:format: "uuid"

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

upload_idsArray <Streng> nullValgfrit

1–100 klare private filuploads til denne import.

Array:minItems: 1maxItems: 100

Array / Array:format: "uuid"

Yderligere felter: Nej

ImportWithdrawal

ImportWithdrawal · Træk kun ledige enheder tilbage. Reserverede og tildelte enheder forbliver knyttet til deres ordrer.

expected_delivery_versionHeltalObligatorisk: Leveringsversion; 0 ved ny levering.

minimum: 1maximum: 9223372036854775807

Eksempel: 1
expected_order_versionHeltalObligatorisk: Version af tildelingsrækkefølgen, ikke kundeordren.

minimum: 0maximum: 9223372036854775807

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

minimum: 1maximum: 9223372036854775807

Eksempel: 3
reasonStrengObligatorisk: Registreret begrundelse for ændringen.

minLength: 1maxLength: 500

Eksempel: "Withdraw a revoked license"

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

PoolChange

PoolChange · Aktivér individuelle koder eller filer fra Professional. Deaktivering bevarer adgangen til tidligere køb.

email_modeStrengValgfrit

disabled: ingen e-mail; order_link: ordrelink; code_text: eventuelt også koder.

Begrænsninger

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

Standard: "disabled"Eksempel: "order_link"

enabledBoolesk værdiObligatorisk

Om denne indstilling er aktiveret.

Eksempel: true

expected_versionHeltalObligatorisk

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

minimum: 0maximum: 9223372036854775807

Eksempel: 0

retention_daysHeltal nullValgfrit

null: uden udløb; 1–3650 dage fra første adgang. Ingen automatisk sletning af koder.

Heltal:minimum: 1maximum: 3650

Eksempel: null

Yderligere felter: Nej

PoolCounts

PoolCounts · Læs indstillinger og antal før ændringer. Svaret indeholder ikke koder eller filindhold.

availableHeltalObligatorisk: Antal ledige enheder, som hverken er reserveret eller udleveret.

Eksempel: 1
heldHeltalObligatorisk: Enheder reserveret til ordrer, endnu ikke udleveret.

Eksempel: 0
issuedHeltalObligatorisk: Enheder allerede udleveret til betalte køb.

Eksempel: 1
plannedHeltalObligatorisk: Enheder i bekræftede, endnu ikke modtagne leveringer.

Eksempel: 0
retiredHeltalObligatorisk: Tilbagetrukne enheder, der bevares i historikken.

Eksempel: 0
stagedHeltalObligatorisk: Enheder i ufærdige importer, endnu ikke på lager.

Eksempel: 0

Yderligere felter: Nej

PoolData

PoolData · Læs indstillinger og antal før ændringer. Svaret indeholder ikke koder eller filindhold.

configuredBoolesk værdiObligatorisk

Om puljens indstillinger er gemt.

Eksempel: true

countsPoolCounts Obligatorisk

Antal enheder pr. lagerstatus.

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

email_modeStrengObligatorisk

disabled: ingen e-mail; order_link: ordrelink; code_text: eventuelt også koder.

Begrænsninger

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

Eksempel: "order_link"

enabledBoolesk værdiObligatorisk

Om denne indstilling er aktiveret.

Eksempel: true

order_versionHeltalObligatorisk

Version af puljens tildelingsrækkefølge.

Eksempel: 2

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

retention_daysHeltal nullObligatorisk

null: uden udløb; 1–3650 dage fra første adgang. Ingen automatisk sletning af koder.

Eksempel: null

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

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

UnitData

UnitData · Læs højst 100 enheder pr. side. Listen viser metadata uden at afsløre koderne.

content_stateStrengObligatorisk

Indholdsstatus: present / deleting / deleted.

Eksempel: "present"

delivery_idStreng nullObligatorisk

ID for levering eller ordretildeling.

Eksempel: "delivery-example"

filenameStreng nullObligatorisk

Fil

Eksempel: null

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"

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

issued_atStreng nullObligatorisk

Første udlevering; null før den.

Streng:format: "date-time"

Eksempel: null

kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum: ["file", "code"]

Eksempel: "code"

location_idStreng nullObligatorisk

Identifikator for lagerplacering.

Eksempel: "location-digital"

mime_typeStreng nullObligatorisk

Mediets indholdstype.

Eksempel: null

payload_idStrengObligatorisk

Indholds-ID; ikke en offentlig downloadadresse.

format: "uuid"

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

product_idStrengObligatorisk

Produktidentifikator.

Eksempel: "example"

size_bytesHeltal nullObligatorisk

Størrelse i byte

Eksempel: null

sort_orderHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1

stateStrengObligatorisk

Status

Eksempel: "available"

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

warehouse_idStreng nullObligatorisk

Lageridentifikator.

Eksempel: "warehouse-main"

Yderligere felter: Nej

UnitDeletion

UnitDeletion · Fjern en usolgt kode eller fil med en begrundelse. Reserverede eller tildelte enheder afvises.

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

minimum: 1

Eksempel: 1
reasonStrengObligatorisk: Registreret begrundelse for ændringen.

minLength: 1maxLength: 500

Eksempel: "Withdraw a revoked license"

Yderligere felter: Nej

UnitReorder

UnitReorder · Send hele den ufiltrerede side i den ønskede rækkefølge. En forældet version giver 409.

expected_order_versionHeltalObligatorisk: Version af tildelingsrækkefølgen, ikke kundeordren.

minimum: 1

Eksempel: 1
unit_idsArray <Streng> Obligatorisk: Alle enheder på den ufiltrerede side i ønsket rækkefølge.

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

Eksempel: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorStreng nullValgfrit: Cursor for den ufiltrerede side; null for den første.

Streng:maxLength: 1024

Yderligere felter: Nej

UnitReplacement

UnitReplacement · Erstat kode eller fil uden at ændre placeringen. Ændringen gemmes i lagerhistorikken.

codeStreng nullValgfrit: Den nøjagtige digitale kode. Bevar store bogstaver og mellemrum inde i koden.

Streng:minLength: 1maxLength: 512

Eksempel: "SYNTHETIC-REPLACEMENT"
expected_versionHeltalObligatorisk: Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1

Eksempel: 1
reasonStrengObligatorisk: Registreret begrundelse for ændringen.

minLength: 1maxLength: 500

Eksempel: "Replace an invalid activation code"
upload_idStreng nullValgfrit: Ressourceidentifikator; bevar den som returneret. · upload_id

Streng:format: "uuid"

Yderligere felter: Nej

UnitsData

UnitsData · Læs højst 100 enheder pr. side. Listen viser metadata uden at afsløre koderne.

order_versionHeltalObligatorisk: Version af puljens tildelingsrækkefølge.

Eksempel: 2
totalHeltalObligatorisk: Samlet beløb.

Eksempel: 1
unitsArray <UnitData > Obligatorisk: Enhedernes metadata; indhold kræver en særskilt autoriseret anmodning.

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"}]

Yderligere felter: Ja