{"id":562749,"date":"2023-11-15T15:54:36","date_gmt":"2023-11-15T14:54:36","guid":{"rendered":"https:\/\/fishinda.com\/?page_id=562749"},"modified":"2023-11-15T15:54:36","modified_gmt":"2023-11-15T14:54:36","slug":"api-docs-compared","status":"publish","type":"page","link":"https:\/\/fishinda.hu\/api-docs-compared\/","title":{"rendered":"REST API Dokument\u00e1ci\u00f3 compared"},"content":{"rendered":"<div class=\"container\">\n<h1>Fishinda REST API dokument\u00e1ci\u00f3<\/h1>\n<blockquote><p>A k\u00e9kkel jel\u00f6lt elemek v\u00e1ltoztak az el\u0151z\u0151 API-hoz k\u00e9pest<\/p><\/blockquote>\n<blockquote><p>Host (test): <code>https:\/\/sapv.hu\/api\/wc<\/code><\/p><\/blockquote>\n<blockquote><p>Host (live): <code>https:\/\/fishinda.com\/api\/wc<\/code><\/p><\/blockquote>\n<p>Header: <code>Content-Type: application\/json<\/code><\/p>\n<blockquote><p>Header: <code>Authorization: Basic auth {username:password@}<\/code><\/p><\/blockquote>\n<p>Minden v\u00e1lasz tartalmaz egy &#8216;success&#8217; mez\u0151t (true\/false), ha \u00e9rt\u00e9ke false, akkor az &#8216;error&#8217; mez\u0151ben tal\u00e1lhat\u00f3 a hiba le\u00edr\u00e1sa.<\/p>\n<h3>Rendel\u00e9sek lek\u00e9r\u00e9se<\/h3>\n<h5>GET: \/orders | \/orders\/{offset}\/{limit}<\/h5>\n<pre>Alap\u00e9rtelmezetten az utols\u00f3 10 rendel\u00e9st adja vissza<\/pre>\n<h6>Response:<\/h6>\n<pre><code>\n{\n    \"success\": true,\n    \"orders\": [\n        {\n            \"number\": 2, <span class=\"comment\">Rendel\u00e9s sz\u00e1ma<\/span>\n            \"status\": \"new\", <span class=\"comment\">Rendel\u00e9s st\u00e1tusz<\/span>\n            \"created_at\": \"2020-01-06 15:03:21\" <span class=\"comment\">Rendel\u00e9s d\u00e1tuma<\/span>\n        },\n        {\n            \"number\": 1,\n            \"status\": \"fulfillment\",\n            \"created_at\": \"2019-11-02 09:57:04\"\n        }\n    ]\n}\n    <\/code><\/pre>\n<hr \/>\n<h3 id=\"order\">Rendel\u00e9s adatainak lek\u00e9r\u00e9se<\/h3>\n<h5>GET: \/order\/{number}<\/h5>\n<pre>number: rendel\u00e9s sz\u00e1ma, k\u00f6telez\u0151 mez\u0151, eg\u00e9sz sz\u00e1m<\/pre>\n<h6>Response:<\/h6>\n<pre><code>\n{\n    \"success\": true,\n    \"order\": {\n        \"number\": 1,\n        \"products\": [\n            {\n                \"id\": \"bde16451-a58e-fd4e-11e9-f04ad2747083\", <span class=\"comment\">Rendel\u00e9s term\u00e9k azonos\u00edt\u00f3<\/span>\n                \"name\": \"** Rapture PRO NEO CRANK SQR DR F SO 50mm\/8g, wobbler\", <span class=\"comment\">Term\u00e9k n\u00e9v<\/span>\n                \"ean_code\": \"8054393119001\", <span class=\"comment\">Ean k\u00f3d<\/span>\n                \"sku\": \"180-17-918\", <span class=\"comment\">Cikksz\u00e1m<\/span>\n                \"currency\": \"HUF\", <span class=\"comment\">P\u00e9nznem<\/span>\n                \"net_price\": 1748, <span class=\"comment\">Nett\u00f3 egys\u00e9g\u00e1r<\/span>\n                \"gross_price\": 2219.96, <span class=\"comment\">Brutt\u00f3 egys\u00e9g\u00e1r<\/span>\n                \"quantity\": 1, <span class=\"comment\">Mennyis\u00e9g<\/span>\n                \"orig_quantity\": 1, <span class=\"comment\">Rendelt mennyis\u00e9g<\/span>\n                \"net_total\": 1748, <span class=\"comment\">\u00d6ssz. nett\u00f3 \u00e1r<\/span>\n                \"gross_total\": 2219.96, <span class=\"comment\">\u00d6ssz. brutt\u00f3 \u00e1r<\/span>\n                \"status\": \"new\", <a href=\"#order_product_status\"><span class=\"comment\">Term\u00e9k st\u00e1tusz sz\u00f6veges azonos\u00edt\u00f3<\/span><\/a>\n            },\n        ],\n        \"currency\": \"HUF\", <span class=\"comment\">P\u00e9nznem<\/span>\n        \"products_net_total\": 4684, <span class=\"comment\">Nett\u00f3 \u00f6sszeg<\/span>\n        \"products_gross_total\": 5948.68, <span class=\"comment\">Brutt\u00f3 \u00f6sszeg<\/span>\n        \"delivery_price\": 1750, <span class=\"comment\">Sz\u00e1ll\u00edt\u00e1si d\u00edj<\/span>\n        \"coupon_discount_price\": 0, <span class=\"comment\">Kupon kedvezm\u00e9ny<\/span>\n        \"gross_total\": 7698.68, <span class=\"comment\">Brutt\u00f3 v\u00e9g\u00f6sszeg<\/span>\n        \"payment_method\": \"cod\", <a href=\"#payment_method\"><span class=\"comment\">Fizet\u00e9si m\u00f3d<\/span><\/a>\n        \"payment_method_gateway\": \"offline\", <span class=\"comment\">Fizet\u00e9si m\u00f3d \u00e1tj\u00e1r\u00f3<\/span>\n        \"delivery_method\": \"H\u00e1zhozsz\u00e1ll\u00edt\u00e1s\", <span class=\"comment\">Sz\u00e1ll\u00edt\u00e1si m\u00f3d<\/span>\n        \"delivery_address\": { <span class=\"comment\">Sz\u00e1ll\u00edt\u00e1si c\u00edm<\/span>\n            \"first_name\": \"Teszt\", <span class=\"comment\">Keresztn\u00e9v<\/span>\n            \"last_name\": \"Elek\", <span class=\"comment\">Vezet\u00e9kn\u00e9v<\/span>\n            \"company\": false, <span class=\"comment\">C\u00e9g (true\/false)<\/span>\n            \"company_name\": null, <span class=\"comment\">C\u00e9g n\u00e9v (csak c\u00e9g eset\u00e9n)<\/span>\n            \"contact_first_name\": null, <span class=\"comment\">Kapcsolattart\u00f3 Keresztn\u00e9v (csak c\u00e9g eset\u00e9n)<\/span>\n            \"contact_last_name\": null, <span class=\"comment\">Kapcsolattart\u00f3 Vezet\u00e9kn\u00e9v (csak c\u00e9g eset\u00e9n)<\/span>\n            \"taxNumber\": null, <span class=\"comment\">Ad\u00f3sz\u00e1m<\/span>\n            \"phone\": \"06301234567\", <span class=\"comment\">Telefon<\/span>\n            \"email\": \"tesztelek@gmail.com\", <span class=\"comment\">Email c\u00edm<\/span>\n            \"country\": \"hu\", <span class=\"comment\">Orsz\u00e1g<\/span>\n            \"city\": \"Budapest\", <span class=\"comment\">Telep\u00fcl\u00e9s<\/span>\n            \"zip\": 1139, <span class=\"comment\">Ir\u00e1ny\u00edt\u00f3sz\u00e1m<\/span>\n<blockquote>\n            \"address\": Teszt utca 42, 3\/71, <span class=\"comment\">C\u00edm<\/span>\n<\/blockquote>\n<blockquote><del>\n            \"street\": \"Teszt\", <span class=\"comment\">K\u00f6zter\u00fclet<\/span>\n            \"street_suffix\": \"utca\", <span class=\"comment\">K\u00f6zter\u00fclet jellege<\/span>\n            \"street_number\": \"42\", <span class=\"comment\">H\u00e1zsz\u00e1m<\/span>\n            \"floor\": \"3\", <span class=\"comment\">Emelet<\/span>\n            \"flat\": \"71\" <span class=\"comment\">Ajt\u00f3<\/span>\n<\/del><\/blockquote>\n        },\n        \"billing_address\": { <span class=\"comment\">Sz\u00e1ml\u00e1z\u00e1si c\u00edm<\/span>\n            \"first_name\": \"Teszt\",\n            \"last_name\": \"Elek\",\n            \"company\": false,\n            \"company_name\": null,\n            \"contact_first_name\": null,\n            \"contact_last_name\": null,\n            \"taxNumber\": null,\n            \"phone\": \"06301234567\",\n            \"email\": \"tesztelek@gmail.com\",\n            \"country\": \"hu\",\n            \"city\": \"Budapest\",\n            \"zip\": 1139,\n<blockquote>\n            \"address\": Teszt utca 42, 3\/71, <span class=\"comment\">C\u00edm<\/span>\n<\/blockquote>\n<blockquote><del>\n            \"street\": \"Teszt\", <span class=\"comment\">K\u00f6zter\u00fclet<\/span>\n            \"street_suffix\": \"utca\", <span class=\"comment\">K\u00f6zter\u00fclet jellege<\/span>\n            \"street_number\": \"42\", <span class=\"comment\">H\u00e1zsz\u00e1m<\/span>\n            \"floor\": \"3\", <span class=\"comment\">Emelet<\/span>\n            \"flat\": \"71\" <span class=\"comment\">Ajt\u00f3<\/span>\n<\/del><\/blockquote>\n        },\n        \"status\": \"pending\", <a href=\"#order_status\"><span class=\"comment\">Rendel\u00e9s st\u00e1tusz<\/span><\/a>\n<blockquote><del>        \"created\": \"2020-01-06 15:03:21\", <span class=\"comment\">Rendel\u00e9s d\u00e1tuma<\/span><\/del><\/blockquote>\n<blockquote>        \"created_at\": \"2020-01-06 15:03:21\", <span class=\"comment\">Rendel\u00e9s d\u00e1tuma<\/span> <\/blockquote>\n\n        \"url\": \"https:\/\/fishinda.com\/hu\/profile\/myorder?open=10#order-10\", <span class=\"comment\">Rendel\u00e9s url<\/span>\n        \"remark\": \"\", <span class=\"comment\">Megjegyz\u00e9s<\/span>\n    }\n}\n    <\/code><\/pre>\n<hr \/>\n<h3 id=\"payment-method\">Fizet\u00e9si m\u00f3d (payment_method) lehets\u00e9ges \u00e9rt\u00e9kei:<\/h3>\n<ul>\n<li>cod: &#8216;cash on delivery&#8217; &#8211; ut\u00e1nv\u00e9t,<\/li>\n<li>barion: bankk\u00e1rtya<\/li>\n<\/ul>\n<hr \/>\n<h3 id=\"order-product-status\">Rendel\u00e9si term\u00e9k st\u00e1tusz \u00e1ll\u00edt\u00e1s<\/h3>\n<h5>POST: \/order_product_status<\/h5>\n<h6>Request:<\/h6>\n<pre><code>\n{\n    'products': [\n        {\n            \"id\": string, required, <span class=\"comment\">Rendel\u00e9s term\u00e9k azonos\u00edt\u00f3<\/span>\n            \"status\": string, required, <a href=\"#order_product_status\"><span class=\"comment\">Term\u00e9k st\u00e1tusz sz\u00f6veges azonos\u00edt\u00f3<\/span><\/a>\n            \"quantity\": integer, not required, <span class=\"comment\">Term\u00e9k mennyis\u00e9g (0 eset\u00e9n deleted st\u00e1tuszt k\u00fcldj vissza) <\/span>\n            \"note\": string, not required, <span class=\"comment\">Term\u00e9k keresked\u0151i megjegyz\u00e9s<\/span>\n        }\n    ]\n}\n    <\/code><\/pre>\n<h6>Response:<\/h6>\n<pre><code>\n{\n    \"success\": boolean,\n<blockquote>\n    \"successful_changes\": [\n        {\n            \"{order_item_id}\": [\n                \"order product status updated\"\n            ]\n        }\n    ]\n    \"error\": [\n        {\n            \"{order_item_id}\": [\n                \"order product quantity not updated\",\n                \"order product note not updated\"\n            ]\n        }\n    ]\n<\/blockquote>\n}\n    <\/code><\/pre>\n<hr \/>\n<h3 id=\"order_product_status\">Rendel\u00e9si term\u00e9k st\u00e1tuszok:<\/h3>\n<ul>\n<li>new: Megrendel\u00e9s felv\u00e9ve,<\/li>\n<li>deleted: Megrendel\u00e9s t\u00f6r\u00f6lve,<\/li>\n<li>fulfillment: Megrendel\u00e9s teljes\u00edtve,<\/li>\n<li>return: Vissz\u00e1rus,<\/li>\n<\/ul>\n<hr \/>\n<h3 id=\"order_status\">Rendel\u00e9si st\u00e1tuszok:<\/h3>\n<ul>\n<li>new: Megrendelve, fizet\u00e9sre v\u00e1r,<\/li>\n<li>failed: Failed,<\/li>\n<li>pending: Kifizet\u00e9s f\u00fcgg\u0151ben,<\/li>\n<li>cancel: Visszavonva,<\/li>\n<li>refund: Visszat\u00e9r\u00edtve,<\/li>\n<li>paid: Kifizetve,<\/li>\n<li>fulfillment: Teljes\u00edtve,<\/li>\n<\/ul>\n<hr \/>\n<h3 id=\"payment_method\">Fizet\u00e9si m\u00f3dok:<\/h3>\n<ul>\n<li>offline: Ut\u00e1nv\u00e9t<\/li>\n<li>barion: Bankk\u00e1rty\u00e1s online fizet\u00e9s<\/li>\n<\/ul>\n<hr \/>\n<h3 id=\"products\">Forgalmaz\u00f3i term\u00e9k<\/h3>\n<h5>POST: \/products<\/h5>\n<h6>Request:<\/h6>\n<pre><code>\n{\n    'products': [\n        {\n            \"eanCode\": string, required, <span class=\"comment\">Term\u00e9k ean k\u00f3d (ez alapj\u00e1n azonos\u00edtja be)<\/span>\n            \"name\": string, <span class=\"comment\">Term\u00e9k neve, \u00faj term\u00e9k bek\u00fcld\u00e9se eset\u00e9n k\u00f6telez\u0151 mez\u0151<\/span>\n            \"number\": string, <span class=\"comment\">Cikksz\u00e1m<\/span>\n            \"price\": float, <span class=\"comment\">Nett\u00f3 \u00e1r, a keresked\u0151 alap\u00e9rtelmezett p\u00e9nznem\u00e9ben<\/span>\n            \"qty\": integer, <span class=\"comment\">Szabadon el\u00e9rhet\u0151 mennyis\u00e9g (db)<\/span>\n            \"warranty\": integer, <span class=\"comment\">Garancia (h\u00f3napok sz\u00e1ma)<\/span>\n            \"freeDelivery\": boolean, default: false, <span class=\"comment\">Ingyenes sz\u00e1ll\u00edt\u00e1s<\/span>\n            \"active\": boolean, default: true, <span class=\"comment\">Akt\u00edv, megjelenik a term\u00e9k<\/span>\n            \"noMinStock\": boolean, default: false, <span class=\"comment\">Nincs kos\u00e1r k\u00e9szletfigyel\u00e9s. Ha \"true\", akkor mindig van bel\u0151le k\u00e9szlet.<\/span>\n<blockquote>\n            \"brand\": string, <span class=\"comment\">M\u00e1rka neve<\/span>\n<\/blockquote>\n<blockquote>\n<del>\n            \"packagingUnit\": string, <span class=\"comment\">Kiszerel\u00e9si egys\u00e9g *<\/span>\n            \"countries\": string, default: hu, <span class=\"comment\">El\u00e9rhet\u0151 orsz\u00e1g k\u00f3djai, vessz\u0151vel elv\u00e1lasztva, pl.: \"hu,en\" *<\/span>\n            \"translations\": array [ <span class=\"comment\">T\u00f6bbnyelv\u0171 tartalom<\/span>\n                \"hu\": {\n                        \"intro\": string, <span class=\"comment\">Bevezet\u0151<\/span>\n                        \"detail\": string, <span class=\"comment\">R\u00e9szletek<\/span>\n                }\n            ]<\/del>\n<span class=\"comment\">Nem ker\u00fclnek feldolgoz\u00e1sra<\/span>\n<\/blockquote>\n<blockquote>\n            \"flashdeals\": array [ <span class=\"comment\">Akci\u00f3k - V\u00e1ltoz\u00e1s: csak a t\u00f6mb els\u0151 elem\u00e9t dolgozza fel, a tov\u00e1bbiakat figyelmen k\u00edv\u00fcl hagyja<\/span>\n<\/blockquote>\n                {\n                    \"date1\": date, required <span class=\"comment\">Akci\u00f3 kezdet\u00e9nek d\u00e1tuma, form\u00e1tum: Y-m-d H:i:s<\/span>\n                    \"date2\": date, required <span class=\"comment\">Akci\u00f3 v\u00e9g\u00e9nek d\u00e1tuma, form\u00e1tum: Y-m-d H:i:s<\/span>\n                    \"price\": float, <span class=\"comment\">Nett\u00f3 \u00e1r, a keresked\u0151 alap\u00e9rtelmezett p\u00e9nznem\u00e9ben<\/span>\n                    \"discount\": float, <span class=\"comment\">Sz\u00e1zal\u00e9kos kedvezm\u00e9ny<\/span>\n                    \"countries\": string, default: hu, <span class=\"comment\">El\u00e9rhet\u0151 orsz\u00e1g k\u00f3djai, vessz\u0151vel elv\u00e1lasztva, pl.: \"hu,en\"<\/span>\n                }\n            ],\n            \"images\": array [ <span class=\"comment\">K\u00e9pek<\/span>\n                {\n                    'origUrl': string, required, <span class=\"comment\">K\u00e9p url<\/span>\n                },\n            ],\n            \"importedCategoryName\": string, <span class=\"comment\">Import\u00e1lt kateg\u00f3rian\u00e9v<\/span>\n        }\n    ]\n}\n    <\/code><\/pre>\n<blockquote><p><del>* = Csak akkor veszi figyelembe, ha az adott ean k\u00f3ddal m\u00e9g nem rendelkezik f\u0151 term\u00e9k a rendszerben. Ebben az esetben l\u00e9trehozza a f\u0151 term\u00e9ket is.<\/del><\/p><\/blockquote>\n<h6>Response:<\/h6>\n<pre><code>\n{\n    \"success\": boolean,\n<blockquote>\n    \"{eanCode}\": [\n        {\n            \"info\": \"product found\",            \n            \"updated\": true,\n            \"modified\": [\n                \"status activated\",\n                \"sale_time_from old: {unix_timecode}\",\n                \"sale_time_from new: {unix_timecode}\",\n                \"sale_time_to old: {unix_timecode}\",\n                \"sale_time_to new: {unix_timecode}\",\n                \"sale_price old: {integer}\",\n                \"sale_price new: {integer}\"\n            ]\n        }\n    ],\n    \"{eanCode}\": [\n        {\n            \"info\": \"no product found by ean, new product created\",\n            \"error\": \"'origUrl' value should not be blank\"\n        }\n    ]\n\n<\/blockquote>\n}\n<\/code><\/pre>\n<hr \/>\n<h3 id=\"errors\">Hiba\u00fczenetek:<\/h3>\n<blockquote>\n<pre><code>\n{\n    \"code\": \"rest_forbidden\",\n    \"message\": \"Eln\u00e9z\u00e9st, nincs megfelel\u0151 jogosults\u00e1g a k\u00edv\u00e1nt m\u0171velethez.\",\n    \"data\": {\n        \"status\": 401\n    }\n}\n<span class=\"comment\">Hib\u00e1s hiteles\u00edt\u00e9s<\/span>\n<\/code>\n\n<code>\n{\n    \"code\": \"woocommerce_rest_authentication_error\",\n    \"message\": \"Fogyaszt\u00f3i kulcs \u00e9rv\u00e9nytelen.\",\n    \"data\": {\n        \"status\": 401\n    }\n}\n<span class=\"comment\">Hib\u00e1s jelsz\u00f3<\/span>\n<\/code><\/pre>\n<\/blockquote>\n<ul>\n<li>This collection should contain 1 element or more. &#8211; <span class=\"comment\">Ha nincs bek\u00fcldve egy term\u00e9k sem.<\/span><\/li>\n<li>This value should not be blank. &#8211; <span class=\"comment\">Ez az \u00e9rt\u00e9k nem lehet \u00fcres (pl. nincs megadva a rendel\u00e9si term\u00e9k, vagy a st\u00e1tusz azonos\u00edt\u00f3).<\/span><\/li>\n<li>This value is not valid. &#8211; <span class=\"comment\">Ez az \u00e9rt\u00e9k nem \u00e9rv\u00e9nyes (pl. nem \u00e9rv\u00e9nyes a rendel\u00e9si term\u00e9k, vagy a st\u00e1tusz azonos\u00edt\u00f3).<\/span><\/li>\n<li>The ordered products belong to different orders &#8211; <span class=\"comment\">Ha a bek\u00fcld\u00f6tt rendel\u00e9si term\u00e9kek nem ugyanahhoz a rendel\u00e9sben vannak<\/span><\/li>\n<\/ul>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>Fishinda REST API dokument\u00e1ci\u00f3 A k\u00e9kkel jel\u00f6lt elemek v\u00e1ltoztak az el\u0151z\u0151 API-hoz k\u00e9pest Host (test): https:\/\/sapv.hu\/api\/wc Host (live): https:\/\/fishinda.com\/api\/wc Header: Content-Type: application\/json Header: Authorization: Basic auth {username:password@} Minden v\u00e1lasz tartalmaz egy &#8216;success&#8217; mez\u0151t (true\/false), ha \u00e9rt\u00e9ke false, akkor az &#8216;error&#8217; mez\u0151ben tal\u00e1lhat\u00f3 a hiba le\u00edr\u00e1sa. Rendel\u00e9sek lek\u00e9r\u00e9se GET: \/orders | \/orders\/{offset}\/{limit} Alap\u00e9rtelmezetten az utols\u00f3 10 [&#8230;]\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"page-blank-landingpage.php","meta":{"footnotes":""},"class_list":["post-562749","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/fishinda.hu\/api\/wp\/v2\/pages\/562749","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fishinda.hu\/api\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/fishinda.hu\/api\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/fishinda.hu\/api\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fishinda.hu\/api\/wp\/v2\/comments?post=562749"}],"version-history":[{"count":0,"href":"https:\/\/fishinda.hu\/api\/wp\/v2\/pages\/562749\/revisions"}],"wp:attachment":[{"href":"https:\/\/fishinda.hu\/api\/wp\/v2\/media?parent=562749"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}