Scheme de date: Stocuri

Scheme de date: Stocuri. Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

Scheme de date

Cantități alocate locațiilor din depozit

AllocationData · Schemă · Scheme de date: Stocuri

location_codeȘir de caractereObligatoriu: Codul locației din depozit.

Exemplu: "example"
location_idȘir de caractereObligatoriu: Identificatorul locației din depozit.

Exemplu: "example"
location_nameȘir de caractereObligatoriu: Numele locației din depozit.

Exemplu: "example"
on_handNumăr întregObligatoriu: Cantitatea fizică din stoc.

Exemplu: 10

Câmpuri suplimentare: Nu

Listează · Stocuri — Stocuri — Răspuns

ApiResponse_list_StockData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataTablou <StockData > Obligatoriu: Exemplu de răspuns · ApiResponse_list_StockData__.

Exemplu: [{"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 Obligatoriu: Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

Obține · Stocuri — Stocuri — Răspuns

ApiResponse_StockDetailData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataStockDetailData Obligatoriu: Exemplu de răspuns · StockDetailData.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"request_id":"example"}

Câmpuri suplimentare: Nu

Actualizează · Rezervare manuală — Stocuri — Corpul cererii

ManualReservationUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
manual_reservedNumăr întregObligatoriu: Cantitatea rezervată manual.

minimum: 0maximum: 2147483647

Exemplu: 1
reasonȘir de caractereOpțional: Motivul înregistrat pentru modificare.

maxLength: 500

Valoare implicită: ""

Câmpuri suplimentare: Nu

Actualizează · Limită de vânzări — Stocuri — Corpul cererii

SalesLimitUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
reasonȘir de caractereOpțional: Motivul înregistrat pentru modificare.

maxLength: 500

Valoare implicită: ""
sellable_limitNumăr întregObligatoriu: Limita de vânzare: -1 înseamnă nelimitat, iar 0 dezactivează disponibilitatea pentru vânzare.

minimum: -1maximum: 2147483647

Exemplu: 1

Câmpuri suplimentare: Nu

Creează · Ajustare de stoc — Stocuri — Corpul cererii

StockAdjustmentCreate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 0maximum: 9223372036854775807

Exemplu: 0

locationsTablou <LocationQuantity > Obligatoriu

Locațiile din depozit.

minItems: 1maxItems: 100

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

reasonȘir de caractereObligatoriu

Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500

Exemplu: "Example"

target_idȘir de caractereObligatoriu

Identificatorul produsului sau al variantei vizate de operație.

Restricții

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

Exemplu: "example"

target_typeȘir de caractereObligatoriu

Indică dacă operația vizează un produs sau o variantă.

Restricții

enum: ["product", "variant"]

Exemplu: "product"

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Restricții

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

Exemplu: "example"

Câmpuri suplimentare: Nu

Actualizează · Stocuri — Stocuri — Corpul cererii

StockAdjustmentUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu: Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1
locationsTablou <LocationQuantity > Obligatoriu: Locațiile din depozit.

minItems: 1maxItems: 100

Exemplu: [{"location_id":"example","on_hand":1}]
reasonȘir de caractereObligatoriu: Motivul înregistrat pentru modificare.

minLength: 1maxLength: 500

Exemplu: "Example"

Câmpuri suplimentare: Nu

Listează · Stocuri — Stocuri — Răspuns

StockData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

activeValoare booleanăObligatoriu

Indică dacă resursa este activă.

Exemplu: true

availableNumăr întreg nullObligatoriu

Cantitatea disponibilă pentru vânzare; null reprezintă o cantitate nelimitată.

Exemplu: 5

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (StockData).

Exemplu: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNumăr întregObligatoriu

Cantitatea rezervată manual.

Exemplu: 2

on_handNumăr întregObligatoriu

Cantitatea fizică din stoc.

Exemplu: 10

reservedNumăr întregObligatoriu

Cantitatea rezervată prin comenzi.

Exemplu: 3

sellable_limitNumăr întregObligatoriu

Limita de vânzare: -1 înseamnă nelimitat, iar 0 dezactivează disponibilitatea pentru vânzare.

Exemplu: 10

target_idȘir de caractereObligatoriu

Identificatorul produsului sau al variantei vizate de operație.

Exemplu: "example"

target_typeȘir de caractereObligatoriu

Indică dacă operația vizează un produs sau o variantă.

Restricții

enum: ["product", "variant"]

Exemplu: "product"

total_reservedNumăr întregObligatoriu

Cantitatea totală rezervată.

Exemplu: 5

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

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

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Exemplu: "example"

Câmpuri suplimentare: Nu

Obține · Stocuri — Stocuri — Răspuns

StockDetailData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

activeValoare booleanăObligatoriu

Indică dacă resursa este activă.

Exemplu: true

allocationsTablou <AllocationData > Obligatoriu

Cantități alocate locațiilor din depozit.

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

availableNumăr întreg nullObligatoriu

Cantitatea disponibilă pentru vânzare; null reprezintă o cantitate nelimitată.

Exemplu: 5

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (StockDetailData).

Exemplu: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNumăr întregObligatoriu

Cantitatea rezervată manual.

Exemplu: 2

on_handNumăr întregObligatoriu

Cantitatea fizică din stoc.

Exemplu: 10

reservedNumăr întregObligatoriu

Cantitatea rezervată prin comenzi.

Exemplu: 3

sellable_limitNumăr întregObligatoriu

Limita de vânzare: -1 înseamnă nelimitat, iar 0 dezactivează disponibilitatea pentru vânzare.

Exemplu: 10

target_idȘir de caractereObligatoriu

Identificatorul produsului sau al variantei vizate de operație.

Exemplu: "example"

target_typeȘir de caractereObligatoriu

Indică dacă operația vizează un produs sau o variantă.

Restricții

enum: ["product", "variant"]

Exemplu: "product"

total_reservedNumăr întregObligatoriu

Cantitatea totală rezervată.

Exemplu: 5

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

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

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Exemplu: "example"

Câmpuri suplimentare: Nu