Datu shēmas: Krājumi

location_codeVirkneObligāts

Noliktavas atrašanās vietas kods.

Piemērs: "example"

location_idVirkneObligāts

Noliktavas atrašanās vietas identifikators.

Piemērs: "example"

location_nameVirkneObligāts

Noliktavas atrašanās vietas nosaukums.

Piemērs: "example"

on_handVesels skaitlisObligāts

Fiziskais krājumu daudzums.

Piemērs: 10

Papildu lauki: Nē

dataCodeContentData Obligāts

Veiksmīgas atbildes dati.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example-request"}

Papildu lauki: Nē

dataDigitalUploadData Obligāts

Veiksmīgas atbildes dati.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example-request"}

Papildu lauki: Nē

dataImportData Obligāts

Veiksmīgas atbildes dati.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example-request"}

Papildu lauki: Nē

dataMasīvs <StockData > Obligāts

Atbildes piemērs · ApiResponse_list_StockData__.

Piemērs: [{"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 Obligāts

Atbildes metadati.

Piemērs: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

dataPoolData Obligāts

Veiksmīgas atbildes dati.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example-request"}

Papildu lauki: Nē

dataStockDetailData Obligāts

Atbildes piemērs · StockDetailData.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example"}

Papildu lauki: Nē

dataUnitsData Obligāts

Veiksmīgas atbildes dati.

Piemērs: {"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 Obligāts

Atbildes metadati.

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

Papildu lauki: Nē

codeVirkneObligāts

Precīzs digitālā koda teksts. Saglabājiet burtu reģistru un iekšējās atstarpes.

minLength: 1maxLength: 512

Piemērs: "DEMO-ONE"

delivery_idVirkne | nullNeobligāts

Piegādes vai pasūtījuma piešķīruma ID.

Virkne:format: "uuid"

Piemērs: null

kindVirkneNeobligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

const: "code"

Noklusējums: "code"Piemērs: "code"

payload_idVirkneObligāts

Satura ID; nav publiska lejupielādes adrese.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000004"

unit_idVirkneObligāts

Viena individuāla koda vai faila ID.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000003"

Papildu lauki: Nē

consumer_idVirkneObligāts

Saistītā importa vai vienības ID.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000001"

consumer_kindVirkneObligāts

Augšupielādes saistība: digital_import / digital_unit.

Ierobežojumi

enum

["digital_import", "digital_unit"]

Piemērs: "digital_import"

filenameVirkneObligāts

Fails

minLength: 1maxLength: 255

Piemērs: "codes.txt"

purposeVirkneObligāts

digital_import: TXT/CSV; digital_unit: atsevišķi pārdodams fails.

Ierobežojumi

enum

["digital_unit", "digital_import"]

Piemērs: "digital_import"

sha256VirkneObligāts

SHA-256 (hex, 64)

Ierobežojumi

pattern

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

Piemērs: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesVesels skaitlisObligāts

Izmērs baitos

minimum: 1maximum: 262144000

Piemērs: 18

Papildu lauki: Nē

consumer_idVirkneObligāts

Saistītā importa vai vienības ID.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000001"

consumer_kindVirkneObligāts

Augšupielādes saistība: digital_import / digital_unit.

Ierobežojumi

enum

["digital_import", "digital_unit"]

Piemērs: "digital_import"

expires_atVirkneObligāts

Šīs augšupielādes vai importa derīguma termiņš.

format: "date-time"

Piemērs: "2026-11-03T13:00:00Z"

filenameVirkneObligāts

Fails

Piemērs: "codes.txt"

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000002"

product_idVirkneObligāts

Produkta identifikators.

Piemērs: "example"

purposeVirkneObligāts

digital_import: TXT/CSV; digital_unit: atsevišķi pārdodams fails.

Ierobežojumi

enum

["digital_unit", "digital_import"]

Piemērs: "digital_import"

received_bytesVesels skaitlisObligāts

Augšupielāde… · Izmērs baitos

Piemērs: 18

sha256VirkneObligāts

SHA-256 (hex, 64)

Piemērs: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesVesels skaitlisObligāts

Izmērs baitos

Piemērs: 18

statusVirkneObligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: "ready"

Papildu lauki: Nē

delivered_atVirkneObligāts

Piegādes datums un laiks.

format: "date-time"

Piemērs: "2026-11-03T12:00:00Z"

expected_delivery_versionVesels skaitlisObligāts

Piegādes versija; jaunai piegādei 0.

minimum: 0maximum: 0

Piemērs: 0

expected_sales_limit_versionVesels skaitlis | nullNeobligāts

Pārdošanas limita versija; vajadzīga ar publish_for_sale=true.

Vesels skaitlis:minimum: 0maximum: 9223372036854775807

Piemērs: 0

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 2

location_idVirkneObligāts

Noliktavas atrašanās vietas identifikators.

Ierobežojumi

pattern

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

Piemērs: "location-digital"

publish_for_saleLoģiska vērtībaNeobligāts

true palielina arī galīgu pārdošanas limitu; false to nemaina.

Noklusējums: falsePiemērs: true

statusVirkneObligāts

Šai konkrētajai darbībai pieņemamais statuss.

Ierobežojumi

enum

["planned", "received"]

Piemērs: "received"

validation_digestVirkneObligāts

Pārbaudes kontrolsumma; apstiprināšanā nosūtiet nemainītu.

Ierobežojumi

pattern

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

Piemērs: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idVirkneObligāts

Noliktavas identifikators.

Ierobežojumi

pattern

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

Piemērs: "warehouse-main"

Papildu lauki: Nē

countVesels skaitlisObligāts

Precīzs vienību skaits partijā.

minimum: 1maximum: 1000

Piemērs: 2

kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["code", "file"]

Piemērs: "code"

Papildu lauki: Nē

delivery_idVirkne | nullObligāts

Piegādes vai pasūtījuma piešķīruma ID.

Piemērs: null

delivery_statusVirkne | nullObligāts

Piegādes statuss: planned / received; pirms apstiprināšanas null.

Piemērs: null

delivery_versionVesels skaitlis | nullObligāts

Pašreizējā noliktavas piegādes versija.

Piemērs: null

expected_countVesels skaitlisObligāts

Paredzētais skaits; tiek pieņemta tikai pilna partija.

Piemērs: 2

expires_atVirkneObligāts

Šīs augšupielādes vai importa derīguma termiņš.

format: "date-time"

Piemērs: "2026-11-03T13:00:00Z"

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000001"

kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["code", "file"]

Piemērs: "code"

product_idVirkneObligāts

Produkta identifikators.

Piemērs: "example"

statusVirkneObligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: "validated"

validated_countVesels skaitlisObligāts

Pēdējā sekmīgajā pārbaudē pieņemto vienību skaits.

Piemērs: 2

validation_digestVirkne | nullObligāts

Pārbaudes kontrolsumma; apstiprināšanā nosūtiet nemainītu.

Piemērs: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 2

Papildu lauki: Nē

expected_delivery_versionVesels skaitlisObligāts

Piegādes versija; jaunai piegādei 0.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

expected_sales_limit_versionVesels skaitlis | nullNeobligāts

Pārdošanas limita versija; vajadzīga ar publish_for_sale=true.

Vesels skaitlis:minimum: 0maximum: 9223372036854775807

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 3

publish_for_saleLoģiska vērtībaNeobligāts

true palielina arī galīgu pārdošanas limitu; false to nemaina.

Noklusējums: false

Papildu lauki: Nē

code_columnVirkne | nullNeobligāts

CSV kolonna ar kodiem; izmantojiet code.

Virkne:const: "code"

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

formatVirkne | nullNeobligāts

Kodu saraksts: txt / csv; failiem izmantojiet upload_ids.

Ierobežojumi · Virkne 1

enum

["txt", "csv"]

Piemērs: "txt"

source_upload_idVirkne | nullNeobligāts

Šī importa gatava privāta TXT/CSV augšupielāde.

Virkne:format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000002"

upload_idsMasīvs <Virkne> | nullNeobligāts

1–100 šī importa gatavas privātas failu augšupielādes.

Masīvs:minItems: 1maxItems: 100

Masīvs / Masīvs:format: "uuid"

Papildu lauki: Nē

expected_delivery_versionVesels skaitlisObligāts

Piegādes versija; jaunai piegādei 0.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

expected_order_versionVesels skaitlisObligāts

Piešķiršanas secības versija, nevis klienta pasūtījuma versija.

minimum: 0maximum: 9223372036854775807

Piemērs: 1

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 3

reasonVirkneObligāts

Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500

Piemērs: "Withdraw a revoked license"

Papildu lauki: Nē

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

manual_reservedVesels skaitlisObligāts

Manuāli rezervētais daudzums.

minimum: 0maximum: 2147483647

Piemērs: 1

reasonVirkneNeobligāts

Reģistrētais izmaiņas iemesls.

maxLength: 500

Noklusējums: ""

Papildu lauki: Nē

email_modeVirkneNeobligāts

disabled: bez e-pasta; order_link: saite uz pasūtījumu; code_text: iespējami arī kodi.

Ierobežojumi

enum

["disabled", "order_link", "code_text"]

Noklusējums: "disabled"Piemērs: "order_link"

enabledLoģiska vērtībaObligāts

Vai šis iestatījums ir ieslēgts.

Piemērs: true

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 0maximum: 9223372036854775807

Piemērs: 0

retention_daysVesels skaitlis | nullNeobligāts

null: bez termiņa; 1–3650 dienas no pirmās piekļuves. Kodi netiek dzēsti automātiski.

Vesels skaitlis:minimum: 1maximum: 3650

Piemērs: null

Papildu lauki: Nē

availableVesels skaitlisObligāts

Brīvo vienību skaits; tās nav rezervētas vai izsniegtas.

Piemērs: 1

heldVesels skaitlisObligāts

Pasūtījumiem rezervētas, vēl neizsniegtas vienības.

Piemērs: 0

issuedVesels skaitlisObligāts

Apmaksātiem pirkumiem jau izsniegtas vienības.

Piemērs: 1

plannedVesels skaitlisObligāts

Apstiprinātu, vēl nesaņemtu piegāžu vienības.

Piemērs: 0

retiredVesels skaitlisObligāts

Atsauktas vienības, kas saglabātas vēsturē.

Piemērs: 0

stagedVesels skaitlisObligāts

Nepabeigtu importu vienības, vēl nav noliktavas krājumā.

Piemērs: 0

Papildu lauki: Nē

configuredLoģiska vērtībaObligāts

Vai digitālā krājuma iestatījumi ir saglabāti.

Piemērs: true

countsPoolCounts Obligāts

Vienību skaits pēc krājuma stāvokļa.

Piemērs: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeVirkneObligāts

disabled: bez e-pasta; order_link: saite uz pasūtījumu; code_text: iespējami arī kodi.

Ierobežojumi

enum

["disabled", "order_link", "code_text"]

Piemērs: "order_link"

enabledLoģiska vērtībaObligāts

Vai šis iestatījums ir ieslēgts.

Piemērs: true

order_versionVesels skaitlisObligāts

Krājuma piešķiršanas secības versija.

Piemērs: 2

product_idVirkneObligāts

Produkta identifikators.

Piemērs: "example"

retention_daysVesels skaitlis | nullObligāts

null: bez termiņa; 1–3650 dienas no pirmās piekļuves. Kodi netiek dzēsti automātiski.

Piemērs: null

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

reasonVirkneNeobligāts

Reģistrētais izmaiņas iemesls.

maxLength: 500

Noklusējums: ""

sellable_limitVesels skaitlisObligāts

Pārdošanas limits: -1 nozīmē neierobežotu daudzumu, 0 atspējo pārdošanu.

minimum: -1maximum: 2147483647

Piemērs: 1

Papildu lauki: Nē

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 0maximum: 9223372036854775807

Piemērs: 0

locationsMasīvs <LocationQuantity > Obligāts

Noliktavas atrašanās vietas.

minItems: 1maxItems: 100

Piemērs: [{"location_id":"example","on_hand":1}]

reasonVirkneObligāts

Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500

Piemērs: "Example"

target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Ierobežojumi

pattern

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

Piemērs: "example"

target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi

enum

["product", "variant"]

Piemērs: "product"

warehouse_idVirkneObligāts

Noliktavas identifikators.

Ierobežojumi

pattern

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

Piemērs: "example"

Papildu lauki: Nē

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

locationsMasīvs <LocationQuantity > Obligāts

Noliktavas atrašanās vietas.

minItems: 1maxItems: 100

Piemērs: [{"location_id":"example","on_hand":1}]

reasonVirkneObligāts

Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500

Piemērs: "Example"

Papildu lauki: Nē

activeLoģiska vērtībaObligāts

Vai resurss ir aktīvs.

Piemērs: true

availableVesels skaitlis | nullObligāts

Pārdošanai pieejamais daudzums; null nozīmē neierobežotu daudzumu.

Piemērs: 5

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (StockData).

Piemērs: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedVesels skaitlisObligāts

Manuāli rezervētais daudzums.

Piemērs: 2

on_handVesels skaitlisObligāts

Fiziskais krājumu daudzums.

Piemērs: 10

reservedVesels skaitlisObligāts

Ar pasūtījumiem rezervētais daudzums.

Piemērs: 3

sellable_limitVesels skaitlisObligāts

Pārdošanas limits: -1 nozīmē neierobežotu daudzumu, 0 atspējo pārdošanu.

Piemērs: 10

target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Piemērs: "example"

target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi

enum

["product", "variant"]

Piemērs: "product"

total_reservedVesels skaitlisObligāts

Kopējais rezervētais daudzums.

Piemērs: 5

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

warehouse_idVirkneObligāts

Noliktavas identifikators.

Piemērs: "example"

Papildu lauki: Nē

activeLoģiska vērtībaObligāts

Vai resurss ir aktīvs.

Piemērs: true

allocationsMasīvs <AllocationData > Obligāts

Noliktavas atrašanās vietām piešķirtie daudzumi.

Piemērs: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableVesels skaitlis | nullObligāts

Pārdošanai pieejamais daudzums; null nozīmē neierobežotu daudzumu.

Piemērs: 5

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (StockDetailData).

Piemērs: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedVesels skaitlisObligāts

Manuāli rezervētais daudzums.

Piemērs: 2

on_handVesels skaitlisObligāts

Fiziskais krājumu daudzums.

Piemērs: 10

reservedVesels skaitlisObligāts

Ar pasūtījumiem rezervētais daudzums.

Piemērs: 3

sellable_limitVesels skaitlisObligāts

Pārdošanas limits: -1 nozīmē neierobežotu daudzumu, 0 atspējo pārdošanu.

Piemērs: 10

target_idVirkneObligāts

Darbības ietekmētā produkta vai varianta identifikators.

Piemērs: "example"

target_typeVirkneObligāts

Vai darbība attiecas uz produktu vai variantu.

Ierobežojumi

enum

["product", "variant"]

Piemērs: "product"

total_reservedVesels skaitlisObligāts

Kopējais rezervētais daudzums.

Piemērs: 5

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

warehouse_idVirkneObligāts

Noliktavas identifikators.

Piemērs: "example"

Papildu lauki: Nē

content_stateVirkneObligāts

Satura stāvoklis: present / deleting / deleted.

Piemērs: "present"

delivery_idVirkne | nullObligāts

Piegādes vai pasūtījuma piešķīruma ID.

Piemērs: "delivery-example"

filenameVirkne | nullObligāts

Fails

Piemērs: null

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000003"

issued_atVirkne | nullObligāts

Pirmā izsniegšana; pirms tās null.

Virkne:format: "date-time"

Piemērs: null

kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["file", "code"]

Piemērs: "code"

location_idVirkne | nullObligāts

Noliktavas atrašanās vietas identifikators.

Piemērs: "location-digital"

mime_typeVirkne | nullObligāts

Multivides satura tips.

Piemērs: null

payload_idVirkneObligāts

Satura ID; nav publiska lejupielādes adrese.

format: "uuid"

Piemērs: "00000000-0000-4000-8000-000000000004"

product_idVirkneObligāts

Produkta identifikators.

Piemērs: "example"

size_bytesVesels skaitlis | nullObligāts

Izmērs baitos

Piemērs: null

sort_orderVesels skaitlisObligāts

Pozīcija sakārtotā kolekcijā.

Piemērs: 1

stateVirkneObligāts

Statuss

Piemērs: "available"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

warehouse_idVirkne | nullObligāts

Noliktavas identifikators.

Piemērs: "warehouse-main"

Papildu lauki: Nē

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1

Piemērs: 1

reasonVirkneObligāts

Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500

Piemērs: "Withdraw a revoked license"

Papildu lauki: Nē

expected_order_versionVesels skaitlisObligāts

Piešķiršanas secības versija, nevis klienta pasūtījuma versija.

minimum: 1

Piemērs: 1

unit_idsMasīvs <Virkne> Obligāts

Visas nefiltrētās lapas vienības vēlamajā secībā.

minItems: 2maxItems: 100

Masīvs:format: "uuid"

Piemērs: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursorVirkne | nullNeobligāts

Nefiltrētās lapas kursors; pirmajai lapai null.

Virkne:maxLength: 1024

Papildu lauki: Nē

codeVirkne | nullNeobligāts

Precīzs digitālā koda teksts. Saglabājiet burtu reģistru un iekšējās atstarpes.

Virkne:minLength: 1maxLength: 512

Piemērs: "SYNTHETIC-REPLACEMENT"

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1

Piemērs: 1

reasonVirkneObligāts

Reģistrētais izmaiņas iemesls.

minLength: 1maxLength: 500

Piemērs: "Replace an invalid activation code"

upload_idVirkne | nullNeobligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. · upload_id

Virkne:format: "uuid"

Papildu lauki: Nē

order_versionVesels skaitlisObligāts

Krājuma piešķiršanas secības versija.

Piemērs: 2

totalVesels skaitlisObligāts

Kopējā summa.

Piemērs: 1

unitsMasīvs <UnitData > Obligāts

Vienību metadati; saturam vajag atsevišķu autorizētu pieprasījumu.

Piemērs: [{"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"}]

Papildu lauki: Jā