Preskoči na vsebino
ShopentlyLearn

Podatkovne sheme: Zaloga

Podatkovne sheme: Zaloga. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Količine, dodeljene lokacijam skladišča

AllocationData · Shema · Podatkovne sheme: Zaloga
location_codeNizObvezno

Koda lokacije skladišča.

Primer: "example"
location_idNizObvezno

Identifikator lokacije skladišča.

Primer: "example"
location_nameNizObvezno

Ime lokacije skladišča.

Primer: "example"
on_handCelo številoObvezno

Fizična količina na zalogi.

Primer: 10

Dodatna polja: Ne

Prikaži seznam · Zaloge — Zaloga — Odgovor

ApiResponse_list_StockData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <StockData > Obvezno

Primer odgovora · ApiResponse_list_StockData__.

Primer: [{"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Pridobi · Zaloge — Zaloga — Odgovor

ApiResponse_StockDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataStockDetailData Obvezno

Primer odgovora · StockDetailData.

Primer: {"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 Obvezno

Metapodatki odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

Posodobi · Ročna rezervacija — Zaloga — Telo zahteve

ManualReservationUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
manual_reservedCelo številoObvezno

Ročno rezervirana količina.

minimum: 0maximum: 2147483647
Primer: 1
reasonNizIzbirno

Zabeleženi razlog spremembe.

maxLength: 500
Privzeto: ""

Dodatna polja: Ne

Posodobi · Prodajna omejitev — Zaloga — Telo zahteve

SalesLimitUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
reasonNizIzbirno

Zabeleženi razlog spremembe.

maxLength: 500
Privzeto: ""
sellable_limitCelo številoObvezno

Prodajna omejitev: -1 pomeni neomejeno, 0 pa onemogoči razpoložljivo prodajo.

minimum: -1maximum: 2147483647
Primer: 1

Dodatna polja: Ne

Ustvari · Popravek zalog — Zaloga — Telo zahteve

StockAdjustmentCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 0maximum: 9223372036854775807
Primer: 0
locationsPolje elementov <LocationQuantity > Obvezno

Lokacije skladišča.

minItems: 1maxItems: 100
Primer: [{"location_id":"example","on_hand":1}]
reasonNizObvezno

Zabeleženi razlog spremembe.

minLength: 1maxLength: 500
Primer: "Example"
target_idNizObvezno

Identifikator izdelka ali različice, na katero vpliva operacija.

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

Ali se operacija nanaša na izdelek ali različico.

Omejitve
enum
["product", "variant"]
Primer: "product"
warehouse_idNizObvezno

Identifikator skladišča.

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

Dodatna polja: Ne

Posodobi · Zaloge — Zaloga — Telo zahteve

StockAdjustmentUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
locationsPolje elementov <LocationQuantity > Obvezno

Lokacije skladišča.

minItems: 1maxItems: 100
Primer: [{"location_id":"example","on_hand":1}]
reasonNizObvezno

Zabeleženi razlog spremembe.

minLength: 1maxLength: 500
Primer: "Example"

Dodatna polja: Ne

Prikaži seznam · Zaloge — Zaloga — Odgovor

StockData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
activeLogična vrednostObvezno

Ali je vir aktiven.

Primer: true
availableCelo število nullObvezno

Količina, razpoložljiva za prodajo; null pomeni neomejeno količino.

Primer: 5
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (StockData).

Primer: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedCelo številoObvezno

Ročno rezervirana količina.

Primer: 2
on_handCelo številoObvezno

Fizična količina na zalogi.

Primer: 10
reservedCelo številoObvezno

Količina, rezervirana z naročili.

Primer: 3
sellable_limitCelo številoObvezno

Prodajna omejitev: -1 pomeni neomejeno, 0 pa onemogoči razpoložljivo prodajo.

Primer: 10
target_idNizObvezno

Identifikator izdelka ali različice, na katero vpliva operacija.

Primer: "example"
target_typeNizObvezno

Ali se operacija nanaša na izdelek ali različico.

Omejitve
enum
["product", "variant"]
Primer: "product"
total_reservedCelo številoObvezno

Skupna rezervirana količina.

Primer: 5
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1
warehouse_idNizObvezno

Identifikator skladišča.

Primer: "example"

Dodatna polja: Ne

Pridobi · Zaloge — Zaloga — Odgovor

StockDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
activeLogična vrednostObvezno

Ali je vir aktiven.

Primer: true
allocationsPolje elementov <AllocationData > Obvezno

Količine, dodeljene lokacijam skladišča.

Primer: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]
availableCelo število nullObvezno

Količina, razpoložljiva za prodajo; null pomeni neomejeno količino.

Primer: 5
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (StockDetailData).

Primer: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedCelo številoObvezno

Ročno rezervirana količina.

Primer: 2
on_handCelo številoObvezno

Fizična količina na zalogi.

Primer: 10
reservedCelo številoObvezno

Količina, rezervirana z naročili.

Primer: 3
sellable_limitCelo številoObvezno

Prodajna omejitev: -1 pomeni neomejeno, 0 pa onemogoči razpoložljivo prodajo.

Primer: 10
target_idNizObvezno

Identifikator izdelka ali različice, na katero vpliva operacija.

Primer: "example"
target_typeNizObvezno

Ali se operacija nanaša na izdelek ali različico.

Omejitve
enum
["product", "variant"]
Primer: "product"
total_reservedCelo številoObvezno

Skupna rezervirana količina.

Primer: 5
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1
warehouse_idNizObvezno

Identifikator skladišča.

Primer: "example"

Dodatna polja: Ne