WooCommerce v2 API
A kiegészítő használatával hozzáférhet webáruháza rendeléseihez és termékeihez WooCommerce v2 API kérésekkel.
Hozzáférési adatok:
A kiegészítő aktiválása után (Kiegészítők > Kiegészítők listája) a Műveletek > Hozzáférési adatok menüpontra kattintva látható a Consumer Key és a Consumer Secret.
Ezt a két adatot kell minden kérés során a consumer_key és consumer_secret paramétereket használva elküldeni a használni kívánt végpontra (pl.: https://webaruhazdomain.hu/wp-json/wc/v2/products/count?consumer_key=ck_300db508f9d0a70262e0caa0b0f6cdb6&consumer_secret=cs_85b332d1d475629c18ab75b81edfff15).
Végpontok:
- /wp-json/wc/v2/products/count
A webáruházban található termékek számának lekérésére használható. - /wp-json/wc/v2/products
A termékek listázására használható. Alapból egyszerre 10 termék szerepel a válaszban, a per_page GET pataméterrel ez a szám maximum 500-ig növelhető. A különböző oldalak a page GET paramétert használva kérhetőek le (pl.: 5. oldal: ?page=5).
A HTTP Response Header tartalmazza az összes találat számát és az alkalmazott per_page alapján az összes oldal számát (pl.: X-WP-Total: 22494, X-WP-TotalPages: 2250). - /wp-json/wc/v2/products/categories
A teljes kategóriafa listázására használható. - /wp-json/wc/v2/orders/count
A rendelések számának lekérésére használható. A status GET paraméterrel csak az adott állapotú rendelések száma kérhető le. A rendelés állapot azonosítók megtalálhatóak az oldal végén. - /wp-json/wc/v2/orders
A rendelések listázására használható. Alapból egyszerre 10 rendelés szerepel a válaszban, a per_page GET pataméterrel ez a szám maximum 500-ig növelhető. A status GET paraméterrel csak az adott állapotú rendelések kérhetőek le. A rendelés állapot azonosítók megtalálhatóak az oldal végén. Példa a "Függő" állapotú rendelések lekérésére: /wp-json/wc/v2/orders?status=1 (a consumer_key és a consumer_secret természetesen GET paraméterként szükségesek az azonosításhoz!). A különböző oldalak a page GET paramétert használva kérhetőek le (pl.: 5. oldal: ?page=5).
A HTTP Response Header tartalmazza az összes találat számát és az alkalmazott per_page alapján az összes oldal számát (pl.: X-WP-Total: 22494, X-WP-TotalPages: 2250). - /wp-json/wc/v2/order_status_update/$orderId/$newOrderStatus
Egy rendelés állapota frissíthető a végpont paraméterezésével. Például az 1234-es rendelés "Feldolgozás alatt" (2) állapotra állítása a következő végpont meghívásával lehetséges: /wp-json/wc/v2/order_status_update/1234/2 (a consumer_key és a consumer_secret természetesen GET paraméterként szükségesek az azonosításhoz!) - /wp-json/wc/v2/orders/$orderId
Egy rendelés állapota frissíthető JSON adat POST/PUT kérésként való küldésével is. Például az 5678 azonosítójú rendelés állapotának frissítése "Teljesítve" (4) állapotra a /wp-json/wc/v2/orders/5678 végpontra POST/PUT kéréssel küldött { "status": 4 } JSON adattal is lehetséges.
Rendelés állapot azonosítók:
1 = Függő
2 = Feldolgozás alatt
3 = Szállítás alatt
4 = Teljesítve
5 = Személyesen átvehető
6 = Visszautasítva
7 = Törölt
