API

API Sincronizare comenzi Webshop

Preluarea in RVX Manager a datelor comenzilor de la clienti plasate in magazinul online se realizeaza printr-un fisier de tip XML.

Mai jos sunt redate specificatiile fisierului XML utilizat pentru sincronizarea sistemului RVX cu webshop-ul.

items

Camp	Explicatie
WshId	id-ul unic al articolului din baza webshop
Code	codul unic de identificare a articolului din baza RVX
Name	denumirea articolului
SellPriceNet	pretul de vanzare fara TVA al articolului
SellPriceTot	pretul de vanzare inclusiv TVA al articolului
Brand	marca (producatorul) asociata articolului
Category	categoria din care face parte articolul
Subcategory	subcategoria din care face parte articolul
Warranty	perioada de garantie a articolului exprimata in numar de luni

partners

Camp	Explicatie
WshId	id-ul unic al partenerului din baza webshop
Code	codul unic de identificare al partenerului din baza RVX
Name	numele partenerului
AddressStreet	adresa sediului social a partenerului (strada, numar)
AddressCity	localitatea in care este situat sediul social al partenerului
AddressRegion	sectorul/judetul in care este situat sediul social al partenerului
AddressCountry	tara in care este situat sediul social al partenerului
AddressZipCode	codul postal al adresei
Phone	numarul de telefon al partenerului
Fax	numarul de fax al partenerului
Email	adresa electronica a partenerului

saleorders

Camp	Explicatie
WshId	id-ul unic al comenzii din baza webshop
Number	numarul unic al comenzii din baza RVX
Date	data in care este inregistrata comanda de la client
PartnerCode	codul unic de identificare a partenerului pentru care este inregistrata comanda
PartnerName	numele partenerului pentru care este inregistrata comanda
AddressStreet	adresa de livrare specificata de catre partener pentru livrarea comenzii
AddressCity	orasul in care se efectueaza livrarea
AddressRegion	sectorul/judetul in care se efectueaza livrarea
AddressZipCode	codul postal al adresei de livrare
PaymentType	modalitatea de plata a comenzii
DeliveryType	modalitatea de livrare a comenzii
DeliveryNotes	observatii suplimentare privind comanda inregistrata
AgentId	id-ul agentului comercial din baza RVX asociat comenzii
LocationId	id-ul locatiei din baza RVX in care este inregistrata comanda
CenterId	id-ul centrului de cost din baza RVX in care este inregistrata comanda
IsPosted	in cazul in care comanda este sigilata in webshop, la importul in RVX in campul IsPosted este setata valoarea 1; in caz contrar, in campul IsPosted este setata valoarea 0 (comanda nu este sigilata/confirmata)

lines

Camp	Explicatie
WshId	id-ul articolului din baza webshop
ItemCode	codul unic de identificare a articolului din baza RVX
ItemName	denumirea articolului
PriceBase	pretul de vanzare de baza (pretul inainte de aplicarea discount-ului); in cazul in care nu se aplica niciun discount, pretul de baza este acelasi cu pretul de vanzare fara TVA (pretul net)
PriceNet	pretul de vanzare fara TVA al articolului
PriceTot	pretul de vanzare inclusiv TVA al articolului
Quantity	cantitatea articolului comandata
ItemVat	valoarea cotei TVA asociata articolului

Exemplu:

<xml>

<items>
<item WshId=”149582″ Code=”CNR-MPV4CI” Name=”MP3 player Canyon CNR-MPV4CI” SellPriceNet=”38.8537″ SellPriceTot=”48.1786″ Warranty=”24″ Category=”Electronice” Subcategory=”MP3 playere” Brand=”Canyon” ></item>
<item WshId=”8708″ Code=”TAXAVERDE” Name=”KOM Taxa Verde” SellPriceNet=”5.3500″ SellPriceTot=”8.0000″ Warranty=”0″ Category=”” Subcategory=”Produse generice” Brand=”KOM” ></item>
</items>

<partners>
<partner WshId=”3021903″ Code=”PF3021903″ Name=”Pata Valentin” AddressStreet=”” AddressCity=”” AddressRegion=”” AddressCountry=”” AddressZipCode=”” Phone=”” Fax=”” Email=”pata.valentin@yahoo.com”></partner>
</partners>

<saleorders>
<saleorder WshId=”3022265″ Number=”3022265″ Date=”2011-05-30″ PartnerCode=”PF3021903″ PartnerName=”Pata Valentin” AddressStreet=”” AddressCity=”” AddressRegion=”” AddressZipCode=”” PaymentType=”CASH” DeliveryType=”MAGAZIN1″ DeliveryNotes=”” AgentId=”88615″ LocationId=”3″ CenterId=”3″ IsPosted=”1″ >
<lines>
<line WshId=”74134″ ItemCode=”CNR-MPV4CI” PriceBase=”110.76″ PriceTot=”137.35″ Quantity=”1″ ItemName=”MP3 player Canyon CNR-MPV4CI” PriceNet=”110.76″ ItemVat=”24″ ></line>
<line WshId=”74135″ ItemCode=”TAXAVERDE” PriceBase=”5″ PriceTot=”6.2″ Quantity=”1″ ItemName=”Taxa Verde” PriceNet=”5″ ItemVat=”24″ ></line>
</lines>
</saleorder>
</saleorders>

</xml>

Citire date din RVX

Pentru a citi date din RVX utilizati urmatorul REST API:

http://user:pass@server/index.php?rest/action/module/object/filter

user= utilizator definit in RVX
pass = parola acestui utilizator
action = index pentru lista de inregistrari sau view pentru detaliu inregistrare
module = modul RVX din care citim
object = documentul RVX din care citim
filter = idul inregistrarii daca action=view

Exemple de citire date de pe serverul demo RVX:

Lista nomenclatoare

URL/index.php?rest/index/catalog/item
URL/index.php?rest/index/catalog/item_category
URL/index.php?rest/index/catalog/item_subcategory
URL/index.php?rest/index/admin/location
URL/index.php?rest/index/admin/agent
URL/index.php?rest/index/admin/center
URL/index.php?rest/index/partner/partner

Lista documente

URL/index.php?rest/index/sale/sale_invoice/PartnerCode=X
URL/index.php?rest/index/sale/sale_delivery/PartnerCode=X
URL/index.php?rest/index/sale/sale_order/PartnerCode=X
URL/index.php?rest/index/sale/sale_quote/PartnerCode=X
URL/index.php?rest/index/sale/sale_payment/PartnerCode=X

Detaliu document

URL/index.php?rest/index/sale/sale_invoice/ID
URL/index.php?rest/index/sale/sale_delivery/ID
URL/index.php?rest/index/sale/sale_quote/ID
URL/index.php?rest/index/sale/sale_invoice/ID

Extrage PDF document

URL//index.php?sale/sale_invoice/printer/id/ID/report/2

Citire stocuri din RVX

RVX permite citirea stocurilor in format feed XML.

Informatiile servite sunt stocul efectiv, stocul comandat si stocul rezervat pentru fiecare articol si locatie.

Feedul ofera posibilitatea de a citi doar articolele care au stocul/comenzi/rezervari modificate de la un anumit moment in timp, pentru optimizarea transferului de date.

Stocul poate fi citit atat totalizat cat si detaliat pe fiecare locatie.

Stoc locatii
http://user:pass@server_url/index.php?rest/index/webshop/wsh_stock/

Stoc total
http://user:pass@server_url/index.php?rest/index/webshop/wsh_stocks/

Stoc locatii modificat dupa un anumit timestamp
http://user:pass@server_url/index.php?rest/index/webshop/wsh_stock/StockTime%3E%272020-11-04%2017:00:00%27

Stoc total modificat dupa un anumit timestamp
http://user:pass@server_url/index.php?rest/index/webshop/wsh_stocks/StockTime%3E%272020-11-04%2017:00:00%27

Coloane in feed:

Code – cod articol
Name – nume articol
LocationId – id locatie
LocationName – nume locatie
Stock – stoc fizic efectiv
Ordered – cantitate in comenzi deschise (nefacturate/neavizate)
Reserved – cantitate in rezervari

Disponibil poate fi Stock – Ordered sau Stock – Reserved dupa preferinta

Citire liste din RVX

Pentru a citi liste din RVX, utilizati urmatorul REST API:

http://user:pass@{server}/index.php?rest/action/module/object/filter

1. Citire articole:

https://user:pass@{server}/index.php?rest/index/catalog/item

3. Marci (articole):

https://user:pass@{server}/index.php?rest/index/catalog/item_brand

4. Subcategorii articole:

https://user:pass@{server}/index.php?rest/index/catalog/item_subcategory

3. Parteneri:

https://user:pass@{server}/index.php?rest/index/partner/partner

4. Locatie:

https://user:pass@{server}/index.php?rest/index/admin/location

5. Agent:

https://user:pass@{server}/index.php?rest/index/admin/agent

6. Centre:

https://user:pass@{server}/index.php?rest/index/admin/center

7. Mod de plata:

https://user:pass@{server}/index.php?rest/index/admin/payment_type

Parametrii precum:

CategoryId – reprezinta categoria articolului din care se doreste extragerea.
limit/x/x – reprezinta parametrul care limiteaza numarul de inregistrari afisate
offset/x – reprezinta parametrul de unde se incepe citirea
x.UpdateTime – in care x este numele tabelei din SQL.
yyy-dd-mm time – reprezinta parametrul ce defineste anul-luna-ziua ora.

sunt optionali si functioneaza si in cadrul listelor exemplificate anterior.

Filtrari

1. Filtrarea unui producator de articole dintr-o lista cu mai multe inregistrari:

https://user:pass@{server}/index.php?rest/index/catalog/item_brand/Id>x/limit/x/offset/x

Id>x – reprezinta id-ul producatorului de articol. (exemplu Id>400).
limit/x/ – reprezinta numarul de inregistrari afisate. (exemplu limit/2/) – va afisa doar 2 inregistrari.
offset/x – reprezinta parametrul de unde se incepe citirea. (exemplu 1) – citirea se va realiza de la primul articol.

2. Filtrarea unui articol dintr-o lista cu mai multe inregistrari:

https://user:pass@{server}/index.php?rest/index/catalog/item/CategoryId=x/offset/x/limit/x

CategoryId= x – reprezinta categoria articolului din care se doreste extragerea. (exemplu 93)
limit/x/ – reprezinta parametrul care limiteaza numarul de inregistrari afisate. (exemplu limit/2/) – va afisa doar 2 inregistrari.
offset/x – reprezinta parametrul de unde se incepe citirea. (exemplu 1) – citirea se va realiza de la primul articol.

3. Filitrea anumitor parteneri creati/actualizati intr-o anumita perioada:

https://user:pass@{server}/index.php?rest/index/partner/partner/x.UpdateTime>’yyy-mm-dd time’

x.UpdateTime – in care x este numele tabelei din SQL.
yyyy-mm-dd time – reprezinta parametrul ce defineste anul-luna-ziua ora.

4. Filtrarea anumitor articole create/actualizate intr-o anumita perioada:

https://user:pass@{server}/index.php?rest/index/catalog/item/X.UpdateTime>’yyyy-mm-dd time’/offset/x/limit/x

x.UpdateTime – in care x este numele tabelei din SQL.
yyyy-mm-dd time – reprezinta parametrul ce defineste anul-luna-ziua ora.
offset/x/ – reprezinta parametrul de unde se incepe citirea. (exemplu offset/1/) – va incepe citirea de la primul articol.
limit/x/ – reprezinta parametrul care limiteaza numarul de inregistrari afisate. (exemplu limit/2/) – va afisa doar 2 inregistrari.

5. Filtrarea unei locatii:

https://user:pass@{server}/index.php?rest/index/admin/location/Id>x/offset/x/limit/x

Id>x – reprezinta id-ul locatiei.
offset/x/ – reprezinta parametrul de unde se incepe citirea. (exemplu offset/1/) – va incepe citirea de la primul articol.
limit/x/ – reprezinta parametrul care limiteaza numarul de inregistrari afisate (exemplu limit/2/) – va afisa doar 2 inregistrari.

6. Filtrarea unui agent:

https://user:pass@{server}/index.php?rest/index/admin/agent/Id>x/offset/x/limit/x

Id>x – reprezinta id-ul agentului.
offset/x/ – reprezinta parametrul de unde se incepe citirea. (exemplu offset/1/) – va incepe citirea de la primul articol.
limit/x/ – reprezinta parametrul care limiteaza numarul de inregistrari afisate (exemplu limit/2/) – va afisa doar 2 inregistrari.

7. Filtrarea unui centru de cost:

https://user:pass@{server}/index.php?rest/index/admin/center/Id>x/offset/x/limit/x

Id>x – reprezinta id-ul centrului de cost.
offset/x/ – reprezinta parametrul de unde se incepe citirea. (exemplu offset/1/) – va incepe citirea de la primul articol.
limit/x/ – reprezinta parametrul care limiteaza numarul de inregistrari afisate (exemplu limit/2/) – va afisa doar 2 inregistrari.

8. Filtrarea tipului de plata:

https://user:pass@{server}/index.php?rest/index/admin/payment_type/Id>x/offset/x/limit/x

Id>x – reprezinta id-ul centrului tipului de plata.
offset/x/ – reprezinta parametrul de unde se incepe citirea. (exemplu offset/1/) – va incepe citirea de la primul articol.
limit/x/ – reprezinta parametrul care limiteaza numarul de inregistrari afisate (exemplu limit/2/) – va afisa doar 2 inregistrari.