Gegevensschema’s: Voorraad

Gegevensschema’s: Voorraad. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Hoeveelheden die aan magazijnlocaties zijn toegewezen

AllocationData · Schema · 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

Lijst ophalen · Voorraad — Voorraad — Antwoord

ApiResponse_list_StockData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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

Ophalen · Voorraad — Voorraad — Antwoord

ApiResponse_StockDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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

Bijwerken · Handmatige reservering — Voorraad — Verzoekinhoud

ManualReservationUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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

Bijwerken · Verkooplimiet — Voorraad — Verzoekinhoud

SalesLimitUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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

Aanmaken · Voorraadcorrectie — Voorraad — Verzoekinhoud

StockAdjustmentCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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

Bijwerken · Voorraad — Voorraad — Verzoekinhoud

StockAdjustmentUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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

Lijst ophalen · Voorraad — Voorraad — Antwoord

StockData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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

Ophalen · Voorraad — Voorraad — Antwoord

StockDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

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