Tartalomjegyzék

Click here to expand...

Keresés

License information

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
Terms of service : urn:tos
URI scheme

Host : localhost:8080

BasePath : /smartfront/services

Base-Api-Interface

Egyedi riport futtatása

Amennyiben a riport rendelkezik opcionális vagy kötelező paraméterekkel, azok megadhatók url paraméterek használatával, pl.: /customquery/cq01?parameter1=value1&parameter2=value2

Végpont típusa és neve

GET /customquery/{id}

Parameters

Type	Name	Description	Schema
Path	id required	Egyedi riport azonosító	string

Responses

HTTP Code	Description	Schema
200	OK	<Map«string,object »> array
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Partner-API-Interface

Partner adatok lekérdezése

Végpont típusa és neve

GET /partner/

Parameters

Type	Name	Description	Schema	Default
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	modifiedSince optional	Csak az adott időpont után módosított rekordok lekérdezése.	string (date)	"2000-01-01T01:00:00"
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0
Query	partnerId optional	Partner azonosító	string
Query	taxNumber optional	Adószám	string
Query	webshopLogin optional	Webshop belépés engedélyezett	boolean
Query	email optional	E-mail cím	boolean

Responses

HTTP Code 200	Description OK	Schema <PartnerDTO> array A PartnerDTO tartalmazza a partnerről átadott adatokat.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Partner létrehozás vagy frissítés

Végpont típusa és neve

PUT /partner/

Parameters

Type	Name	Description	Schema
Body	partnerDTO required	Partner objektum	PartnerDTO
string	webshopSettingsId optional	Webshop azonosító

Responses

HTTP Code	Description	Schema
200	OK	<string, object> map (A sikeres partnerfelvitel válaszában az partnerId szerepel)
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Product-API-Interface

Termék kategóriák lekérdezése

Végpont típusa és neve

GET /categories

Parameters

Type	Name	Description	Schema	Default
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0
Query	productCate goryId optional	Szülő kategória azonosító, opcionális. Ha nincs megadva, akkor a legfelsőbb szintű termékkategóriákat adja vissza	string

Responses

HTTP Code	Description	Schema
200	OK	<ProductCategoryDTO> array A ProductCategoryDTO tartalmazza a termékkategóriákról átadott adatokat.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Termék alapadatok lekérdezése

Végpont típusa és neve

GET /products

Parameters

Type	Name	Description	Schema	Default
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	modifiedSince optional	Csak az adott időpont után módosított rekordok lekérdezése.	string (date)	"2000-01-01T12:00:00.000"
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0
Query	priceListId optional	Árlista azonosító	string
Query	productCate goryId optional	Termék kategória azonosító, opcionális	string
Query	productCode optional	Termék kód, opcionális	string
Query	webshopVisible optional	Webshopban megjelenik	boolean

Responses

HTTP Code	Description	Schema
200	OK	<ProductDTO> array A ProductDTO tartalmazza az egyes termékekről átadott adatokat.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Inventory-API-Interface

Készlet adatok lekérdezése

Végpont típusa és neve

GET /inventory

Parameters

Type	Name	Description	Schema	Default
Query	availableOnly optional	Csak az elérhető készlet	boolean	"true"
Query	groupByStorage optional	Készlet lekérdezése raktáranként	boolean	"false"
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	modifiedSince optional	Csak az adott időpont után módosított rekordok lekérdezése.	string (date)	"2000-01-01T12:00:00.000"
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0
Query	productId optional	Termék azonosító, opcionális	string
Query	storageId optional	Raktár azonosító, opcionális	string

Responses

HTTP Code	Description	Schema
200	OK	<InventoryDTO> array Az InventoryDTO tartalmazza a készletekről átadott adatokat.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Order-API-Interface

Rendelések lekérdezése

Lekérdezhető a rendelések listája tételekkel, időrendben csökkenő sorrendben

Végpont típusa és neve

GET /order/

Parameters

Type	Name	Description	Schema	Default
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	modifiedSin ce optional	Csak az adott időpont után módosított rekordok lekérdezése.	string (date)	"2000-01-01T12:00:00.000"
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0
Query	partnerId optional	Partner azonosító	string

Responses

HTTP Code	Description	Schema
200	OK	<OrderDTO> array Az OrderDTO tartalmazza a rendelésekről átadott adatokat.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Rendelés létrehozása

Végpont típusa és neve

PUT /order/

Parameters

Type	Name	Description	Schema
Body	orderDTO required	Rendelés objektum	OrderDTO
string	webshopSettingsId optional	Webshop azonosító

Responses

HTTP Code	Description	Schema
200	OK	<string, object> map (A sikeres rendelésfelvitel válaszában az OrderId szerepel)
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Árlista azonosítók lekérdezése

Végpont típusa és neve

GET /pricelists

Parameters

Type	Name	Description	Schema	Default
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	modifiedSin ce optional	Csak az adott időpont után módosított rekordok lekérdezése	string (date)	"2000-01-01T12:00:00.000"
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0
Query	partnerId optional	Partner azonosító	string

Responses

HTTP Code	Description	Schema
200	OK	<string> array A sikeres válaszban a rendszerben szereplő árlista azonosítók szerepelnek.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Árlista lekérdezése árakkal

Végpont típusa és neve

GET /prices/{priceListId}

Parameters

Type	Name	Description	Schema	Default
Path	priceListId required	Árlista azonosító	string
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	modifiedSince optional	Csak az adott időpont után módosított rekordok lekérdezése	string (date)	"2000-01-01T12:00:00.000"
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0

Responses

HTTP Code	Description	Schema
200	OK	<PriceListDTO> A PriceListDTO tartalmazza a rendszerben szereplő árlisták fő adatait és az árlistákon szereplő termékek árait. Az árak a PriceDTO objektumban szerepelnek.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Finance-API-Interface

Számla letöltése PDF-ben

Végpont típusa és neve

GET /invoice/{partnerId}/{id}

Parameters

Type	Name	Description	Schema
Path	id required	Számla azonosító	string
Path	partnerId required	Partner azonosító	string

Responses

HTTP Code	Description	Schema
200	OK	Sikeres válasz esetén a számla kerül átadásra PDF-ben.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Számlák lekérdezése partnerhez

Lekérdezhető az adott partnerhez kapcsolódó számlák listája, tételekkel, időrendben csökkenő sorrendben.

Végpont típusa és neve

GET /invoices

Parameters

Type	Name	Description	Schema	Default
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)	25
Query	modifiedSince optional	Csak az adott időpont után módosított rekordok lekérdezése	string (date)	"2000-01-01T12:00:00.000"
Query	offset optional	Eltolás mértéke (rekordszám)	integer (int32)	0
Query	partnerId optional	Partner azonosító	string
Query	status optional	Számla státusz, alapértelmezetten lezárt számlákra szűréssel	enum (DRAFT, CLOSED, INVALIDATED, CORRECTED)	"CLOSED"

Responses

HTTP Code	Description	Schema
200	OK	<InvoiceDTO> array Az InvoiceDTO objektumban a számlák adatai szerepelnek. A sikeres válaszban a lekérdezés paramétereinek megfelelő számlák kerülnek átadásra.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Partner-Product-Inquiry-DTO-Interface

Érdeklődések lekérdezése

Végpont típusa és neve

GET /partnerproductinquiry

Parameters

Type	Name	Description	Schema
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)
Query	partnerCode required	Partnerkód	string

Responses

HTTP Code	Description	Schema
200	OK	<PartnerProductInquiryDTO> array A PartnerProductInquiryDTO az adott partner adott termék utáni érdeklődésének adatait tartalmazza. A sikeres válaszban a paraméterben megadott partner érdeklődéseinek adatai szerepelnek.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

POS-Receipt-Interface

POS blokkok lekérdezése

Végpont típusa és neve

GET /posreceipt

Parameters

Type	Name	Description	Schema
Query	dateFrom optional	Kezdődátum	string (date-time)
Query	dateTo optional	Végdátum	string (date-time)
Query	limit optional	Rekord limit, alapértelmezetten 25. Maximum 1000	integer (int32)
Query	partnerCoderequired	Partnerkód	string
Query	storeId optional	Raktár ID	string

Responses

HTTP Code	Description	Schema
200	OK	<PosReceiptDTO> array A PosReceiptDTO a POS bizonylatok adatait tartalmazza. A sikeres lekérdezés válaszában a lekérdezés feltételeinek megfelelő POS bizonylatok adatai szerepelnek.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

External-gift-card-Interface

Ajándékkártyák adatainak lekérdezése

Végpont típusa és neve

GET /giftcard

Parameters

Type	Name	Description	Schema
Query	giftCardCardNum optional	Ajándékkártya száma	string
Query	partnerCode optional	Partnerkód	string
Query	status optional	Ajándékkártya státusza	string

Responses

HTTP Code	Description	Schema
200	OK	<GiftCardDTO> array A GiftCardDTO az ajándékkártya fő adatait tartalmazza. A sikeres lekérdezés válaszában a paraméterben megadott adatoknak megfelelő ajándékkártyák adatai szerepelnek.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Gift-Card-transaction-Interface

Ajándékkártya tranzakciók adatainak lekérdezése

Végpont típusa és neve

GET /giftcardtransaction

Parameters

Type	Name	Description	Schema
Query	amountFrom optional	Tranzakció összegének alsó határa (felhasználás esetén negatív előjel, egyenleg feltöltés esetén pozitív előjel)	integer (int32)
Query	amountTo optional	Tranzakció összegének felső határa (felhasználás esetén negatív előjel, egyenleg feltöltés esetén pozitív előjel)	integer (int32)
Query	dateFrom optional	Kezdődátum	string (date-time)
Query	dateTo optional	Végdátum	string (date-time)
Query	giftCardCardNum optional	Ajándékkártya száma	string
Query	partnerCode optional	Partnerkód	string

Responses

HTTP Code	Description	Schema
200	OK	<GiftCardTransactionDTO> array A GiftCardTransactionDTO az ajándékkártya tranzakciók adatait tartalmazza. Sikeres válasz esetén a megadott paramétereknek megfelelő ajándékkártya tranzakciók szerepelnek a válaszban.
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

DTO-k tartalma – Data Transfer Object

AddressDTO – Cím adatok

Name	Description	Schema
addressName optional Read only	A teljes cím egy szövegben összefűzve. Csak olvasható mező	string
billingAddress optional	Számlázási cím-e	boolean
centralAddress optional	Központi cím-e	boolean
city optional	Város	string
country optional	Ország	string
countryCode optional	Országkód	string
foreignId optional	Idegen azonosító	string
id optional	Cím ID (meglévő cím módosítása esetén kötelező)	string
name optional	Cím megnevezése	string
postalAddress optional	Postázási cím-e	boolean
region optional	Megye	string
shippingAddress optional	Szállítási cím-e	boolean
street optional	Közterület neve	string
streetNo optional	Házszám	string
streetType optional	Közterület típus	string
toDelete optional	Törlendő – meglévő cím törlése esetén szükséges true értéket adni.	boolean
zipCode optional	Irányítószám	string

ContactDTO – Kapcsolat típusok adatai

Name	Description	Schema
id optional Read only	Kapcsolat azonosítója Csak olvasható mező	string
contactType optional	Típus	enum (CONTACT_TYPE_PHONE, CONTACT_TYPE_EMAIL, CONTACT_TYPE_SKYPE, CONTACT_TYPE_WEBSITE, CONTACT_TYPE_FACEBOOK, CONTACT_TYPE_FAX, CONTACT_TYPE_OTHER)
value optional	Érték (pl. telefonszám, e-mail cím)	string
toDelete optional	Törlendő-e	boolean

GiftCardDTO - Ajándékkártya adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
balance optional	Egyenleg	number
cardNum optional	Ajándékkártya száma	string
email optional	Email cím	string
expiryDate optional	Kártya érvényességi idejének végdátuma.	string (date-time)
partnerCode optional	Partnerkód	string
partnerName optional	Partner név	string
phone optional	Telefonszám	string
status optional	Kártya státusz	enum (GIFT_CARD_ISSUED, GIFT_CARD_SOLD, GIFT_CARD_INVALIDATED) GIFT_CARD_ISSUED //Kibocsátott GIFT_CARD_SOLD //Értékesített GIFT_CARD_INVALIDATED //Érvénytelenített

GiftCardTransactionDTO – Ajándékkártya tranzakciók adatai

Csak lekérdezésben használt objektum.

Name	Description	Schema
actualBalance optional	Aktuális egyenleg	number
amount optional	Tranzakció összege	number
giftCardCardNum optional	Ajándékkártya száma	string
id optional	Tranzakció azonosító	string
partnerCode optional	Partnerkód	string
paymentDate optional	Fizetés időpontja	string (date-time)
posPaymentDocId optional	POS bizonylat azonosítója	string
previousBalance optional	Előző egyenleg	number

InventoryDTO - Készlet adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
lastModifyDate optional	Utolsó módosítás dátuma	string (date-time)
productCode optional	Termékkód	string
productId optional	Termék azonosító	string
quantity optional	Mennyiség	number
storageId optional	Raktár azonosító	string
unit optional	Mennyiségi egység	string

InvoiceDTO - Számla adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
createdDate optional	Létrehozás időpontja	string (date-time)
docId optional	Számla bizonylatszáma	string
dueDate optional	Fizetési határidő	string (date-time)
foreignId optional	Külső azonosító	string
id optional	Számla egyedi azonosítója	string
orderId optional	Rendelés egyedi azonosítója	string
partnerId optional	Partner egyedi azonosítója	string
payDate optional	Fizetés időpontja	string (date-time)
status optional	Számla státusza	enum (DRAFT, CLOSED, INVALIDATED, CORRECTED) DRAFT //Új számla CLOSED //Lezárt számla INVALIDATED //Érvénytelenített számla CORRECTED //Helyesbített számla

OrderDTO - Rendelés adatok

Name	Description	Schema
id optional Read only	Rendelés azonosító Csak olvasható mező	string
billingAddress optional Read only	Számlázási cím Csak olvasható mező	string
billingAddressId required	Számlázási cím azonosító	string
billingPartnerId required	Számlázási partner azonosító	string
channel optional Read only	Rendelési csatorna Csak olvasható mező	enum (DIRECT, WEBSHOP, INTERFACE) DIRECT: //ORDER_CHANNEL_SALES WEBSHOP: //ORDER_CHANNEL_WEBSHOP INTERFACE: //ORDER_CHANNEL_INTERFACE //ORDER_CHANNEL_CRM
closeReason optional Read only	Lezárás oka Csak olvasható mező	string
comments optional	Megjegyzés	string
couponId optional	Utalvány azonosító	string
currencyCode required	Pénznem kódja (pl.: HUF) Example : "HUF"	string
currencyRate optional Read only	Árfolyam Csak olvasható mező	number
deliveryDate optional Read only	Szállítás dátuma Csak olvasható mező	string (date-time)
deliveryTypeId optional	Szállítás módjának azonosítója	string
docId optional Read only	Rendelés azonosító Csak olvasható mező	string
ex optional	Speciális (egyedi) mezőket tartalmazó objektum	object
foreignId optional	Külső azonosító	string
lastModifyDate optional Read only	Utolsó módosítás ideje Csak olvasható mező	string (date-time)
orderDate optional Read only	Rendelés dátuma Csak olvasható mező	string (date-time)
orderItems required	Rendelés tételek	<OrderItemDTO> array
paid optional Read only	Kifizetve Csak olvasható mező	boolean
partnerId required	Partner azonosító	string
paymentMethod optional	Fizetési mód	enum (CUPON, CASH, TRANSFER, CREDIT_CARD, CASH_ON_DELIVER Y, OTHER)
priceListId optional	Árlista azonosító	string
requestedDate required	Kérés küldésének időpontja	string (date-time)
shippingAddresId required	Szállítási cím azonosító	string
shippingAddress optional Read only	Szállítási cím Csak olvasható mező	string
shippingMethodId required	Szállítási mód azonosító	string
shippingMethodName optional Read only	Szállítási mód Csak olvasható mező	string
status optional Read only	Rendelés állapota Csak olvasható mező	enum (NEW, CONFIRMED, INPROGRESS, CLOSED) NEW: //STATUS_ORDER_NEW, //("Új"), CONFIRMED: //STATUS_ORDER_CONFIRMED, //("Visszaigazolt"), INPROGRESS: //STATUS_ORDER_ONMOBILE, //("Mobil eszközön szerkesztés alatt"), //STATUS_ORDER_PICKING, //("Kiszedés alatt"), //STATUS_ORDER_PICKED, //("Kiszedve"), //STATUS_ORDER_SHIPPED, //("Részlegesen kiszállítva"), //STSATUS_ORDER_GIVEN, //("Ügyfélnek kiadva"), CLOSED: //STATUS_ORDER_CLOSED //("Lezárt")
storageId optional	Raktár azonosítója	string
termsOfPaymentId required	Fizetési feltétel azonosítója	string
termsOfPaymentName optional Read only	Fizetési feltétel neve Csak olvasható mező	string
totalGrossValue optional Read only	Rendelés bruttó értéke Csak olvasható mező	number
totalNetValue optional Read only	Rendelés nettó értéke Csak olvasható mező	number

OrderItemDTO - Rendelés tétel adatok

Name	Description	Schema
comments optional	Megjegyzés	string
discountAmount optional	Kedvezmény összege	number
discountPercentage optional	Kedvezmény %	number
discountPrice optional Read only	Kedvezményes ár Csak olvasható mező	number
discounted optional	Akciós -e	boolean
ex optional	Speciális (egyedi) mezőket tartalmazó objektum	object
foreignId optional	Külső azonosító	string
grossPrice optional Read only	Bruttó ár Csak olvasható mező	number
id optional Read only	Rendelés tétel azonosító Csak olvasható mező	string
productCode required	Termékkód Vagy a productCode vagy a productId kötelező.	string
productId required	Termék azonosító Vagy a productCode vagy a productId kötelező.	string
productName optional Read only	Termék neve Csak olvasható mező	string
toDelete optional	Rekord törlése	boolean
qty required	Mennyiség	number
unit required	Mennyiségi egység	string
unitPrice optional	Egységár	number
vatRate optional Read only	ÁFA % Csak olvasható mező	number

PartnerDTO - Partner adatok

Name	Description	Schema
addresses optional	Partner címek objektum	<AddressDTO> array
alternateName optional	Partner alternatív név	string (200 char)
contacts optional	Kapcsolatok	<ContactDTO> array
contactLanguage optional	Kapcsolat nyelve Example : "HU"	string (200 char)
email optional	E-mail cím	string (500 char)
ex optional	Speciális (egyedi) mezőket tartalmazó objektum	object
firstName optional	Keresztnév	string (200 char)
foreignId optional	Külső azonosító	string (200 char)
id optional Read only	Partner azonosító Csak olvasható mező	string (200 char)
lastModifyDate optional	Utolsó módosítás ideje	string (date-time)
lastName optional	Vezetéknév	string (200 char)
name optional	Keresztnév és vezetéknév összefűzve	string (200 char)
newsletterSubscription optional	Előfizetés	boolean
partnerCategory optional	Partner kategória	string (200 char)
partnerCode optional	Partnerkód	string (200 char)
phone optional	Telefonszám	string (45 char)
salesCurrency optional	Értékesítés devizája	string (200 char)
salesVatCode optional Read only	Értékesítési áfakulcs kódja	string (200 char)
salesVatId optional	Értékesítési áfakulcs azonosítója	string (200 char)
taxNumber optional	Adószám	string (200 char)
termsOfPaymentId required	Fizetési feltétel azonosítója	string (200 char)
termsOfPaymentName optional Read only	Fizetési feltétel neve	string (200 char)
thirdStateTaxnumber optional	Harmadik országbeli adószám	string (200 char)
vat optional	Közösségen belüli adószám	string (200 char)
webshopLogin optional	Webshop-ba beléphet	boolean

PartnerProductInquiryDTO - Érdeklődés adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
createDate optional	Érdeklődés rögzítésének ideje	string (date-time)
giftCardNumber optional	Ajándékkártya száma	string
id optional	Érdeklődés azonosító	string
lastModifyDate optional	Utolsó módosítás ideje	string (date-time)
partnerCode optional	Partnerkód	string
partnerName optional	Partnernév	string
productCode optional	Termékkód	string
productName optional	Terméknév	string
status optional	Érdeklődés státusza	enum (PARTNER_PRODUCT_INQUIRY_WAITING, PARTNER_PRODUCT_INQUIRY_STORE_NOTIFIED, PARTNER_PRODUCT_INQUIRY_PARTNER_NOTIFIED, PARTNER_PRODUCT_INQUIRY_DELETED)
storeName optional	Raktár neve	string

PosReceiptDTO - POS bizonylatok adatai

Csak lekérdezésben használt objektum.

Name	Description	Schema
createDate optional	Létrehozás ideje	string (date-time)
currencyCode optional	Deviza kódja (pl: 'HUF')	string
docId optional	Bizonylatszám	string
giftCardActualBalance optional	Ajándékkártya aktuális egyenlege	number
invoiceDocId optional	Számla bizonylatszáma	string
items optional	Tételek	<PosReceiptItemDTO> array
lastModifyDate optional	Utolsó módosítás ideje	string (date-time)
partnerBillingAddressName optional	Partner számlázási címe	string
partnerCode optional	Partnerkód	string
partnerName optional	Partnernév	string
partnerTax optional		string
payedWithCard optional	Kártyás fizetés összege	number
payedWithCash optional	Készpénzes fizetés összege	number
payedWithVoucher optional	Utalványos fizetés összege	number
receiptType optional	Bizonylat típusa	enum (POSRECEIPT_TYPE_RECEIPT, POSRECEIPT_TYPE_INVALIDATEDRECEIPT, POSRECEIPT_TYPE_INVOICE, POSRECEIPT_TYPE_INVALIDATEDINVOICE, POSRECEIPT_TYPE_RETURN)
status optional	Bizonylat státusza	enum (POSRECEIPT_STATUS_NEW, POSRECEIPT_STATUS_INVALIDATED, POSRECEIPT_STATUS_CLOSED)
storeName optional	Raktár név	string
totalDiscount optional	Teljes kedvezmény	number
totalGrossValue optional	Teljes bruttó összeg	number
totalNetValue optional	Teljes nettó érték	number

PosReceiptItemDTO - POS bizonylat tétel adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
discount optional	Kedvezmény	number
grossPrice optional	Bruttó ár	number
grossUnitPrice optional	Bruttó egységár	number
itemOrder optional	Tétel sorszám	integer (int32)
netPrice optional	Nettó ár	number
netUnitPrice optional	Nettó egységár	number
originalGrossUnitPrice optional	Eredeti bruttó egységár	number
originalNetUnitPrice optional	Eredeti nettó egységár	number
productCode optional	Termékkód	string
productName optional	Terméknév	string
quantity optional	Mennyiség	number
unit optional	Mennyiségi egység kód	string
vatCode optional	Áfa kód (pl. 27%)	string
vatRate optional	Áfakulcs (pl. 27)	number

PriceDTO - Árlistákhoz kapcsolódó ár adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
foreignCode optional	Külső azonosító	integer (int64)
price optional	Nettó ár	number
priceBeforeDeal optional	Akciós árat megelőző nettó ár	number
priceDeal optional	Akciós ár jelző	boolean
productCode optional	Termékkód	string
productId optional	Termék azonosító	string
unit optional	Mennyiségi egység	string
vatRate optional	Áfakulcs	number

PriceListDTO - Árlista adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
code optional	Árlista azonosító	string
currency optional	Pénznem Example : "HUF"	string
endDate optional	Érvényesség vége	string (date-time)
id optional	Árlista azonosító	string
name optional	Árlista megnevezés	string
prices optional	Árak	<PriceDTO> array
startDate optional	Érvényesség kezdete	string (date-time)

ProductCategoryDTO - Termék kategória adatok

Csak lekérdezésben használt objektum.

Name	Description	Schema
foreignId optional	Külső azonosító	string
fullName optional	Teljes név	string
id optional	Termékkategória azonosító	string
keywords optional	Kulcsszavak	string
level optional		integer (int32)
longDescription optional	Hosszú leírás	string
menuOrder optional		integer (int32)
name optional	Termékkategória név	string
parentId optional	Szülő termékkategória azonosító	string
seoName optional	Seo név	string
shortDescription optional	Rövid leírás	string
smallPictureUrl optional	Kép url	string

ProductDTO – Termék adatok

Minden mező Read only és a benne hivatkozott DTO-k mezői is Read only mezők.
Csak lekérdezésben használt objektum.

Name	Description	Schema
brand optional	Márka	string
descrpition optional	Termék leírás	string
discountEndDate optional	Kedvezmény végdátuma	string (date-time)
discountPrice optional	Kedvezményes ár	number
discountQuantity optional	Kedvezmény mennyiség	number
distributor optional	Disztribútor	string
ex optional	Speciális (egyedi) mezőket tartalmazó objektum	object
foreignCode optional	Külső azonosító	integer (int64)
grossPrice optional	Bruttó ár	number
id optional	Termék azonosító	string
lastModifyDate optional	Utolsó módosítás ideje	string (date-time)
longDescription optional	Hosszú lerás	string
longName optional	Termék hosszú név	string
minimalSupplierQuantity optional	Minimum szállítási mennyiség	number
name optional	Terméknév	string
netWeight optional	Nettó súly	number
pictureUrls optional	Termék kép url-ek	<ProductPictureDTO> array
producer optional	Gyártó	string
producerId optional	Gyártó azonosító	string
productCategoryId optional	Termékkategória azonosító	string
productCode optional	Termékkód	string
productType optional	Termék típus	enum (SERVICE, PRODUCT, MATERIAL, PRODUCED, BUNDLE) SERVICE: //PRODUCT_TYPE_SERVICE //szolgáltatás PRODUCT: //PRODUCT_TYPE_PRODUCT //termék MATERIAL: //PRODUCT_TYPE_PRODUCT //anyag PRODUCED: //PRODUCT_TYPE_PRODUCED //gyártásos BUNDLE: //PRODUCT_TYPE_BUNDLE //göngyöleg
retailWebshopProduct optional	Webshop láthatóság	boolean
unit optional	Mennyiségi egység kód	string
unitOfMeasures optional	Mértékegységek	<UnitOfMeasureDTO> array
unitPrice optional	Egységár	number
vatRate optional	ÁFAkulcs	number
webshopVisible optional	Webshopon látható	boolean

ProductPictureDTO - Termék képek adatai

Minden mező Read only.
Csak lekérdezésben használt objektum.

Name	Description	Schema
main optional Read only	Főkép-e Csak olvasható mező	boolean
pictureUrl optional Read only	Kép url Csak olvasható mező	string

UnitOfMeasureDTO - Mértékegységek adatai

Minden mező Read only.
Csak lekérdezésben használt objektum.

Name	Description	Schema
compareUnit optional	Referencia mértékegység	boolean
divisor optional Read only	Osztó alap Csak olvasható mező	integer (int32)
multiplier optional Read only	Szorzó alap Csak olvasható mező	integer (int32)
type optional Read only	Mennyiségi egység azonosító Csak olvasható mező	string

Page tree

OPEN API

Tartalomjegyzék

Keresés

Base-Api-Interface

Egyedi riport futtatása

Végpont típusa és neve

Parameters

Partner-API-Interface

Partner adatok lekérdezése

Végpont típusa és neve

Parameters

Partner létrehozás vagy frissítés

Végpont típusa és neve

Parameters

Product-API-Interface

Termék kategóriák lekérdezése

Végpont típusa és neve

Parameters

Termék alapadatok lekérdezése

Végpont típusa és neve

Parameters

Inventory-API-Interface

Készlet adatok lekérdezése

Végpont típusa és neve

Parameters

Responses

Order-API-Interface

Rendelések lekérdezése

Végpont típusa és neve

Parameters

Rendelés létrehozása

Végpont típusa és neve

Parameters

Árlista azonosítók lekérdezése

Végpont típusa és neve

Parameters

Árlista lekérdezése árakkal

Végpont típusa és neve

Parameters

Finance-API-Interface

Számla letöltése PDF-ben

Végpont típusa és neve

Parameters

Számlák lekérdezése partnerhez

Végpont típusa és neve

Parameters

Partner-Product-Inquiry-DTO-Interface

Érdeklődések lekérdezése

Végpont típusa és neve

Parameters

POS-Receipt-Interface

POS blokkok lekérdezése

Végpont típusa és neve

Parameters

External-gift-card-Interface

Ajándékkártyák adatainak lekérdezése

Végpont típusa és neve

Parameters

Gift-Card-transaction-Interface

Ajándékkártya tranzakciók adatainak lekérdezése

Végpont típusa és neve

Parameters

AddressDTO – Cím adatok

ContactDTO – Kapcsolat típusok adatai

GiftCardDTO - Ajándékkártya adatok

GiftCardTransactionDTO – Ajándékkártya tranzakciók adatai

InventoryDTO - Készlet adatok

InvoiceDTO - Számla adatok

OrderDTO - Rendelés adatok

OrderItemDTO - Rendelés tétel adatok

PartnerDTO - Partner adatok

PartnerProductInquiryDTO - Érdeklődés adatok

PosReceiptDTO - POS bizonylatok adatai

PosReceiptItemDTO - POS bizonylat tétel adatok

PriceDTO - Árlistákhoz kapcsolódó ár adatok

PriceListDTO - Árlista adatok

ProductCategoryDTO - Termék kategória adatok

ProductDTO – Termék adatok

ProductPictureDTO - Termék képek adatai