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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Koder returneras som JSON, filer som binära data. Varje begäran kräver Bearer och behörigheten reveal.

dataCodeContentData Obligatoriskt: Innehållet i ett lyckat svar.

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

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

Ytterligare fält: Nej

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Kontrollera storlek, kontrollsumma och format. En klar uppladdning innebär inte att leveransen är mottagen.

dataDigitalUploadData Obligatoriskt: Innehållet i ett lyckat svar.

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

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

Ytterligare fält: Nej

ApiResponse[ImportData]

ApiResponse_ImportData_ · Kontrollera status, version och validering. Utkastet tillhör API-nyckeln som skapade det.

dataImportData Obligatoriskt: Innehållet i ett lyckat svar.

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

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

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Läs inställningar och antal före ändringar. Svaret innehåller inga koder eller filinnehåll.

dataPoolData Obligatoriskt: Innehållet i ett lyckat svar.

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

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

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Läs högst 100 enheter per sida. Listan visar metadata utan att avslöja koder.

dataUnitsData Obligatoriskt: Innehållet i ett lyckat svar.

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

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

Ytterligare fält: Nej

CodeContentData

CodeContentData · Koder returneras som JSON, filer som binära data. Varje begäran kräver Bearer och behörigheten reveal.

codeSträngObligatoriskt: Den exakta digitala koden. Bevara versaler och interna blanksteg.

minLength: 1maxLength: 512

Exempel: "DEMO-ONE"
delivery_idSträng nullValfritt: ID för leverans eller ordertilldelning.

Sträng:format: "uuid"

Exempel: null
kindSträngValfritt: Variant av datastrukturen, enligt dess tillåtna värden.

const: "code"

Standardvärde: "code"Exempel: "code"
payload_idSträngObligatoriskt: Innehålls-ID; ingen offentlig nedladdningsadress.

format: "uuid"

Exempel: "00000000-0000-4000-8000-000000000004"
unit_idSträngObligatoriskt: ID för en individuell kod eller fil.

format: "uuid"

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

Ytterligare fält: Nej

DigitalUploadCreate

DigitalUploadCreate · Reservera utrymme för en fil och koppla den till en import eller enheten som ska ersättas.

consumer_idSträngObligatoriskt

ID för kopplad import eller enhet.

format: "uuid"

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

consumer_kindSträngObligatoriskt

Uppladdningens koppling: digital_import / digital_unit.

Begränsningar

enum: ["digital_import", "digital_unit"]

Exempel: "digital_import"

filenameSträngObligatoriskt

Fil

minLength: 1maxLength: 255

Exempel: "codes.txt"

purposeSträngObligatoriskt

digital_import: TXT/CSV; digital_unit: individuellt såld fil.

Begränsningar

enum: ["digital_unit", "digital_import"]

Exempel: "digital_import"

sha256SträngObligatoriskt

SHA-256 (hex, 64)

Begränsningar

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

Exempel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesHeltalObligatoriskt

Storlek i byte

minimum: 1maximum: 262144000

Exempel: 18

Ytterligare fält: Nej

DigitalUploadData

DigitalUploadData · Kontrollera storlek, kontrollsumma och format. En klar uppladdning innebär inte att leveransen är mottagen.

consumer_idSträngObligatoriskt

ID för kopplad import eller enhet.

format: "uuid"

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

consumer_kindSträngObligatoriskt

Uppladdningens koppling: digital_import / digital_unit.

Begränsningar

enum: ["digital_import", "digital_unit"]

Exempel: "digital_import"

expires_atSträngObligatoriskt

Utgångstid för denna uppladdning eller import.

format: "date-time"

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

filenameSträngObligatoriskt

Fil

Exempel: "codes.txt"

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

format: "uuid"

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

product_idSträngObligatoriskt

Produktens identifierare.

Exempel: "example"

purposeSträngObligatoriskt

digital_import: TXT/CSV; digital_unit: individuellt såld fil.

Begränsningar

enum: ["digital_unit", "digital_import"]

Exempel: "digital_import"

received_bytesHeltalObligatoriskt

Laddar upp… · Storlek i byte

Exempel: 18

sha256SträngObligatoriskt

SHA-256 (hex, 64)

Exempel: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesHeltalObligatoriskt

Storlek i byte

Exempel: 18

statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Exempel: "ready"

Ytterligare fält: Nej

ImportCommit

ImportCommit · Skapa en planerad eller mottagen leverans av det validerade partiet. Planerade enheter kan inte säljas ännu.

delivered_atSträngObligatoriskt

Datum och tid för leverans.

format: "date-time"

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

expected_delivery_versionHeltalObligatoriskt

Leveransversion; 0 för en ny leverans.

minimum: 0maximum: 0

Exempel: 0

expected_sales_limit_versionHeltal nullValfritt

Version av försäljningsgränsen; krävs vid publish_for_sale=true.

Heltal:minimum: 0maximum: 9223372036854775807

Exempel: 0

expected_versionHeltalObligatoriskt

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

minimum: 1maximum: 9223372036854775807

Exempel: 2

location_idSträngObligatoriskt

Lagerplatsens identifierare.

Begränsningar

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

Exempel: "location-digital"

publish_for_saleBooleskt värdeValfritt

true ökar även den ändliga försäljningsgränsen; false lämnar den oförändrad.

Standardvärde: falseExempel: true

statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Begränsningar

enum: ["planned", "received"]

Exempel: "received"

validation_digestSträngObligatoriskt

Valideringens kontrollsumma; skicka oförändrad vid bekräftelse.

Begränsningar

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

Exempel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idSträngObligatoriskt

Lagrets identifierare.

Begränsningar

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

Exempel: "warehouse-main"

Ytterligare fält: Nej

ImportCreate

ImportCreate · Skapa ett utkast med högst 1000 koder eller 100 filer. Det ökar ännu inte det säljbara lagret.

countHeltalObligatoriskt

Exakt antal enheter i partiet.

minimum: 1maximum: 1000

Exempel: 2

kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum: ["code", "file"]

Exempel: "code"

Ytterligare fält: Nej

ImportData

ImportData · Kontrollera status, version och validering. Utkastet tillhör API-nyckeln som skapade det.

delivery_idSträng nullObligatoriskt

ID för leverans eller ordertilldelning.

Exempel: null

delivery_statusSträng nullObligatoriskt

Leveransstatus: planned / received; null före bekräftelse.

Exempel: null

delivery_versionHeltal nullObligatoriskt

Aktuell version av lagerleveransen.

Exempel: null

expected_countHeltalObligatoriskt

Förväntat antal; endast hela partier godtas.

Exempel: 2

expires_atSträngObligatoriskt

Utgångstid för denna uppladdning eller import.

format: "date-time"

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

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

format: "uuid"

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

kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum: ["code", "file"]

Exempel: "code"

product_idSträngObligatoriskt

Produktens identifierare.

Exempel: "example"

statusSträngObligatoriskt

Status som accepteras av den aktuella operationen.

Exempel: "validated"

validated_countHeltalObligatoriskt

Antal godkända enheter i senaste lyckade valideringen.

Exempel: 2

validation_digestSträng nullObligatoriskt

Valideringens kontrollsumma; skicka oförändrad vid bekräftelse.

Exempel: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 2

Ytterligare fält: Nej

ImportReceive

ImportReceive · Ta emot befintliga enheter utan att importera koder eller filer igen.

expected_delivery_versionHeltalObligatoriskt: Leveransversion; 0 för en ny leverans.

minimum: 1maximum: 9223372036854775807

Exempel: 1
expected_sales_limit_versionHeltal nullValfritt: Version av försäljningsgränsen; krävs vid publish_for_sale=true.

Heltal:minimum: 0maximum: 9223372036854775807
expected_versionHeltalObligatoriskt: Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 3
publish_for_saleBooleskt värdeValfritt: true ökar även den ändliga försäljningsgränsen; false lämnar den oförändrad.

Standardvärde: false

Ytterligare fält: Nej

ImportValidate

ImportValidate · Kontrollera hela partiet. Dubbletter eller ogiltiga poster avvisar partiet; koder kapas aldrig.

code_columnSträng nullValfritt

CSV-kolumn med koder; använd code.

Sträng:const: "code"

expected_versionHeltalObligatoriskt

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

minimum: 1maximum: 9223372036854775807

Exempel: 1

formatSträng nullValfritt

Kodlista: txt / csv; använd upload_ids för filer.

Begränsningar · Sträng 1

enum: ["txt", "csv"]

Exempel: "txt"

source_upload_idSträng nullValfritt

Klar privat TXT/CSV-uppladdning för denna import.

Sträng:format: "uuid"

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

upload_idsArray <Sträng> nullValfritt

1–100 klara privata filuppladdningar för denna import.

Array:minItems: 1maxItems: 100

Array / Array:format: "uuid"

Ytterligare fält: Nej

ImportWithdrawal

ImportWithdrawal · Dra bara tillbaka lediga enheter. Reserverade och tilldelade enheter förblir kopplade till beställningarna.

expected_delivery_versionHeltalObligatoriskt: Leveransversion; 0 för en ny leverans.

minimum: 1maximum: 9223372036854775807

Exempel: 1
expected_order_versionHeltalObligatoriskt: Version av tilldelningsordningen, inte kundbeställningen.

minimum: 0maximum: 9223372036854775807

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

minimum: 1maximum: 9223372036854775807

Exempel: 3
reasonSträngObligatoriskt: Registrerad orsak till ändringen.

minLength: 1maxLength: 500

Exempel: "Withdraw a revoked license"

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

PoolChange

PoolChange · Aktivera individuella koder eller filer från Professional. Avstängning behåller åtkomsten till tidigare köp.

email_modeSträngValfritt

disabled: ingen e-post; order_link: orderlänk; code_text: även koder kan ingå.

Begränsningar

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

Standardvärde: "disabled"Exempel: "order_link"

enabledBooleskt värdeObligatoriskt

Anger om inställningen är aktiverad.

Exempel: true

expected_versionHeltalObligatoriskt

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

minimum: 0maximum: 9223372036854775807

Exempel: 0

retention_daysHeltal nullValfritt

null: utan slutdatum; 1–3650 dagar från första åtkomst. Koder raderas inte automatiskt.

Heltal:minimum: 1maximum: 3650

Exempel: null

Ytterligare fält: Nej

PoolCounts

PoolCounts · Läs inställningar och antal före ändringar. Svaret innehåller inga koder eller filinnehåll.

availableHeltalObligatoriskt: Antal lediga enheter som varken är reserverade eller utlämnade.

Exempel: 1
heldHeltalObligatoriskt: Enheter reserverade för beställningar, ännu inte utlämnade.

Exempel: 0
issuedHeltalObligatoriskt: Enheter som redan lämnats ut för betalda köp.

Exempel: 1
plannedHeltalObligatoriskt: Enheter i bekräftade leveranser som ännu inte tagits emot.

Exempel: 0
retiredHeltalObligatoriskt: Indragna enheter som behålls i historiken.

Exempel: 0
stagedHeltalObligatoriskt: Enheter i ofärdiga importer, ännu inte i lager.

Exempel: 0

Ytterligare fält: Nej

PoolData

PoolData · Läs inställningar och antal före ändringar. Svaret innehåller inga koder eller filinnehåll.

configuredBooleskt värdeObligatoriskt

Om inställningarna för det digitala lagret har sparats.

Exempel: true

countsPoolCounts Obligatoriskt

Antal enheter per lagerstatus.

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

email_modeSträngObligatoriskt

disabled: ingen e-post; order_link: orderlänk; code_text: även koder kan ingå.

Begränsningar

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

Exempel: "order_link"

enabledBooleskt värdeObligatoriskt

Anger om inställningen är aktiverad.

Exempel: true

order_versionHeltalObligatoriskt

Version av lagrets tilldelningsordning.

Exempel: 2

product_idSträngObligatoriskt

Produktens identifierare.

Exempel: "example"

retention_daysHeltal nullObligatoriskt

null: utan slutdatum; 1–3650 dagar från första åtkomst. Koder raderas inte automatiskt.

Exempel: null

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

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

UnitData

UnitData · Läs högst 100 enheter per sida. Listan visar metadata utan att avslöja koder.

content_stateSträngObligatoriskt

Innehållsstatus: present / deleting / deleted.

Exempel: "present"

delivery_idSträng nullObligatoriskt

ID för leverans eller ordertilldelning.

Exempel: "delivery-example"

filenameSträng nullObligatoriskt

Fil

Exempel: null

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

format: "uuid"

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

issued_atSträng nullObligatoriskt

Första utlämning; null före den.

Sträng:format: "date-time"

Exempel: null

kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum: ["file", "code"]

Exempel: "code"

location_idSträng nullObligatoriskt

Lagerplatsens identifierare.

Exempel: "location-digital"

mime_typeSträng nullObligatoriskt

Medieinnehållets typ.

Exempel: null

payload_idSträngObligatoriskt

Innehålls-ID; ingen offentlig nedladdningsadress.

format: "uuid"

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

product_idSträngObligatoriskt

Produktens identifierare.

Exempel: "example"

size_bytesHeltal nullObligatoriskt

Storlek i byte

Exempel: null

sort_orderHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 1

stateSträngObligatoriskt

Status

Exempel: "available"

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

warehouse_idSträng nullObligatoriskt

Lagrets identifierare.

Exempel: "warehouse-main"

Ytterligare fält: Nej

UnitDeletion

UnitDeletion · Ta bort en osåld kod eller fil med motivering. Reserverade eller tilldelade enheter avvisas.

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

minimum: 1

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

minLength: 1maxLength: 500

Exempel: "Withdraw a revoked license"

Ytterligare fält: Nej

UnitReorder

UnitReorder · Skicka hela den ofiltrerade sidan i önskad ordning. En inaktuell version ger 409.

expected_order_versionHeltalObligatoriskt: Version av tilldelningsordningen, inte kundbeställningen.

minimum: 1

Exempel: 1
unit_idsArray <Sträng> Obligatoriskt: Alla enheter på den ofiltrerade sidan i önskad ordning.

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

Exempel: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorSträng nullValfritt: Markör för den ofiltrerade sidan; null för den första.

Sträng:maxLength: 1024

Ytterligare fält: Nej

UnitReplacement

UnitReplacement · Ersätt kod eller fil utan att ändra placeringen. Ändringen sparas i lagerhistoriken.

codeSträng nullValfritt: Den exakta digitala koden. Bevara versaler och interna blanksteg.

Sträng:minLength: 1maxLength: 512

Exempel: "SYNTHETIC-REPLACEMENT"
expected_versionHeltalObligatoriskt: Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1

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

minLength: 1maxLength: 500

Exempel: "Replace an invalid activation code"
upload_idSträng nullValfritt: Resursens identifierare; bevara den som den returneras. · upload_id

Sträng:format: "uuid"

Ytterligare fält: Nej

UnitsData

UnitsData · Läs högst 100 enheter per sida. Listan visar metadata utan att avslöja koder.

order_versionHeltalObligatoriskt: Version av lagrets tilldelningsordning.

Exempel: 2
totalHeltalObligatoriskt: Totalbelopp.

Exempel: 1
unitsArray <UnitData > Obligatoriskt: Enheternas metadata; innehåll kräver en separat behörig begäran.

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

Ytterligare fält: Ja