Sheme podataka
Količine dodijeljene skladišnim lokacijama
AllocationData · Shema · Sheme podataka: Zalihe
location_codeNiz znakovaObveznoKod skladišne lokacije.
location_idNiz znakovaObveznoIdentifikator skladišne lokacije.
location_nameNiz znakovaObveznoNaziv skladišne lokacije.
on_handCijeli brojObveznoFizička količina na zalihi.
Dodatna polja: Ne
ApiResponse[CodeContentData]
ApiResponse_CodeContentData_ · Kod se vraća kao JSON, datoteka kao binarni podaci. Svaki zahtjev traži Bearer i ovlast reveal.
dataCodeContentDataObveznoPodaci uspješnog odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodaci odgovora.
Dodatna polja: Ne
ApiResponse[DigitalUploadData]
ApiResponse_DigitalUploadData_ · Provjeri veličinu, kontrolni zbroj i format. Dovršen prijenos još ne znači zaprimljenu isporuku.
dataDigitalUploadDataObveznoPodaci uspješnog odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodaci odgovora.
Dodatna polja: Ne
ApiResponse[ImportData]
ApiResponse_ImportData_ · Provjeri stanje, verziju i provjeru valjanosti. Nacrt pripada API ključu koji ga je izradio.
dataImportDataObveznoPodaci uspješnog odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodaci odgovora.
Dodatna polja: Ne
Popis · Zalihe — Zalihe — Odgovor
ApiResponse_list_StockData__ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataPolje vrijednosti <StockData> ObveznoPrimjer odgovora · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodaci odgovora.
Dodatna polja: Ne
ApiResponse[PoolData]
ApiResponse_PoolData_ · Prije izmjene pročitaj postavke i količine. Odgovor ne sadrži kodove ni sadržaj datoteka.
dataPoolDataObveznoPodaci uspješnog odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodaci odgovora.
Dodatna polja: Ne
Dohvati · Zalihe — Zalihe — Odgovor
ApiResponse_StockDetailData_ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataStockDetailDataObveznoPrimjer odgovora · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodaci odgovora.
Dodatna polja: Ne
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Pročitaj najviše 100 jedinica po stranici. Popis prikazuje metapodatke bez otkrivanja kodova.
dataUnitsDataObveznoPodaci uspješnog odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodaci odgovora.
Dodatna polja: Ne
CodeContentData
CodeContentData · Kod se vraća kao JSON, datoteka kao binarni podaci. Svaki zahtjev traži Bearer i ovlast reveal.
codeNiz znakovaObveznoTočan digitalni kod. Sačuvajte velika i mala slova te unutarnje razmake.
minLength:1maxLength:512delivery_idNiz znakova nullNeobaveznoID isporuke ili dodjele narudžbi.
Niz znakova:format:"uuid"kindNiz znakovaNeobaveznoVarijanta strukture podataka opisana dopuštenim vrijednostima.
const:"code"payload_idNiz znakovaObveznoID sadržaja; nije javna adresa za preuzimanje.
format:"uuid"unit_idNiz znakovaObveznoID jednog pojedinačnog koda ili datoteke.
format:"uuid"
Dodatna polja: Ne
DigitalUploadCreate
DigitalUploadCreate · Rezerviraj prostor za datoteku i poveži je s uvozom ili jedinicom za zamjenu.
consumer_idNiz znakovaObveznoID povezanog uvoza ili jedinice.
format:"uuid"consumer_kindNiz znakovaObveznoPovezanost prijenosa: digital_import / digital_unit.
Ograničenja
enum["digital_import", "digital_unit"]
filenameNiz znakovaObveznoDatoteka
minLength:1maxLength:255purposeNiz znakovaObveznodigital_import: TXT/CSV; digital_unit: pojedinačno prodana datoteka.
Ograničenja
enum["digital_unit", "digital_import"]
sha256Niz znakovaObveznoSHA-256 (hex, 64)
Ograničenja
pattern"^[0-9a-f]{64}$"
size_bytesCijeli brojObveznoVeličina u bajtovima
minimum:1maximum:262144000
Dodatna polja: Ne
DigitalUploadData
DigitalUploadData · Provjeri veličinu, kontrolni zbroj i format. Dovršen prijenos još ne znači zaprimljenu isporuku.
consumer_idNiz znakovaObveznoID povezanog uvoza ili jedinice.
format:"uuid"consumer_kindNiz znakovaObveznoPovezanost prijenosa: digital_import / digital_unit.
Ograničenja
enum["digital_import", "digital_unit"]
expires_atNiz znakovaObveznoVrijeme isteka ovog prijenosa ili uvoza.
format:"date-time"filenameNiz znakovaObveznoDatoteka
idNiz znakovaObveznoIdentifikator resursa; sačuvajte ga u vraćenom obliku.
format:"uuid"product_idNiz znakovaObveznoIdentifikator proizvoda.
purposeNiz znakovaObveznodigital_import: TXT/CSV; digital_unit: pojedinačno prodana datoteka.
Ograničenja
enum["digital_unit", "digital_import"]
received_bytesCijeli brojObveznoPrijenos… · Veličina u bajtovima
sha256Niz znakovaObveznoSHA-256 (hex, 64)
size_bytesCijeli brojObveznoVeličina u bajtovima
statusNiz znakovaObveznoStatus prihvaćen za ovu određenu operaciju.
Dodatna polja: Ne
ImportCommit
ImportCommit · Iz provjerene serije izradi planiranu ili zaprimljenu isporuku. Planirane jedinice još nisu za prodaju.
delivered_atNiz znakovaObveznoDatum i vrijeme dostave.
format:"date-time"expected_delivery_versionCijeli brojObveznoVerzija isporuke; 0 za novu isporuku.
minimum:0maximum:0expected_sales_limit_versionCijeli broj nullNeobaveznoVerzija ograničenja prodaje; potrebna uz publish_for_sale=true.
Cijeli broj:minimum:0maximum:9223372036854775807expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1maximum:9223372036854775807location_idNiz znakovaObveznoIdentifikator skladišne lokacije.
Ograničenja
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleLogička vrijednostNeobaveznotrue povećava i konačno ograničenje prodaje; false ga ne mijenja.
statusNiz znakovaObveznoStatus prihvaćen za ovu određenu operaciju.
Ograničenja
enum["planned", "received"]
validation_digestNiz znakovaObveznoKontrolni zbroj provjere; pošalji nepromijenjen pri potvrdi.
Ograničenja
pattern"^[0-9a-f]{64}$"
warehouse_idNiz znakovaObveznoIdentifikator skladišta.
Ograničenja
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Dodatna polja: Ne
ImportCreate
ImportCreate · Pripremi nacrt s najviše 1000 kodova ili 100 datoteka. Zaliha za prodaju još se ne povećava.
countCijeli brojObveznoTočan broj jedinica u seriji.
minimum:1maximum:1000kindNiz znakovaObveznoVarijanta strukture podataka opisana dopuštenim vrijednostima.
Ograničenja
enum["code", "file"]
Dodatna polja: Ne
ImportData
ImportData · Provjeri stanje, verziju i provjeru valjanosti. Nacrt pripada API ključu koji ga je izradio.
delivery_idNiz znakova nullObveznoID isporuke ili dodjele narudžbi.
delivery_statusNiz znakova nullObveznoStanje isporuke: planned / received; prije potvrde null.
delivery_versionCijeli broj nullObveznoTrenutačna verzija skladišne isporuke.
expected_countCijeli brojObveznoOčekivani broj; prihvaća se samo cijela serija.
expires_atNiz znakovaObveznoVrijeme isteka ovog prijenosa ili uvoza.
format:"date-time"idNiz znakovaObveznoIdentifikator resursa; sačuvajte ga u vraćenom obliku.
format:"uuid"kindNiz znakovaObveznoVarijanta strukture podataka opisana dopuštenim vrijednostima.
Ograničenja
enum["code", "file"]
product_idNiz znakovaObveznoIdentifikator proizvoda.
statusNiz znakovaObveznoStatus prihvaćen za ovu određenu operaciju.
validated_countCijeli brojObveznoBroj jedinica prihvaćenih posljednjom uspješnom provjerom.
validation_digestNiz znakova nullObveznoKontrolni zbroj provjere; pošalji nepromijenjen pri potvrdi.
versionCijeli brojObveznoVerzija resursa za kontrolu istodobnih upisa.
Dodatna polja: Ne
ImportReceive
ImportReceive · Zaprimi postojeće jedinice bez ponovnog uvoza kodova ili datoteka.
expected_delivery_versionCijeli brojObveznoVerzija isporuke; 0 za novu isporuku.
minimum:1maximum:9223372036854775807expected_sales_limit_versionCijeli broj nullNeobaveznoVerzija ograničenja prodaje; potrebna uz publish_for_sale=true.
Cijeli broj:minimum:0maximum:9223372036854775807expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1maximum:9223372036854775807publish_for_saleLogička vrijednostNeobaveznotrue povećava i konačno ograničenje prodaje; false ga ne mijenja.
Dodatna polja: Ne
ImportValidate
ImportValidate · Provjeri cijelu seriju. Duplikat ili nevaljan unos odbija seriju; kodovi se ne skraćuju.
code_columnNiz znakova nullNeobaveznoCSV stupac s kodovima; koristi code.
Niz znakova:const:"code"expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1maximum:9223372036854775807formatNiz znakova nullNeobaveznoPopis kodova: txt / csv; za datoteke koristi upload_ids.
Ograničenja · Niz znakova 1
enum["txt", "csv"]
source_upload_idNiz znakova nullNeobaveznoSpreman privatni TXT/CSV prijenos ovog uvoza.
Niz znakova:format:"uuid"upload_idsPolje vrijednosti <Niz znakova> nullNeobavezno1–100 spremnih privatnih prijenosa datoteka ovog uvoza.
Polje vrijednosti:minItems:1maxItems:100Polje vrijednosti / Polje vrijednosti:format:"uuid"
Dodatna polja: Ne
ImportWithdrawal
ImportWithdrawal · Povuci samo slobodne jedinice. Rezervirane i dodijeljene jedinice ostaju vezane uz narudžbe.
expected_delivery_versionCijeli brojObveznoVerzija isporuke; 0 za novu isporuku.
minimum:1maximum:9223372036854775807expected_order_versionCijeli brojObveznoVerzija redoslijeda dodjele, a ne kupčeve narudžbe.
minimum:0maximum:9223372036854775807expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1maximum:9223372036854775807reasonNiz znakovaObveznoRazlog zabilježen za promjenu.
minLength:1maxLength:500
Dodatna polja: Ne
Ažuriraj · Ručna rezervacija — Zalihe — Tijelo zahtjeva
ManualReservationUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1maximum:9223372036854775807manual_reservedCijeli brojObveznoRučno rezervirana količina.
minimum:0maximum:2147483647reasonNiz znakovaNeobaveznoRazlog zabilježen za promjenu.
maxLength:500
Dodatna polja: Ne
PoolChange
PoolChange · Uključi pojedinačne kodove ili datoteke od plana Professional. Isključivanje čuva pristup prethodnim kupnjama.
email_modeNiz znakovaNeobaveznodisabled: bez e-pošte; order_link: poveznica na narudžbu; code_text: mogući i kodovi.
Ograničenja
enum["disabled", "order_link", "code_text"]
enabledLogička vrijednostObveznoJe li ova postavka uključena.
expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:0maximum:9223372036854775807retention_daysCijeli broj nullNeobaveznonull: bez roka; 1–3650 dana od prvog pristupa. Kodovi se ne brišu automatski.
Cijeli broj:minimum:1maximum:3650
Dodatna polja: Ne
PoolCounts
PoolCounts · Prije izmjene pročitaj postavke i količine. Odgovor ne sadrži kodove ni sadržaj datoteka.
availableCijeli brojObveznoBroj slobodnih jedinica koje nisu rezervirane ni izdane.
heldCijeli brojObveznoJedinice rezervirane za narudžbe, još nisu izdane.
issuedCijeli brojObveznoJedinice već izdane za plaćene kupnje.
plannedCijeli brojObveznoJedinice potvrđenih, još nezaprimljenih isporuka.
retiredCijeli brojObveznoPovučene jedinice sačuvane u povijesti.
stagedCijeli brojObveznoJedinice nedovršenih uvoza, još nisu zaliha.
Dodatna polja: Ne
PoolData
PoolData · Prije izmjene pročitaj postavke i količine. Odgovor ne sadrži kodove ni sadržaj datoteka.
configuredLogička vrijednostObveznoJesu li postavke digitalne zalihe spremljene.
countsPoolCountsObveznoBroj jedinica prema stanju zalihe.
email_modeNiz znakovaObveznodisabled: bez e-pošte; order_link: poveznica na narudžbu; code_text: mogući i kodovi.
Ograničenja
enum["disabled", "order_link", "code_text"]
enabledLogička vrijednostObveznoJe li ova postavka uključena.
order_versionCijeli brojObveznoVerzija redoslijeda dodjele zalihe.
product_idNiz znakovaObveznoIdentifikator proizvoda.
retention_daysCijeli broj nullObveznonull: bez roka; 1–3650 dana od prvog pristupa. Kodovi se ne brišu automatski.
versionCijeli brojObveznoVerzija resursa za kontrolu istodobnih upisa.
Dodatna polja: Ne
Ažuriraj · Ograničenje prodaje — Zalihe — Tijelo zahtjeva
SalesLimitUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1maximum:9223372036854775807reasonNiz znakovaNeobaveznoRazlog zabilježen za promjenu.
maxLength:500sellable_limitCijeli brojObveznoOgraničenje prodaje: -1 znači neograničeno, a 0 onemogućuje dostupnu prodaju.
minimum:-1maximum:2147483647
Dodatna polja: Ne
Stvori · Korekcija zaliha — Zalihe — Tijelo zahtjeva
StockAdjustmentCreate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:0maximum:9223372036854775807locationsPolje vrijednosti <LocationQuantity> ObveznoSkladišne lokacije.
minItems:1maxItems:100reasonNiz znakovaObveznoRazlog zabilježen za promjenu.
minLength:1maxLength:500target_idNiz znakovaObveznoIdentifikator proizvoda ili varijante na koju operacija utječe.
Ograničenja
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeNiz znakovaObveznoOdnosi li se operacija na proizvod ili varijantu.
Ograničenja
enum["product", "variant"]
warehouse_idNiz znakovaObveznoIdentifikator skladišta.
Ograničenja
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Dodatna polja: Ne
Ažuriraj · Zalihe — Zalihe — Tijelo zahtjeva
StockAdjustmentUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1maximum:9223372036854775807locationsPolje vrijednosti <LocationQuantity> ObveznoSkladišne lokacije.
minItems:1maxItems:100reasonNiz znakovaObveznoRazlog zabilježen za promjenu.
minLength:1maxLength:500
Dodatna polja: Ne
Popis · Zalihe — Zalihe — Odgovor
StockData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
activeLogička vrijednostObveznoJe li resurs aktivan.
availableCijeli broj nullObveznoKoličina dostupna za prodaju; null označava neograničenu količinu.
idNiz znakovaObveznoIdentifikator resursa; sačuvajte ga u vraćenom obliku. (StockData).
manual_reservedCijeli brojObveznoRučno rezervirana količina.
on_handCijeli brojObveznoFizička količina na zalihi.
reservedCijeli brojObveznoKoličina rezervirana narudžbama.
sellable_limitCijeli brojObveznoOgraničenje prodaje: -1 znači neograničeno, a 0 onemogućuje dostupnu prodaju.
target_idNiz znakovaObveznoIdentifikator proizvoda ili varijante na koju operacija utječe.
target_typeNiz znakovaObveznoOdnosi li se operacija na proizvod ili varijantu.
Ograničenja
enum["product", "variant"]
total_reservedCijeli brojObveznoUkupno rezervirana količina.
updated_atNiz znakovaObveznoVrijeme posljednjeg ažuriranja.
format:"date-time"versionCijeli brojObveznoVerzija resursa za kontrolu istodobnih upisa.
warehouse_idNiz znakovaObveznoIdentifikator skladišta.
Dodatna polja: Ne
Dohvati · Zalihe — Zalihe — Odgovor
StockDetailData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
activeLogička vrijednostObveznoJe li resurs aktivan.
allocationsPolje vrijednosti <AllocationData> ObveznoKoličine dodijeljene skladišnim lokacijama.
availableCijeli broj nullObveznoKoličina dostupna za prodaju; null označava neograničenu količinu.
idNiz znakovaObveznoIdentifikator resursa; sačuvajte ga u vraćenom obliku. (StockDetailData).
manual_reservedCijeli brojObveznoRučno rezervirana količina.
on_handCijeli brojObveznoFizička količina na zalihi.
reservedCijeli brojObveznoKoličina rezervirana narudžbama.
sellable_limitCijeli brojObveznoOgraničenje prodaje: -1 znači neograničeno, a 0 onemogućuje dostupnu prodaju.
target_idNiz znakovaObveznoIdentifikator proizvoda ili varijante na koju operacija utječe.
target_typeNiz znakovaObveznoOdnosi li se operacija na proizvod ili varijantu.
Ograničenja
enum["product", "variant"]
total_reservedCijeli brojObveznoUkupno rezervirana količina.
updated_atNiz znakovaObveznoVrijeme posljednjeg ažuriranja.
format:"date-time"versionCijeli brojObveznoVerzija resursa za kontrolu istodobnih upisa.
warehouse_idNiz znakovaObveznoIdentifikator skladišta.
Dodatna polja: Ne
UnitData
UnitData · Pročitaj najviše 100 jedinica po stranici. Popis prikazuje metapodatke bez otkrivanja kodova.
content_stateNiz znakovaObveznoStanje sadržaja: present / deleting / deleted.
delivery_idNiz znakova nullObveznoID isporuke ili dodjele narudžbi.
filenameNiz znakova nullObveznoDatoteka
idNiz znakovaObveznoIdentifikator resursa; sačuvajte ga u vraćenom obliku.
format:"uuid"issued_atNiz znakova nullObveznoPrvo izdavanje; prije njega null.
Niz znakova:format:"date-time"kindNiz znakovaObveznoVarijanta strukture podataka opisana dopuštenim vrijednostima.
Ograničenja
enum["file", "code"]
location_idNiz znakova nullObveznoIdentifikator skladišne lokacije.
mime_typeNiz znakova nullObveznoVrsta medijskog sadržaja.
payload_idNiz znakovaObveznoID sadržaja; nije javna adresa za preuzimanje.
format:"uuid"product_idNiz znakovaObveznoIdentifikator proizvoda.
size_bytesCijeli broj nullObveznoVeličina u bajtovima
sort_orderCijeli brojObveznoPoložaj u uređenoj zbirci.
stateNiz znakovaObveznoStatus
versionCijeli brojObveznoVerzija resursa za kontrolu istodobnih upisa.
warehouse_idNiz znakova nullObveznoIdentifikator skladišta.
Dodatna polja: Ne
UnitDeletion
UnitDeletion · Ukloni neprodani kod ili datoteku uz razlog. Rezervirane ili dodijeljene jedinice odbijaju se.
expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1reasonNiz znakovaObveznoRazlog zabilježen za promjenu.
minLength:1maxLength:500
Dodatna polja: Ne
UnitReorder
UnitReorder · Pošalji cijelu nefiltriranu stranicu željenim redoslijedom. Zastarjela verzija vraća 409.
expected_order_versionCijeli brojObveznoVerzija redoslijeda dodjele, a ne kupčeve narudžbe.
minimum:1unit_idsPolje vrijednosti <Niz znakova> ObveznoSve jedinice nefiltrirane stranice željenim redoslijedom.
minItems:2maxItems:100Polje vrijednosti:format:"uuid"window_cursorNiz znakova nullNeobaveznoPokazivač nefiltrirane stranice; null za prvu stranicu.
Niz znakova:maxLength:1024
Dodatna polja: Ne
UnitReplacement
UnitReplacement · Zamijeni kod ili datoteku bez promjene redoslijeda. Izmjena ostaje u povijesti skladišta.
codeNiz znakova nullNeobaveznoTočan digitalni kod. Sačuvajte velika i mala slova te unutarnje razmake.
Niz znakova:minLength:1maxLength:512expected_versionCijeli brojObveznoVerzija pročitana prije upisa; nepodudaranje odbija ažuriranje.
minimum:1reasonNiz znakovaObveznoRazlog zabilježen za promjenu.
minLength:1maxLength:500upload_idNiz znakova nullNeobaveznoIdentifikator resursa; sačuvajte ga u vraćenom obliku. · upload_id
Niz znakova:format:"uuid"
Dodatna polja: Ne
UnitsData
UnitsData · Pročitaj najviše 100 jedinica po stranici. Popis prikazuje metapodatke bez otkrivanja kodova.
order_versionCijeli brojObveznoVerzija redoslijeda dodjele zalihe.
totalCijeli brojObveznoUkupan iznos.
unitsPolje vrijednosti <UnitData> ObveznoMetapodaci jedinica; sadržaj traži zaseban ovlašteni zahtjev.
Dodatna polja: Da