API citire date RVX

⌘K
  2. Home
  4. Docs
  6. Instalare si configurare
  8. API citire date RVX

API citire date RVX

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:

  • 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:

  • 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:

  • 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:

  • 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:

  • 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.

    • Vizualizare inregistrari din RVX

    Pentru a vizualiza inregistari din RVX, utilizati urmatorul REST API:

    https://user:pass@{server}/index.php?rest/view/{modul}/{model}/{id

    • x – reprezinta parametrul aferent id-ului articolului.

    1. Vizlualizarea comenzii de vanzare:

    https://user:pass@{server}/index.php?rest/view/sale/sale_order/x

    • x – reprezinta parametrul aferent id-ului comenzii.

    2. Vizualizarea comenzii de cumparare:

    https://user:pass@{server}/index.php?rest/view/buy/buy_order/x

    • x – reprezinta parametrul aferent id-ului comenzii.

    3. Vizualizarea comenzii rezervate:

    https://user:pass@{server}/index.php?rest/view/sale/sale_order_reservation/x

    • x – reprezinta parametrul aferent id-ului comenzii.