Bevezetés

Webshippy API HU
English version
Search…
Bevezetés
WEBSHIPPY API SEGÉDLET
Order API
Product API
Inventory Transfer API
External Inventory API
GetStock API
Create Bundle API
Dropshippy Price Change API
Shipping Mode API
Push API
FEED SEGÉDLET
External Inventory Feed
Bevezetés
Ez a leírás részletesen bemutatja, hogy a Webshippy különböző API végpontjait felhasználva, hogyan kommunikálhatsz külső rendszerekből a Webshippy rendszerével.
Használható API végpontok
​Order API: Rendelések szinkronizálása (létrehozás, módosítás, törlés, lekérdezés).
​Product API: Termékek szinkronizálása (létrehozás, módosítás, törlés, lekérdezés, készletinfó).
​Inventory Transfer API: Áruszállítások kezelése (létrehozás, módosítás, törlés, lekérdezés).
​External Inventory API: Külső raktárról elérhető készlet mennyiség beállítása.
​GetStock API: Termék-készlet adatok tömeges lekérdezése.
​Create Bundle API: Termékcsomag létrehozása.
​Dropshippy Price Change API: Dropshippy nagyker árak módosítása.
​Shipping Mode API: Szállítási mód kiválasztása.
​Push API: Értesítés a megrendelés és szállítás státuszváltozásáról.
Használandó API URL -ek
API XML url: https://app.webshippy.com/wspyapi/{ACTION}/xml
API JSON url: https://app.webshippy.com/wspyapi/{ACTION}/json
Autentikáció - API kulcs generálása
A Webshippy API minden esetben egy külön értékesítési csatornaként jelenik meg a Webshippy Admin rendszerében. Ahhoz, hogy sikeres adatkommunikáció jöjjön létre, rendelkeznünk kell egy saját API kulcssal. Ennek létrehozásához navigálj a Beállítások / Webáruházak kezelése oldalra, majd a Webshippy.API gombra kattinva hozz létre egy új értékesítési csatornát. Az alapadatok kitöltése után a rendszer legenerálja az API kulcsot, ami innentől kezdve készen áll a kommunikációra.
Az API hívások működése
A WSAPI a biztonság érdekében HTTPS csatornát használ, az UTF-8 karakterkódolást támogatja, valamint képes kommunikálni XML és JSON formátumban is.
API XML url: https://app.webshippy.com/wspyapi/{ACTION}/xml
API JSON url: https://app.webshippy.com/wspyapi/{ACTION}/json
Ahol az {ACTION} helyőrző a kért funkciót/akciót jelenti.
Az API minden esetben POST metódust használ, és az átadott adatokat a request mező tartalmazza JSON vagy XML String-ként.
Példa a PHP alapú API hívásra:
1
$request = '<?xml version="1.0" encoding="UTF-8"?>
2
<request>  
3
  <apiKey>apiKey</apiKey>  
4
  <filters>    
5
    <lastMod>2018-01-01 00:00:00</lastMod>  
6
  </filters>
7
</request>';$ch = curl_init();curl_setopt($ch, CURLOPT_URL, 'https://app.webshippy.com/wspyapi/GetProduct/xml/');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(['request' => $request]));$result = curl_exec($ch);
Copied!
Példa: Áruszállítás létrehozása
Ezzel a funkcióval áruszállítások hozhatóak létre.
Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
direction
Igen
A létrehozandó áruszállítás iránya (in/out).
note
Nem
Megjegyzés az áruszállításhoz.
date
Igen
Az áruszállítás várható dátuma.
quantity
Igen
Szállított termék mennyisége (pozitív egész).
sku
Igen
Szállított termék SKU-ja (cikkszáma).
XML esetén:
Url: https://app.webshippy.com/wspyapi/CreateTransfer/xml
Kérés:
1
<?xml version="1.0" encoding="utf-8"?>
2
<request> 
3
  <apiKey>api-key-comes-here</apiKey> 
4
  <transfer>     
5
    <direction>in</direction>     
6
    <note>délután érkezik</note>     
7
    <date>2018-01-01</date>     
8
    <products>       
9
      <elem>         
10
        <quantity>3</quantity>         
11
        <sku>4345</sku>       
12
      </elem>       
13
      <elem>         
14
        <quantity>1</quantity>         
15
        <sku>67657</sku>       
16
      </elem>       
17
      <elem>         
18
        <quantity>1</quantity>         
19
        <sku>56464</sku>       
20
      </elem>     
21
    </products> 
22
  </transfer>
23
</request>
Copied!
Válasz (példa):
1
<?xml version="1.0" encoding="utf-8"?>
2
<response>  
3
  <status>success</status>  
4
  <message>    
5
    <elem>The transfer creation was successful</elem>  
6
  </message>  
7
  <transfer_id>74210</transfer_id>
8
</response>
Copied!
JSON esetén:
Url: https://app.webshippy.com/wspyapi/CreateTransfer/json
Kérés:
1
{  "apiKey": "api-key-comes-here",  "transfer": {  "direction": "in",  "transfer_id": 59,  "note": "délután viszik el",  "date": "2018-08-20",  "products": [   {     "quantity": 3,     "sku": 343545   },   {     "quantity": 2,     "sku": 654564   },   {     "quantity": 1,     "sku": 32432432   }   ] }}
Copied!
Válasz (példa):
1
{  "status": "success",  "message": [    "The transfer creation was successful"  ],  "transfer_id": 176}
Copied!
​
​
Next - WEBSHIPPY API SEGÉDLET
Order API
Last modified 8d ago
Copy link
Contents
Használható API végpontok
Autentikáció - API kulcs generálása
Az API hívások működése
Példa: Áruszállítás létrehozása