Gegevensschema’s: Voorraad

location_codeTekenreeksVerplicht

Code van de magazijnlocatie.

Voorbeeld: "example"

location_idTekenreeksVerplicht

Identificatie van de magazijnlocatie.

Voorbeeld: "example"

location_nameTekenreeksVerplicht

Naam van de magazijnlocatie.

Voorbeeld: "example"

on_handGeheel getalVerplicht

Fysiek aanwezige voorraad.

Voorbeeld: 10

Aanvullende velden: Nee

dataCodeContentData Verplicht

Gegevens van een geslaagd antwoord.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

dataDigitalUploadData Verplicht

Gegevens van een geslaagd antwoord.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

dataImportData Verplicht

Gegevens van een geslaagd antwoord.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

dataArray <StockData > Verplicht

Voorbeeldantwoord · ApiResponse_list_StockData__.

Voorbeeld: [{"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 Verplicht

Metadata van het antwoord.

Voorbeeld: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Aanvullende velden: Nee

dataPoolData Verplicht

Gegevens van een geslaagd antwoord.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

dataStockDetailData Verplicht

Voorbeeldantwoord · StockDetailData.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

dataUnitsData Verplicht

Gegevens van een geslaagd antwoord.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

codeTekenreeksVerplicht

De exacte digitale code. Behoud hoofdletters en interne spaties.

minLength: 1maxLength: 512

Voorbeeld: "DEMO-ONE"

delivery_idTekenreeks | nullOptioneel

ID van de levering of bestellingstoewijzing.

Tekenreeks:format: "uuid"

Voorbeeld: null

kindTekenreeksOptioneel

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

const: "code"

Standaard: "code"Voorbeeld: "code"

payload_idTekenreeksVerplicht

Inhouds-ID; geen openbare download-URL.

format: "uuid"

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

unit_idTekenreeksVerplicht

ID van één individuele code of bestand.

format: "uuid"

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

Aanvullende velden: Nee

consumer_idTekenreeksVerplicht

ID van de gekoppelde import of eenheid.

format: "uuid"

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

consumer_kindTekenreeksVerplicht

Uploadbestemming: digital_import / digital_unit.

Beperkingen

enum

["digital_import", "digital_unit"]

Voorbeeld: "digital_import"

filenameTekenreeksVerplicht

Bestand

minLength: 1maxLength: 255

Voorbeeld: "codes.txt"

purposeTekenreeksVerplicht

digital_import: TXT/CSV; digital_unit: afzonderlijk verkocht bestand.

Beperkingen

enum

["digital_unit", "digital_import"]

Voorbeeld: "digital_import"

sha256TekenreeksVerplicht

SHA-256 (hex, 64)

Beperkingen

pattern

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

Voorbeeld: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesGeheel getalVerplicht

Grootte in bytes

minimum: 1maximum: 262144000

Voorbeeld: 18

Aanvullende velden: Nee

consumer_idTekenreeksVerplicht

ID van de gekoppelde import of eenheid.

format: "uuid"

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

consumer_kindTekenreeksVerplicht

Uploadbestemming: digital_import / digital_unit.

Beperkingen

enum

["digital_import", "digital_unit"]

Voorbeeld: "digital_import"

expires_atTekenreeksVerplicht

Vervaltijd van deze upload of import.

format: "date-time"

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

filenameTekenreeksVerplicht

Bestand

Voorbeeld: "codes.txt"

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

format: "uuid"

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

product_idTekenreeksVerplicht

Productidentificatie.

Voorbeeld: "example"

purposeTekenreeksVerplicht

digital_import: TXT/CSV; digital_unit: afzonderlijk verkocht bestand.

Beperkingen

enum

["digital_unit", "digital_import"]

Voorbeeld: "digital_import"

received_bytesGeheel getalVerplicht

Uploaden… · Grootte in bytes

Voorbeeld: 18

sha256TekenreeksVerplicht

SHA-256 (hex, 64)

Voorbeeld: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesGeheel getalVerplicht

Grootte in bytes

Voorbeeld: 18

statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Voorbeeld: "ready"

Aanvullende velden: Nee

delivered_atTekenreeksVerplicht

Leveringsdatum en -tijd.

format: "date-time"

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

expected_delivery_versionGeheel getalVerplicht

Leveringsversie; 0 voor een nieuwe levering.

minimum: 0maximum: 0

Voorbeeld: 0

expected_sales_limit_versionGeheel getal | nullOptioneel

Versie van de verkooplimiet; vereist bij publish_for_sale=true.

Geheel getal:minimum: 0maximum: 9223372036854775807

Voorbeeld: 0

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 2

location_idTekenreeksVerplicht

Identificatie van de magazijnlocatie.

Beperkingen

pattern

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

Voorbeeld: "location-digital"

publish_for_saleBooleaanse waardeOptioneel

true verhoogt ook de eindige verkooplimiet; false wijzigt deze niet.

Standaard: falseVoorbeeld: true

statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Beperkingen

enum

["planned", "received"]

Voorbeeld: "received"

validation_digestTekenreeksVerplicht

Controlesom van de validatie; ongewijzigd meesturen bij bevestiging.

Beperkingen

pattern

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

Voorbeeld: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Beperkingen

pattern

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

Voorbeeld: "warehouse-main"

Aanvullende velden: Nee

countGeheel getalVerplicht

Exact aantal eenheden in deze partij.

minimum: 1maximum: 1000

Voorbeeld: 2

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum

["code", "file"]

Voorbeeld: "code"

Aanvullende velden: Nee

delivery_idTekenreeks | nullVerplicht

ID van de levering of bestellingstoewijzing.

Voorbeeld: null

delivery_statusTekenreeks | nullVerplicht

Leverstatus: planned / received; vooraf null.

Voorbeeld: null

delivery_versionGeheel getal | nullVerplicht

Huidige versie van de magazijnlevering.

Voorbeeld: null

expected_countGeheel getalVerplicht

Verwacht aantal; alleen volledige partijen worden aanvaard.

Voorbeeld: 2

expires_atTekenreeksVerplicht

Vervaltijd van deze upload of import.

format: "date-time"

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

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

format: "uuid"

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

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum

["code", "file"]

Voorbeeld: "code"

product_idTekenreeksVerplicht

Productidentificatie.

Voorbeeld: "example"

statusTekenreeksVerplicht

Status die deze specifieke bewerking accepteert.

Voorbeeld: "validated"

validated_countGeheel getalVerplicht

Aantal aanvaarde eenheden bij de laatste geslaagde validatie.

Voorbeeld: 2

validation_digestTekenreeks | nullVerplicht

Controlesom van de validatie; ongewijzigd meesturen bij bevestiging.

Voorbeeld: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 2

Aanvullende velden: Nee

expected_delivery_versionGeheel getalVerplicht

Leveringsversie; 0 voor een nieuwe levering.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

expected_sales_limit_versionGeheel getal | nullOptioneel

Versie van de verkooplimiet; vereist bij publish_for_sale=true.

Geheel getal:minimum: 0maximum: 9223372036854775807

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 3

publish_for_saleBooleaanse waardeOptioneel

true verhoogt ook de eindige verkooplimiet; false wijzigt deze niet.

Standaard: false

Aanvullende velden: Nee

code_columnTekenreeks | nullOptioneel

CSV-kolom met codes; gebruik code.

Tekenreeks:const: "code"

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

formatTekenreeks | nullOptioneel

Codelijst: txt / csv; gebruik upload_ids voor bestanden.

Beperkingen · Tekenreeks 1

enum

["txt", "csv"]

Voorbeeld: "txt"

source_upload_idTekenreeks | nullOptioneel

Voltooide privé-upload van TXT/CSV voor deze import.

Tekenreeks:format: "uuid"

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

upload_idsArray <Tekenreeks> | nullOptioneel

1–100 voltooide privé-uploads van bestanden voor deze import.

Array:minItems: 1maxItems: 100

Array / Array:format: "uuid"

Aanvullende velden: Nee

expected_delivery_versionGeheel getalVerplicht

Leveringsversie; 0 voor een nieuwe levering.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

expected_order_versionGeheel getalVerplicht

Versie van de toewijzingsvolgorde, niet van de klantbestelling.

minimum: 0maximum: 9223372036854775807

Voorbeeld: 1

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 3

reasonTekenreeksVerplicht

Vastgelegde reden voor de wijziging.

minLength: 1maxLength: 500

Voorbeeld: "Withdraw a revoked license"

Aanvullende velden: Nee

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

manual_reservedGeheel getalVerplicht

Handmatig gereserveerde hoeveelheid.

minimum: 0maximum: 2147483647

Voorbeeld: 1

reasonTekenreeksOptioneel

Vastgelegde reden voor de wijziging.

maxLength: 500

Standaard: ""

Aanvullende velden: Nee

email_modeTekenreeksOptioneel

disabled: geen e-mail; order_link: bestellink; code_text: eventueel ook codes.

Beperkingen

enum

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

Standaard: "disabled"Voorbeeld: "order_link"

enabledBooleaanse waardeVerplicht

Of deze instelling is ingeschakeld.

Voorbeeld: true

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 0maximum: 9223372036854775807

Voorbeeld: 0

retention_daysGeheel getal | nullOptioneel

null: onbeperkt; 1–3650 dagen vanaf eerste toegang. Codes worden niet automatisch gewist.

Geheel getal:minimum: 1maximum: 3650

Voorbeeld: null

Aanvullende velden: Nee

availableGeheel getalVerplicht

Aantal vrije eenheden die niet zijn gereserveerd of uitgegeven.

Voorbeeld: 1

heldGeheel getalVerplicht

Voor bestellingen gereserveerde, nog niet uitgegeven eenheden.

Voorbeeld: 0

issuedGeheel getalVerplicht

Eenheden die al aan betaalde aankopen zijn uitgegeven.

Voorbeeld: 1

plannedGeheel getalVerplicht

Eenheden van bevestigde, nog niet ontvangen leveringen.

Voorbeeld: 0

retiredGeheel getalVerplicht

Ingetrokken eenheden die in de geschiedenis blijven.

Voorbeeld: 0

stagedGeheel getalVerplicht

Eenheden in onvoltooide imports, nog geen voorraad.

Voorbeeld: 0

Aanvullende velden: Nee

configuredBooleaanse waardeVerplicht

Of poolinstellingen zijn opgeslagen.

Voorbeeld: true

countsPoolCounts Verplicht

Aantal eenheden per voorraadstatus.

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

email_modeTekenreeksVerplicht

disabled: geen e-mail; order_link: bestellink; code_text: eventueel ook codes.

Beperkingen

enum

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

Voorbeeld: "order_link"

enabledBooleaanse waardeVerplicht

Of deze instelling is ingeschakeld.

Voorbeeld: true

order_versionGeheel getalVerplicht

Versie van de toewijzingsvolgorde van de pool.

Voorbeeld: 2

product_idTekenreeksVerplicht

Productidentificatie.

Voorbeeld: "example"

retention_daysGeheel getal | nullVerplicht

null: onbeperkt; 1–3650 dagen vanaf eerste toegang. Codes worden niet automatisch gewist.

Voorbeeld: null

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

reasonTekenreeksOptioneel

Vastgelegde reden voor de wijziging.

maxLength: 500

Standaard: ""

sellable_limitGeheel getalVerplicht

Verkooplimiet: -1 betekent onbeperkt; 0 maakt verkoop niet beschikbaar.

minimum: -1maximum: 2147483647

Voorbeeld: 1

Aanvullende velden: Nee

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 0maximum: 9223372036854775807

Voorbeeld: 0

locationsArray <LocationQuantity > Verplicht

Magazijnlocaties.

minItems: 1maxItems: 100

Voorbeeld: [{"location_id":"example","on_hand":1}]

reasonTekenreeksVerplicht

Vastgelegde reden voor de wijziging.

minLength: 1maxLength: 500

Voorbeeld: "Example"

target_idTekenreeksVerplicht

Identificatie van het product of de variant waarop de bewerking betrekking heeft.

Beperkingen

pattern

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

Voorbeeld: "example"

target_typeTekenreeksVerplicht

Of de bewerking betrekking heeft op een product of een variant.

Beperkingen

enum

["product", "variant"]

Voorbeeld: "product"

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Beperkingen

pattern

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

Voorbeeld: "example"

Aanvullende velden: Nee

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

locationsArray <LocationQuantity > Verplicht

Magazijnlocaties.

minItems: 1maxItems: 100

Voorbeeld: [{"location_id":"example","on_hand":1}]

reasonTekenreeksVerplicht

Vastgelegde reden voor de wijziging.

minLength: 1maxLength: 500

Voorbeeld: "Example"

Aanvullende velden: Nee

activeBooleaanse waardeVerplicht

Of de resource actief is.

Voorbeeld: true

availableGeheel getal | nullVerplicht

Hoeveelheid beschikbaar voor verkoop; null betekent onbeperkt.

Voorbeeld: 5

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (StockData).

Voorbeeld: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedGeheel getalVerplicht

Handmatig gereserveerde hoeveelheid.

Voorbeeld: 2

on_handGeheel getalVerplicht

Fysiek aanwezige voorraad.

Voorbeeld: 10

reservedGeheel getalVerplicht

Hoeveelheid die door bestellingen is gereserveerd.

Voorbeeld: 3

sellable_limitGeheel getalVerplicht

Verkooplimiet: -1 betekent onbeperkt; 0 maakt verkoop niet beschikbaar.

Voorbeeld: 10

target_idTekenreeksVerplicht

Identificatie van het product of de variant waarop de bewerking betrekking heeft.

Voorbeeld: "example"

target_typeTekenreeksVerplicht

Of de bewerking betrekking heeft op een product of een variant.

Beperkingen

enum

["product", "variant"]

Voorbeeld: "product"

total_reservedGeheel getalVerplicht

Totale gereserveerde hoeveelheid.

Voorbeeld: 5

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Voorbeeld: "example"

Aanvullende velden: Nee

activeBooleaanse waardeVerplicht

Of de resource actief is.

Voorbeeld: true

allocationsArray <AllocationData > Verplicht

Hoeveelheden die aan magazijnlocaties zijn toegewezen.

Voorbeeld: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableGeheel getal | nullVerplicht

Hoeveelheid beschikbaar voor verkoop; null betekent onbeperkt.

Voorbeeld: 5

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (StockDetailData).

Voorbeeld: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedGeheel getalVerplicht

Handmatig gereserveerde hoeveelheid.

Voorbeeld: 2

on_handGeheel getalVerplicht

Fysiek aanwezige voorraad.

Voorbeeld: 10

reservedGeheel getalVerplicht

Hoeveelheid die door bestellingen is gereserveerd.

Voorbeeld: 3

sellable_limitGeheel getalVerplicht

Verkooplimiet: -1 betekent onbeperkt; 0 maakt verkoop niet beschikbaar.

Voorbeeld: 10

target_idTekenreeksVerplicht

Identificatie van het product of de variant waarop de bewerking betrekking heeft.

Voorbeeld: "example"

target_typeTekenreeksVerplicht

Of de bewerking betrekking heeft op een product of een variant.

Beperkingen

enum

["product", "variant"]

Voorbeeld: "product"

total_reservedGeheel getalVerplicht

Totale gereserveerde hoeveelheid.

Voorbeeld: 5

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

warehouse_idTekenreeksVerplicht

Magazijnidentificatie.

Voorbeeld: "example"

Aanvullende velden: Nee

content_stateTekenreeksVerplicht

Inhoudsstatus: present / deleting / deleted.

Voorbeeld: "present"

delivery_idTekenreeks | nullVerplicht

ID van de levering of bestellingstoewijzing.

Voorbeeld: "delivery-example"

filenameTekenreeks | nullVerplicht

Bestand

Voorbeeld: null

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

format: "uuid"

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

issued_atTekenreeks | nullVerplicht

Eerste uitgifte; vooraf null.

Tekenreeks:format: "date-time"

Voorbeeld: null

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum

["file", "code"]

Voorbeeld: "code"

location_idTekenreeks | nullVerplicht

Identificatie van de magazijnlocatie.

Voorbeeld: "location-digital"

mime_typeTekenreeks | nullVerplicht

Inhoudstype van de media.

Voorbeeld: null

payload_idTekenreeksVerplicht

Inhouds-ID; geen openbare download-URL.

format: "uuid"

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

product_idTekenreeksVerplicht

Productidentificatie.

Voorbeeld: "example"

size_bytesGeheel getal | nullVerplicht

Grootte in bytes

Voorbeeld: null

sort_orderGeheel getalVerplicht

Positie in de geordende verzameling.

Voorbeeld: 1

stateTekenreeksVerplicht

Status

Voorbeeld: "available"

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

warehouse_idTekenreeks | nullVerplicht

Magazijnidentificatie.

Voorbeeld: "warehouse-main"

Aanvullende velden: Nee

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1

Voorbeeld: 1

reasonTekenreeksVerplicht

Vastgelegde reden voor de wijziging.

minLength: 1maxLength: 500

Voorbeeld: "Withdraw a revoked license"

Aanvullende velden: Nee

expected_order_versionGeheel getalVerplicht

Versie van de toewijzingsvolgorde, niet van de klantbestelling.

minimum: 1

Voorbeeld: 1

unit_idsArray <Tekenreeks> Verplicht

Alle eenheden van de ongefilterde pagina in gewenste volgorde.

minItems: 2maxItems: 100

Array:format: "uuid"

Voorbeeld: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursorTekenreeks | nullOptioneel

Cursor van de ongefilterde pagina; null voor de eerste.

Tekenreeks:maxLength: 1024

Aanvullende velden: Nee

codeTekenreeks | nullOptioneel

De exacte digitale code. Behoud hoofdletters en interne spaties.

Tekenreeks:minLength: 1maxLength: 512

Voorbeeld: "SYNTHETIC-REPLACEMENT"

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1

Voorbeeld: 1

reasonTekenreeksVerplicht

Vastgelegde reden voor de wijziging.

minLength: 1maxLength: 500

Voorbeeld: "Replace an invalid activation code"

upload_idTekenreeks | nullOptioneel

Resource-identificatie; bewaar deze zoals teruggegeven. · upload_id

Tekenreeks:format: "uuid"

Aanvullende velden: Nee

order_versionGeheel getalVerplicht

Versie van de toewijzingsvolgorde van de pool.

Voorbeeld: 2

totalGeheel getalVerplicht

Totaalbedrag.

Voorbeeld: 1

unitsArray <UnitData > Verplicht

Metadata van eenheden; inhoud vereist een afzonderlijke bevoegde aanvraag.

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

Aanvullende velden: Ja