Podatkovne sheme
Količine, dodeljene lokacijam skladišča
AllocationData · Shema · Podatkovne sheme: Zaloga
location_codeNizObveznoKoda lokacije skladišča.
location_idNizObveznoIdentifikator lokacije skladišča.
location_nameNizObveznoIme lokacije skladišča.
on_handCelo številoObveznoFizična količina na zalogi.
Dodatna polja: Ne
ApiResponse[CodeContentData]
ApiResponse_CodeContentData_ · Koda se vrne kot JSON, datoteka kot binarni podatki. Vsaka zahteva potrebuje Bearer in pravico reveal.
dataCodeContentDataObveznoVsebina uspešnega odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
Dodatna polja: Ne
ApiResponse[DigitalUploadData]
ApiResponse_DigitalUploadData_ · Preveri velikost, kontrolno vsoto in obliko. Končan prenos še ne pomeni prejete dobave.
dataDigitalUploadDataObveznoVsebina uspešnega odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
Dodatna polja: Ne
ApiResponse[ImportData]
ApiResponse_ImportData_ · Preveri stanje, različico in potrditev. Osnutek pripada ključu API, ki ga je ustvaril.
dataImportDataObveznoVsebina uspešnega odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
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> ObveznoPrimer odgovora · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
Dodatna polja: Ne
ApiResponse[PoolData]
ApiResponse_PoolData_ · Pred spremembo preberi nastavitve in količine. Odgovor ne vsebuje kod ali vsebine datotek.
dataPoolDataObveznoVsebina uspešnega odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
Dodatna polja: Ne
Pridobi · Zaloge — Zaloga — Odgovor
ApiResponse_StockDetailData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataStockDetailDataObveznoPrimer odgovora · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
Dodatna polja: Ne
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Preberi največ 100 enot na stran. Seznam kaže metapodatke brez razkritja kod.
dataUnitsDataObveznoVsebina uspešnega odgovora.
metaContextPageMetaContextMetaPageMetaRequestMetaObveznoMetapodatki odgovora.
Dodatna polja: Ne
CodeContentData
CodeContentData · Koda se vrne kot JSON, datoteka kot binarni podatki. Vsaka zahteva potrebuje Bearer in pravico reveal.
codeNizObveznoNatančna digitalna koda. Ohranite velike črke in notranje presledke.
minLength:1maxLength:512delivery_idNiz nullIzbirnoID dobave ali dodelitve naročila.
Niz:format:"uuid"kindNizIzbirnoVrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.
const:"code"payload_idNizObveznoID vsebine; ni javni naslov za prenos.
format:"uuid"unit_idNizObveznoID posamezne kode ali datoteke.
format:"uuid"
Dodatna polja: Ne
DigitalUploadCreate
DigitalUploadCreate · Rezerviraj prostor za datoteko in jo poveži z uvozom ali enoto za zamenjavo.
consumer_idNizObveznoID povezanega uvoza ali enote.
format:"uuid"consumer_kindNizObveznoPovezava prenosa: digital_import / digital_unit.
Omejitve
enum["digital_import", "digital_unit"]
filenameNizObveznoDatoteka
minLength:1maxLength:255purposeNizObveznodigital_import: TXT/CSV; digital_unit: posamično prodana datoteka.
Omejitve
enum["digital_unit", "digital_import"]
sha256NizObveznoSHA-256 (hex, 64)
Omejitve
pattern"^[0-9a-f]{64}$"
size_bytesCelo številoObveznoVelikost v bajtih
minimum:1maximum:262144000
Dodatna polja: Ne
DigitalUploadData
DigitalUploadData · Preveri velikost, kontrolno vsoto in obliko. Končan prenos še ne pomeni prejete dobave.
consumer_idNizObveznoID povezanega uvoza ali enote.
format:"uuid"consumer_kindNizObveznoPovezava prenosa: digital_import / digital_unit.
Omejitve
enum["digital_import", "digital_unit"]
expires_atNizObveznoČas poteka tega nalaganja ali uvoza.
format:"date-time"filenameNizObveznoDatoteka
idNizObveznoIdentifikator vira; ohranite ga v vrnjeni obliki.
format:"uuid"product_idNizObveznoIdentifikator izdelka.
purposeNizObveznodigital_import: TXT/CSV; digital_unit: posamično prodana datoteka.
Omejitve
enum["digital_unit", "digital_import"]
received_bytesCelo številoObveznoNalaganje… · Velikost v bajtih
sha256NizObveznoSHA-256 (hex, 64)
size_bytesCelo številoObveznoVelikost v bajtih
statusNizObveznoStatus, ki ga sprejema ta operacija.
Dodatna polja: Ne
ImportCommit
ImportCommit · Iz preverjene serije ustvari načrtovano ali prejeto dobavo. Načrtovane enote še niso naprodaj.
delivered_atNizObveznoDatum in čas dostave.
format:"date-time"expected_delivery_versionCelo številoObveznoRazličica dobave; 0 za novo dobavo.
minimum:0maximum:0expected_sales_limit_versionCelo število nullIzbirnoRazličica prodajne omejitve; obvezna pri publish_for_sale=true.
Celo število:minimum:0maximum:9223372036854775807expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1maximum:9223372036854775807location_idNizObveznoIdentifikator lokacije skladišča.
Omejitve
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleLogična vrednostIzbirnotrue poveča tudi končno prodajno omejitev; false je ne spremeni.
statusNizObveznoStatus, ki ga sprejema ta operacija.
Omejitve
enum["planned", "received"]
validation_digestNizObveznoKontrolna vsota preverjanja; ob potrditvi jo pošlji nespremenjeno.
Omejitve
pattern"^[0-9a-f]{64}$"
warehouse_idNizObveznoIdentifikator skladišča.
Omejitve
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Dodatna polja: Ne
ImportCreate
ImportCreate · Pripravi osnutek z največ 1000 kodami ali 100 datotekami. Prodajna zaloga se še ne poveča.
countCelo številoObveznoTočno število enot v seriji.
minimum:1maximum:1000kindNizObveznoVrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.
Omejitve
enum["code", "file"]
Dodatna polja: Ne
ImportData
ImportData · Preveri stanje, različico in potrditev. Osnutek pripada ključu API, ki ga je ustvaril.
delivery_idNiz nullObveznoID dobave ali dodelitve naročila.
delivery_statusNiz nullObveznoStanje dobave: planned / received; pred potrditvijo null.
delivery_versionCelo število nullObveznoTrenutna različica skladiščne dobave.
expected_countCelo številoObveznoPričakovano število; sprejme se le celotna serija.
expires_atNizObveznoČas poteka tega nalaganja ali uvoza.
format:"date-time"idNizObveznoIdentifikator vira; ohranite ga v vrnjeni obliki.
format:"uuid"kindNizObveznoVrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.
Omejitve
enum["code", "file"]
product_idNizObveznoIdentifikator izdelka.
statusNizObveznoStatus, ki ga sprejema ta operacija.
validated_countCelo številoObveznoŠtevilo enot, sprejetih pri zadnjem uspešnem preverjanju.
validation_digestNiz nullObveznoKontrolna vsota preverjanja; ob potrditvi jo pošlji nespremenjeno.
versionCelo številoObveznoRazličica vira za nadzor sočasnosti.
Dodatna polja: Ne
ImportReceive
ImportReceive · Prejmi obstoječe enote brez ponovnega uvoza kod ali datotek.
expected_delivery_versionCelo številoObveznoRazličica dobave; 0 za novo dobavo.
minimum:1maximum:9223372036854775807expected_sales_limit_versionCelo število nullIzbirnoRazličica prodajne omejitve; obvezna pri publish_for_sale=true.
Celo število:minimum:0maximum:9223372036854775807expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1maximum:9223372036854775807publish_for_saleLogična vrednostIzbirnotrue poveča tudi končno prodajno omejitev; false je ne spremeni.
Dodatna polja: Ne
ImportValidate
ImportValidate · Preveri celotno serijo. Podvojena ali neveljavna postavka zavrne serijo; kode se ne krajšajo.
code_columnNiz nullIzbirnoStolpec CSV s kodami; uporabi code.
Niz:const:"code"expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1maximum:9223372036854775807formatNiz nullIzbirnoSeznam kod: txt / csv; za datoteke uporabi upload_ids.
Omejitve · Niz 1
enum["txt", "csv"]
source_upload_idNiz nullIzbirnoPripravljen zasebni prenos TXT/CSV tega uvoza.
Niz:format:"uuid"upload_idsPolje elementov <Niz> nullIzbirno1–100 pripravljenih zasebnih prenosov datotek tega uvoza.
Polje elementov:minItems:1maxItems:100Polje elementov / Polje elementov:format:"uuid"
Dodatna polja: Ne
ImportWithdrawal
ImportWithdrawal · Umakni samo proste enote. Rezervirane in dodeljene enote ostanejo povezane z naročili.
expected_delivery_versionCelo številoObveznoRazličica dobave; 0 za novo dobavo.
minimum:1maximum:9223372036854775807expected_order_versionCelo številoObveznoRazličica vrstnega reda dodeljevanja, ne kupčevega naročila.
minimum:0maximum:9223372036854775807expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1maximum:9223372036854775807reasonNizObveznoZabeleženi razlog spremembe.
minLength:1maxLength:500
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 številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1maximum:9223372036854775807manual_reservedCelo številoObveznoRočno rezervirana količina.
minimum:0maximum:2147483647reasonNizIzbirnoZabeleženi razlog spremembe.
maxLength:500
Dodatna polja: Ne
PoolChange
PoolChange · Vključi posamezne kode ali datoteke od paketa Professional. Izklop ohrani dostop do prejšnjih nakupov.
email_modeNizIzbirnodisabled: brez e-pošte; order_link: povezava do naročila; code_text: možne tudi kode.
Omejitve
enum["disabled", "order_link", "code_text"]
enabledLogična vrednostObveznoAli je nastavitev omogočena.
expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:0maximum:9223372036854775807retention_daysCelo število nullIzbirnonull: brez roka; 1–3650 dni od prvega dostopa. Kode se ne brišejo samodejno.
Celo število:minimum:1maximum:3650
Dodatna polja: Ne
PoolCounts
PoolCounts · Pred spremembo preberi nastavitve in količine. Odgovor ne vsebuje kod ali vsebine datotek.
availableCelo številoObveznoŠtevilo prostih enot, ki niso rezervirane ali izdane.
heldCelo številoObveznoEnote, rezervirane za naročila, še niso izdane.
issuedCelo številoObveznoEnote, že izdane za plačane nakupe.
plannedCelo številoObveznoEnote potrjenih, še neprejetih dobav.
retiredCelo številoObveznoUmaknjene enote, ohranjene v zgodovini.
stagedCelo številoObveznoEnote nedokončanih uvozov, še niso zaloga.
Dodatna polja: Ne
PoolData
PoolData · Pred spremembo preberi nastavitve in količine. Odgovor ne vsebuje kod ali vsebine datotek.
configuredLogična vrednostObveznoAli so nastavitve digitalne zaloge shranjene.
countsPoolCountsObveznoŠtevilo enot po stanju zaloge.
email_modeNizObveznodisabled: brez e-pošte; order_link: povezava do naročila; code_text: možne tudi kode.
Omejitve
enum["disabled", "order_link", "code_text"]
enabledLogična vrednostObveznoAli je nastavitev omogočena.
order_versionCelo številoObveznoRazličica vrstnega reda dodeljevanja zaloge.
product_idNizObveznoIdentifikator izdelka.
retention_daysCelo število nullObveznonull: brez roka; 1–3650 dni od prvega dostopa. Kode se ne brišejo samodejno.
versionCelo številoObveznoRazličica vira za nadzor sočasnosti.
Dodatna polja: Ne
Posodobi · Prodajna omejitev — Zaloga — Telo zahteve
SalesLimitUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1maximum:9223372036854775807reasonNizIzbirnoZabeleženi razlog spremembe.
maxLength:500sellable_limitCelo številoObveznoProdajna omejitev: -1 pomeni neomejeno, 0 pa onemogoči razpoložljivo prodajo.
minimum:-1maximum:2147483647
Dodatna polja: Ne
Ustvari · Popravek zalog — Zaloga — Telo zahteve
StockAdjustmentCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:0maximum:9223372036854775807locationsPolje elementov <LocationQuantity> ObveznoLokacije skladišča.
minItems:1maxItems:100reasonNizObveznoZabeleženi razlog spremembe.
minLength:1maxLength:500target_idNizObveznoIdentifikator izdelka ali različice, na katero vpliva operacija.
Omejitve
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeNizObveznoAli se operacija nanaša na izdelek ali različico.
Omejitve
enum["product", "variant"]
warehouse_idNizObveznoIdentifikator skladišča.
Omejitve
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Dodatna polja: Ne
Posodobi · Zaloge — Zaloga — Telo zahteve
StockAdjustmentUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1maximum:9223372036854775807locationsPolje elementov <LocationQuantity> ObveznoLokacije skladišča.
minItems:1maxItems:100reasonNizObveznoZabeleženi razlog spremembe.
minLength:1maxLength:500
Dodatna polja: Ne
Prikaži seznam · Zaloge — Zaloga — Odgovor
StockData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
activeLogična vrednostObveznoAli je vir aktiven.
availableCelo število nullObveznoKoličina, razpoložljiva za prodajo; null pomeni neomejeno količino.
idNizObveznoIdentifikator vira; ohranite ga v vrnjeni obliki. (StockData).
manual_reservedCelo številoObveznoRočno rezervirana količina.
on_handCelo številoObveznoFizična količina na zalogi.
reservedCelo številoObveznoKoličina, rezervirana z naročili.
sellable_limitCelo številoObveznoProdajna omejitev: -1 pomeni neomejeno, 0 pa onemogoči razpoložljivo prodajo.
target_idNizObveznoIdentifikator izdelka ali različice, na katero vpliva operacija.
target_typeNizObveznoAli se operacija nanaša na izdelek ali različico.
Omejitve
enum["product", "variant"]
total_reservedCelo številoObveznoSkupna rezervirana količina.
updated_atNizObveznoČas zadnje posodobitve.
format:"date-time"versionCelo številoObveznoRazličica vira za nadzor sočasnosti.
warehouse_idNizObveznoIdentifikator skladišča.
Dodatna polja: Ne
Pridobi · Zaloge — Zaloga — Odgovor
StockDetailData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
activeLogična vrednostObveznoAli je vir aktiven.
allocationsPolje elementov <AllocationData> ObveznoKoličine, dodeljene lokacijam skladišča.
availableCelo število nullObveznoKoličina, razpoložljiva za prodajo; null pomeni neomejeno količino.
idNizObveznoIdentifikator vira; ohranite ga v vrnjeni obliki. (StockDetailData).
manual_reservedCelo številoObveznoRočno rezervirana količina.
on_handCelo številoObveznoFizična količina na zalogi.
reservedCelo številoObveznoKoličina, rezervirana z naročili.
sellable_limitCelo številoObveznoProdajna omejitev: -1 pomeni neomejeno, 0 pa onemogoči razpoložljivo prodajo.
target_idNizObveznoIdentifikator izdelka ali različice, na katero vpliva operacija.
target_typeNizObveznoAli se operacija nanaša na izdelek ali različico.
Omejitve
enum["product", "variant"]
total_reservedCelo številoObveznoSkupna rezervirana količina.
updated_atNizObveznoČas zadnje posodobitve.
format:"date-time"versionCelo številoObveznoRazličica vira za nadzor sočasnosti.
warehouse_idNizObveznoIdentifikator skladišča.
Dodatna polja: Ne
UnitData
UnitData · Preberi največ 100 enot na stran. Seznam kaže metapodatke brez razkritja kod.
content_stateNizObveznoStanje vsebine: present / deleting / deleted.
delivery_idNiz nullObveznoID dobave ali dodelitve naročila.
filenameNiz nullObveznoDatoteka
idNizObveznoIdentifikator vira; ohranite ga v vrnjeni obliki.
format:"uuid"issued_atNiz nullObveznoPrva izdaja; pred njo null.
Niz:format:"date-time"kindNizObveznoVrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.
Omejitve
enum["file", "code"]
location_idNiz nullObveznoIdentifikator lokacije skladišča.
mime_typeNiz nullObveznoVrsta medijske vsebine.
payload_idNizObveznoID vsebine; ni javni naslov za prenos.
format:"uuid"product_idNizObveznoIdentifikator izdelka.
size_bytesCelo število nullObveznoVelikost v bajtih
sort_orderCelo številoObveznoPoložaj v urejeni zbirki.
stateNizObveznoStanje
versionCelo številoObveznoRazličica vira za nadzor sočasnosti.
warehouse_idNiz nullObveznoIdentifikator skladišča.
Dodatna polja: Ne
UnitDeletion
UnitDeletion · Odstrani neprodano kodo ali datoteko z razlogom. Rezervirane ali dodeljene enote se zavrnejo.
expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1reasonNizObveznoZabeleženi razlog spremembe.
minLength:1maxLength:500
Dodatna polja: Ne
UnitReorder
UnitReorder · Pošlji celotno nefiltrirano stran v želenem vrstnem redu. Zastarela različica vrne 409.
expected_order_versionCelo številoObveznoRazličica vrstnega reda dodeljevanja, ne kupčevega naročila.
minimum:1unit_idsPolje elementov <Niz> ObveznoVse enote nefiltrirane strani v želenem vrstnem redu.
minItems:2maxItems:100Polje elementov:format:"uuid"window_cursorNiz nullIzbirnoKazalec nefiltrirane strani; null za prvo stran.
Niz:maxLength:1024
Dodatna polja: Ne
UnitReplacement
UnitReplacement · Zamenjaj kodo ali datoteko brez spremembe vrstnega reda. Sprememba ostane v zgodovini skladišča.
codeNiz nullIzbirnoNatančna digitalna koda. Ohranite velike črke in notranje presledke.
Niz:minLength:1maxLength:512expected_versionCelo številoObveznoRazličica, prebrana pred zapisom; neujemanje zavrne posodobitev.
minimum:1reasonNizObveznoZabeleženi razlog spremembe.
minLength:1maxLength:500upload_idNiz nullIzbirnoIdentifikator vira; ohranite ga v vrnjeni obliki. · upload_id
Niz:format:"uuid"
Dodatna polja: Ne
UnitsData
UnitsData · Preberi največ 100 enot na stran. Seznam kaže metapodatke brez razkritja kod.
order_versionCelo številoObveznoRazličica vrstnega reda dodeljevanja zaloge.
totalCelo številoObveznoSkupni znesek.
unitsPolje elementov <UnitData> ObveznoMetapodatki enot; vsebina zahteva ločeno pooblaščeno zahtevo.
Dodatna polja: Da