Andmeskeemid
Laoasukohtadele määratud kogused
AllocationData · Skeem · Andmeskeemid: Laoseis
location_codeStringKohustuslikLaoasukoha kood.
location_idStringKohustuslikLaoasukoha identifikaator.
location_nameStringKohustuslikLaoasukoha nimi.
on_handTäisarvKohustuslikFüüsiline laokogus.
Lisaväljad: Ei
ApiResponse[CodeContentData]
ApiResponse_CodeContentData_ · Kood tagastatakse JSON-ina, fail binaarselt. Iga päring vajab Bearerit ja õigust reveal.
dataCodeContentDataKohustuslikEduka vastuse andmed.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Lisaväljad: Ei
ApiResponse[DigitalUploadData]
ApiResponse_DigitalUploadData_ · Kontrolli suurust, kontrollsummat ja vormingut. Valmis üleslaadimine ei tähenda veel vastuvõetud tarnet.
dataDigitalUploadDataKohustuslikEduka vastuse andmed.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Lisaväljad: Ei
ApiResponse[ImportData]
ApiResponse_ImportData_ · Kontrolli olekut, versiooni ja valideerimist. Mustand kuulub selle loonud API-võtmele.
dataImportDataKohustuslikEduka vastuse andmed.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Lisaväljad: Ei
Loend · Laoseis — Laoseis — Vastus
ApiResponse_list_StockData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataMassiiv <StockData> KohustuslikVastuse näide · ApiResponse_list_StockData__.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Lisaväljad: Ei
ApiResponse[PoolData]
ApiResponse_PoolData_ · Loe seadeid ja koguseid enne muutmist. Vastus ei sisalda koode ega failide sisu.
dataPoolDataKohustuslikEduka vastuse andmed.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Lisaväljad: Ei
Hangi · Laoseis — Laoseis — Vastus
ApiResponse_StockDetailData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataStockDetailDataKohustuslikVastuse näide · StockDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Lisaväljad: Ei
ApiResponse[UnitsData]
ApiResponse_UnitsData_ · Loe kuni 100 ühikut lehel. Loend näitab metaandmeid koode avaldamata.
dataUnitsDataKohustuslikEduka vastuse andmed.
metaContextPageMetaContextMetaPageMetaRequestMetaKohustuslikVastuse metaandmed.
Lisaväljad: Ei
CodeContentData
CodeContentData · Kood tagastatakse JSON-ina, fail binaarselt. Iga päring vajab Bearerit ja õigust reveal.
codeStringKohustuslikDigitaalse koodi täpne sisu. Säilita tõstutundlikkus ja koodis olevad tühikud.
minLength:1maxLength:512delivery_idString nullValikulineTarne või tellimuse väljastuse ID.
String:format:"uuid"kindStringValikulineAndmestruktuuri variant, mida kirjeldavad lubatud väärtused.
const:"code"payload_idStringKohustuslikSisu ID; ei ole avalik allalaadimis-URL.
format:"uuid"unit_idStringKohustuslikÜhe individuaalse koodi või faili ID.
format:"uuid"
Lisaväljad: Ei
DigitalUploadCreate
DigitalUploadCreate · Broneeri failile ruum ja seo see impordi või asendatava ühikuga.
consumer_idStringKohustuslikSeotud impordi või ühiku ID.
format:"uuid"consumer_kindStringKohustuslikÜleslaadimise seos: digital_import / digital_unit.
Piirangud
enum["digital_import", "digital_unit"]
filenameStringKohustuslikFail
minLength:1maxLength:255purposeStringKohustuslikdigital_import: TXT/CSV; digital_unit: eraldi müüdav fail.
Piirangud
enum["digital_unit", "digital_import"]
sha256StringKohustuslikSHA-256 (hex, 64)
Piirangud
pattern"^[0-9a-f]{64}$"
size_bytesTäisarvKohustuslikSuurus baitides
minimum:1maximum:262144000
Lisaväljad: Ei
DigitalUploadData
DigitalUploadData · Kontrolli suurust, kontrollsummat ja vormingut. Valmis üleslaadimine ei tähenda veel vastuvõetud tarnet.
consumer_idStringKohustuslikSeotud impordi või ühiku ID.
format:"uuid"consumer_kindStringKohustuslikÜleslaadimise seos: digital_import / digital_unit.
Piirangud
enum["digital_import", "digital_unit"]
expires_atStringKohustuslikSelle üleslaadimise või impordi aegumisaeg.
format:"date-time"filenameStringKohustuslikFail
idStringKohustuslikRessursi identifikaator; säilita see tagastatud kujul.
format:"uuid"product_idStringKohustuslikToote identifikaator.
purposeStringKohustuslikdigital_import: TXT/CSV; digital_unit: eraldi müüdav fail.
Piirangud
enum["digital_unit", "digital_import"]
received_bytesTäisarvKohustuslikÜleslaadimine… · Suurus baitides
sha256StringKohustuslikSHA-256 (hex, 64)
size_bytesTäisarvKohustuslikSuurus baitides
statusStringKohustuslikSelle konkreetse toimingu lubatud olek.
Lisaväljad: Ei
ImportCommit
ImportCommit · Loo kontrollitud partiist kavandatud või vastuvõetud tarne. Kavandatud ühikud pole veel müüdavad.
delivered_atStringKohustuslikTarne kuupäev ja kellaaeg.
format:"date-time"expected_delivery_versionTäisarvKohustuslikTarne versioon; uue tarne korral 0.
minimum:0maximum:0expected_sales_limit_versionTäisarv nullValikulineMüügilimiidi versioon; nõutud publish_for_sale=true korral.
Täisarv:minimum:0maximum:9223372036854775807expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1maximum:9223372036854775807location_idStringKohustuslikLaoasukoha identifikaator.
Piirangud
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
publish_for_saleTõeväärtusValikulinetrue suurendab ka lõplikku müügilimiiti; false ei muuda seda.
statusStringKohustuslikSelle konkreetse toimingu lubatud olek.
Piirangud
enum["planned", "received"]
validation_digestStringKohustuslikKontrolli kontrollsumma; saada kinnitamisel muutmata kujul.
Piirangud
pattern"^[0-9a-f]{64}$"
warehouse_idStringKohustuslikLao identifikaator.
Piirangud
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Lisaväljad: Ei
ImportCreate
ImportCreate · Loo mustand kuni 1000 koodi või 100 failiga. Müüdav varu veel ei suurene.
countTäisarvKohustuslikPartii täpne ühikute arv.
minimum:1maximum:1000kindStringKohustuslikAndmestruktuuri variant, mida kirjeldavad lubatud väärtused.
Piirangud
enum["code", "file"]
Lisaväljad: Ei
ImportData
ImportData · Kontrolli olekut, versiooni ja valideerimist. Mustand kuulub selle loonud API-võtmele.
delivery_idString nullKohustuslikTarne või tellimuse väljastuse ID.
delivery_statusString nullKohustuslikTarne olek: planned / received; enne kinnitamist null.
delivery_versionTäisarv nullKohustuslikLaotarne praegune versioon.
expected_countTäisarvKohustuslikOodatud arv; vastu võetakse ainult terve partii.
expires_atStringKohustuslikSelle üleslaadimise või impordi aegumisaeg.
format:"date-time"idStringKohustuslikRessursi identifikaator; säilita see tagastatud kujul.
format:"uuid"kindStringKohustuslikAndmestruktuuri variant, mida kirjeldavad lubatud väärtused.
Piirangud
enum["code", "file"]
product_idStringKohustuslikToote identifikaator.
statusStringKohustuslikSelle konkreetse toimingu lubatud olek.
validated_countTäisarvKohustuslikViimases edukas kontrollis heaks kiidetud ühikute arv.
validation_digestString nullKohustuslikKontrolli kontrollsumma; saada kinnitamisel muutmata kujul.
versionTäisarvKohustuslikRessursi versioon samaaegsuse kontrolliks.
Lisaväljad: Ei
ImportReceive
ImportReceive · Võta olemasolevad ühikud vastu koode või faile uuesti importimata.
expected_delivery_versionTäisarvKohustuslikTarne versioon; uue tarne korral 0.
minimum:1maximum:9223372036854775807expected_sales_limit_versionTäisarv nullValikulineMüügilimiidi versioon; nõutud publish_for_sale=true korral.
Täisarv:minimum:0maximum:9223372036854775807expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1maximum:9223372036854775807publish_for_saleTõeväärtusValikulinetrue suurendab ka lõplikku müügilimiiti; false ei muuda seda.
Lisaväljad: Ei
ImportValidate
ImportValidate · Kontrolli kogu partiid. Duplikaat või vigane kirje lükkab partii tagasi; koode ei kärbita.
code_columnString nullValikulineKoode sisaldav CSV-veerg; kasuta code.
String:const:"code"expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1maximum:9223372036854775807formatString nullValikulineKoodiloend: txt / csv; failidel kasuta upload_ids.
Piirangud · String 1
enum["txt", "csv"]
source_upload_idString nullValikulineSelle impordi valmis privaatne TXT/CSV-üleslaadimine.
String:format:"uuid"upload_idsMassiiv <String> nullValikuline1–100 selle impordi valmis privaatset failiüleslaadimist.
Massiiv:minItems:1maxItems:100Massiiv / Massiiv:format:"uuid"
Lisaväljad: Ei
ImportWithdrawal
ImportWithdrawal · Eemalda ainult vabad ühikud. Broneeritud ja väljastatud ühikud jäävad tellimustega seotuks.
expected_delivery_versionTäisarvKohustuslikTarne versioon; uue tarne korral 0.
minimum:1maximum:9223372036854775807expected_order_versionTäisarvKohustuslikVäljastamise järjekorra versioon, mitte klienditellimuse versioon.
minimum:0maximum:9223372036854775807expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1maximum:9223372036854775807reasonStringKohustuslikMuudatuse juurde salvestatud põhjus.
minLength:1maxLength:500
Lisaväljad: Ei
Muuda · Käsitsi broneering — Laoseis — Päringu sisu
ManualReservationUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1maximum:9223372036854775807manual_reservedTäisarvKohustuslikKäsitsi reserveeritud kogus.
minimum:0maximum:2147483647reasonStringValikulineMuudatuse juurde salvestatud põhjus.
maxLength:500
Lisaväljad: Ei
PoolChange
PoolChange · Luba individuaalsed koodid või failid alates Professionalist. Väljalülitamine säilitab varasemate ostude ligipääsu.
email_modeStringValikulinedisabled: kirja ei saadeta; order_link: tellimuse link; code_text: lisaks võimalikud koodid.
Piirangud
enum["disabled", "order_link", "code_text"]
enabledTõeväärtusKohustuslikKas see säte on lubatud.
expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:0maximum:9223372036854775807retention_daysTäisarv nullValikulinenull: tähtajatu; 1–3650 päeva esimesest ligipääsust. Koode automaatselt ei kustutata.
Täisarv:minimum:1maximum:3650
Lisaväljad: Ei
PoolCounts
PoolCounts · Loe seadeid ja koguseid enne muutmist. Vastus ei sisalda koode ega failide sisu.
availableTäisarvKohustuslikVabade üksuste arv, mida pole reserveeritud ega väljastatud.
heldTäisarvKohustuslikTellimustele broneeritud, veel väljastamata ühikud.
issuedTäisarvKohustuslikTasutud ostudele juba väljastatud ühikud.
plannedTäisarvKohustuslikKinnitatud, veel vastuvõtmata tarnete ühikud.
retiredTäisarvKohustuslikTagasivõetud ühikud, mis säilivad ajaloos.
stagedTäisarvKohustuslikPooleliolevate importide ühikud, veel mitte laovaru.
Lisaväljad: Ei
PoolData
PoolData · Loe seadeid ja koguseid enne muutmist. Vastus ei sisalda koode ega failide sisu.
configuredTõeväärtusKohustuslikKas digivaru seaded on salvestatud.
countsPoolCountsKohustuslikÜhikute arv laooleku kaupa.
email_modeStringKohustuslikdisabled: kirja ei saadeta; order_link: tellimuse link; code_text: lisaks võimalikud koodid.
Piirangud
enum["disabled", "order_link", "code_text"]
enabledTõeväärtusKohustuslikKas see säte on lubatud.
order_versionTäisarvKohustuslikDigivaru väljastamise järjekorra versioon.
product_idStringKohustuslikToote identifikaator.
retention_daysTäisarv nullKohustusliknull: tähtajatu; 1–3650 päeva esimesest ligipääsust. Koode automaatselt ei kustutata.
versionTäisarvKohustuslikRessursi versioon samaaegsuse kontrolliks.
Lisaväljad: Ei
Muuda · Müügilimiit — Laoseis — Päringu sisu
SalesLimitUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1maximum:9223372036854775807reasonStringValikulineMuudatuse juurde salvestatud põhjus.
maxLength:500sellable_limitTäisarvKohustuslikMüügipiirang: -1 tähendab piiramatut kogust ja 0 keelab müügi.
minimum:-1maximum:2147483647
Lisaväljad: Ei
Loo · Laoseisu korrigeerimine — Laoseis — Päringu sisu
StockAdjustmentCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:0maximum:9223372036854775807locationsMassiiv <LocationQuantity> KohustuslikLaoasukohtade loend.
minItems:1maxItems:100reasonStringKohustuslikMuudatuse juurde salvestatud põhjus.
minLength:1maxLength:500target_idStringKohustuslikToimingust mõjutatud toote või variandi identifikaator.
Piirangud
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeStringKohustuslikKas toiming puudutab toodet või varianti.
Piirangud
enum["product", "variant"]
warehouse_idStringKohustuslikLao identifikaator.
Piirangud
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Lisaväljad: Ei
Muuda · Laoseis — Laoseis — Päringu sisu
StockAdjustmentUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1maximum:9223372036854775807locationsMassiiv <LocationQuantity> KohustuslikLaoasukohtade loend.
minItems:1maxItems:100reasonStringKohustuslikMuudatuse juurde salvestatud põhjus.
minLength:1maxLength:500
Lisaväljad: Ei
Loend · Laoseis — Laoseis — Vastus
StockData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
activeTõeväärtusKohustuslikKas ressurss on aktiivne.
availableTäisarv nullKohustuslikMüügiks saadaolev kogus; null tähistab piiramatut kogust.
idStringKohustuslikRessursi identifikaator; säilita see tagastatud kujul. (StockData).
manual_reservedTäisarvKohustuslikKäsitsi reserveeritud kogus.
on_handTäisarvKohustuslikFüüsiline laokogus.
reservedTäisarvKohustuslikTellimustega reserveeritud kogus.
sellable_limitTäisarvKohustuslikMüügipiirang: -1 tähendab piiramatut kogust ja 0 keelab müügi.
target_idStringKohustuslikToimingust mõjutatud toote või variandi identifikaator.
target_typeStringKohustuslikKas toiming puudutab toodet või varianti.
Piirangud
enum["product", "variant"]
total_reservedTäisarvKohustuslikReserveeritud kogus kokku.
updated_atStringKohustuslikViimase uuendamise aeg.
format:"date-time"versionTäisarvKohustuslikRessursi versioon samaaegsuse kontrolliks.
warehouse_idStringKohustuslikLao identifikaator.
Lisaväljad: Ei
Hangi · Laoseis — Laoseis — Vastus
StockDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
activeTõeväärtusKohustuslikKas ressurss on aktiivne.
allocationsMassiiv <AllocationData> KohustuslikLaoasukohtadele määratud kogused.
availableTäisarv nullKohustuslikMüügiks saadaolev kogus; null tähistab piiramatut kogust.
idStringKohustuslikRessursi identifikaator; säilita see tagastatud kujul. (StockDetailData).
manual_reservedTäisarvKohustuslikKäsitsi reserveeritud kogus.
on_handTäisarvKohustuslikFüüsiline laokogus.
reservedTäisarvKohustuslikTellimustega reserveeritud kogus.
sellable_limitTäisarvKohustuslikMüügipiirang: -1 tähendab piiramatut kogust ja 0 keelab müügi.
target_idStringKohustuslikToimingust mõjutatud toote või variandi identifikaator.
target_typeStringKohustuslikKas toiming puudutab toodet või varianti.
Piirangud
enum["product", "variant"]
total_reservedTäisarvKohustuslikReserveeritud kogus kokku.
updated_atStringKohustuslikViimase uuendamise aeg.
format:"date-time"versionTäisarvKohustuslikRessursi versioon samaaegsuse kontrolliks.
warehouse_idStringKohustuslikLao identifikaator.
Lisaväljad: Ei
UnitData
UnitData · Loe kuni 100 ühikut lehel. Loend näitab metaandmeid koode avaldamata.
content_stateStringKohustuslikSisu olek: present / deleting / deleted.
delivery_idString nullKohustuslikTarne või tellimuse väljastuse ID.
filenameString nullKohustuslikFail
idStringKohustuslikRessursi identifikaator; säilita see tagastatud kujul.
format:"uuid"issued_atString nullKohustuslikEsimene väljastus; enne seda null.
String:format:"date-time"kindStringKohustuslikAndmestruktuuri variant, mida kirjeldavad lubatud väärtused.
Piirangud
enum["file", "code"]
location_idString nullKohustuslikLaoasukoha identifikaator.
mime_typeString nullKohustuslikMeedia sisutüüp.
payload_idStringKohustuslikSisu ID; ei ole avalik allalaadimis-URL.
format:"uuid"product_idStringKohustuslikToote identifikaator.
size_bytesTäisarv nullKohustuslikSuurus baitides
sort_orderTäisarvKohustuslikAsukoht järjestatud kogumis.
stateStringKohustuslikOlek
versionTäisarvKohustuslikRessursi versioon samaaegsuse kontrolliks.
warehouse_idString nullKohustuslikLao identifikaator.
Lisaväljad: Ei
UnitDeletion
UnitDeletion · Eemalda müümata kood või fail koos põhjusega. Broneeritud või väljastatud ühikuid ei lubata.
expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1reasonStringKohustuslikMuudatuse juurde salvestatud põhjus.
minLength:1maxLength:500
Lisaväljad: Ei
UnitReorder
UnitReorder · Saada terve filtreerimata leht soovitud järjekorras. Aegunud versioon tagastab 409.
expected_order_versionTäisarvKohustuslikVäljastamise järjekorra versioon, mitte klienditellimuse versioon.
minimum:1unit_idsMassiiv <String> KohustuslikKõik filtreerimata lehe ühikud soovitud järjekorras.
minItems:2maxItems:100Massiiv:format:"uuid"window_cursorString nullValikulineFiltreerimata lehe kursor; esimesel lehel null.
String:maxLength:1024
Lisaväljad: Ei
UnitReplacement
UnitReplacement · Asenda kood või fail järjekorda muutmata. Muudatus jääb lao ajalukku.
codeString nullValikulineDigitaalse koodi täpne sisu. Säilita tõstutundlikkus ja koodis olevad tühikud.
String:minLength:1maxLength:512expected_versionTäisarvKohustuslikEnne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.
minimum:1reasonStringKohustuslikMuudatuse juurde salvestatud põhjus.
minLength:1maxLength:500upload_idString nullValikulineRessursi identifikaator; säilita see tagastatud kujul. · upload_id
String:format:"uuid"
Lisaväljad: Ei
UnitsData
UnitsData · Loe kuni 100 ühikut lehel. Loend näitab metaandmeid koode avaldamata.
order_versionTäisarvKohustuslikDigivaru väljastamise järjekorra versioon.
totalTäisarvKohustuslikKogusumma.
unitsMassiiv <UnitData> KohustuslikÜhikute metaandmed; sisu vajab eraldi volitatud päringut.
Lisaväljad: Jah