Fishinda REST API dokumentáció

Verziószám: 2.2.1 (changelog)
Utoljára frissítve: 2024.07.31

Host (test): https://test.fishinda.com/api/wc
Host (live): https://fishinda.com/api/wc
Header: Content-Type: application/json
Header: Authorization: Basic auth {username:password@}
Minden válasz tartalmaz egy ‘success’ mezőt (true/false), ha értéke false, akkor az ‘error’ mezőben található a hiba leírása.

Rendelések lekérése

GET: /orders | /orders/{offset}/{limit}
Alapértelmezetten az utolsó 10 rendelést adja vissza
Response:

{
    "success": true,
    "orders": [
        {
            "number": 2, Rendelés száma
            "status": "new", Rendelés státusz
            "created_at": "2020-01-06 15:03:21" Rendelés dátuma
        },
        {
            "number": 1,
            "status": "fulfillment",
            "created_at": "2019-11-02 09:57:04"
        }
    ]
}

Rendelés adatainak lekérése

GET: /order/{number}
number: rendelés száma, kötelező mező, egész szám
Response:

{
    "success": true,
    "order": {
        "number": 1,
        "products": [
            {
                "id": "bde16451-a58e-fd4e-11e9-f04ad2747083", Rendelés termék azonosító
                "name": "** Rapture PRO NEO CRANK SQR DR F SO 50mm/8g, wobbler", Termék név
                "ean_code": "8054393119001", Ean kód
                "sku": "180-17-918", Cikkszám
                "currency": "HUF", Pénznem
                "net_price": "1748", Nettó egységár
                "gross_price": "2219.96", Bruttó egységár
                "quantity": 1, Mennyiség
                "orig_quantity": 1, Rendelt mennyiség
                "net_total": "1748", Össz. nettó ár
                "gross_total": "2219.96", Össz. bruttó ár
                "status": "new", Termék státusz szöveges azonosító
            },
        ],
        "fees": [
            {
                "fee_name": "Utánvét kezelési díj - partner neve", extra díj neve
                "fee_net_amount": "307.0866", extra díj nettó értéke
                "fee_gross_amount": "390.0866", extra díj bruttó értéke
            },
        ],
        "has_multiple_vendors": false, bool, a vevői rendelésben szerepel-e más kereskedőtől termék?
        "lang": "hu", rendelés nyelve
        "currency": "HUF", Pénznem
        "products_net_total": 4684, Nettó összeg
        "products_gross_total": 5948.68, Bruttó összeg
        "delivery_price": 1750, Szállítási díj
        "coupon_discount_price": 0, Kupon kedvezmény
        "gross_total": 7698.68, Bruttó végösszeg
        "payment_method": "cod", Fizetési mód
        "payment_method_gateway": "offline", Fizetési mód átjáró
        "delivery_method": "Házhozszállítás", Szállítási mód
        "delivery_address": { Szállítási cím
            "first_name": "Teszt", Keresztnév
            "last_name": "Elek", Vezetéknév
            "company": false, Cég (true/false)
            "company_name": null, Cég név (csak cég esetén)
            "contact_first_name": null, Kapcsolattartó Keresztnév (csak cég esetén)
            "contact_last_name": null, Kapcsolattartó Vezetéknév (csak cég esetén)
            "taxNumber": null, Adószám
            "phone": "06301234567", Telefon
            "email": "tesztelek@gmail.com", Email cím
            "country": "HU", Ország
            "city": "Budapest", Település
            "zip": 1139, Irányítószám
            "address": Teszt utca 42, 3/71, Cím
        },
        "billing_address": { Számlázási cím
            "first_name": "Teszt",
            "last_name": "Elek",
            "company": false,
            "company_name": null,
            "contact_first_name": null,
            "contact_last_name": null,
            "taxNumber": null,
            "phone": "06301234567",
            "email": "tesztelek@gmail.com",
            "country": "HU", országkód
            "city": "Budapest",
            "zip": 1139,
            "address": Teszt utca 42, 3/71, Cím
        },
        "status": "pending", Rendelés státusz
        "created_at": "2020-01-06 15:03:21", Rendelés dátuma
        "url": "https://fishinda.com/hu/profile/myorder?open=10#order-10", Rendelés url
        "remark": "", Megjegyzés
    }
}

Pénznem (currency) lehetséges értékei:

  • HUF: Magyar forint,
  • EUR: Euró,
  • CZK: Cseh korona,
  • RON: Román lej

Ország (country) lehetséges értékei:

  • HU: Magyarország,
  • SK: Szlovákia,
  • CZ: Csehország,
  • RO: Románia

Nyelv (lang) lehetséges értékei:

  • hu: Magyar,
  • sk: Szlovák,
  • cs: Cseh,
  • ro: Román

Fizetési mód (payment_method) lehetséges értékei:

  • cod: ‘cash on delivery’ – utánvét,
  • dokan-stripe-connect: bankkártya

Fizetési mód (payment_method_gateway) lehetséges értékei:

  • offline: utánvét,
  • stripe: bankkártya

Rendelési termék státusz állítás

POST: /order_product_status
Request:

{
    'products': [
        {
            "id": string, required, Rendelés termék azonosító
            "status": string, required, Termék státusz szöveges azonosító
            "quantity": integer, not required, Termék mennyiség (0 esetén deleted státuszt küldj vissza) 
            "note": string, not required, Termék kereskedői megjegyzés
        }
    ]
}
Response:

{
    "success": boolean,
    "successful_changes": [
        {
            "{order_item_id}": [
                "order product status updated"
            ]
        }
    ]
    "error": [
        {
            "{order_item_id}": [
                "order product quantity not updated",
                "order product note not updated"
            ]
        }
    ]
}

Rendelési termék státuszok:

  • new: Megrendelés felvéve,
  • deleted: Megrendelés törölve,
  • fulfillment: Megrendelés teljesítve,
  • return: Visszárus,

Rendelési státuszok:

  • new: Megrendelve, fizetésre vár,
  • failed: Failed,
  • pending: Kifizetés függőben,
  • cancel: Visszavonva,
  • refund: Visszatérítve,
  • paid: Kifizetve,
  • fulfillment: Teljesítve,

Fizetési módok:

  • offline: Utánvét
  • dokan-stripe-connect: Bankkártyás online fizetés

Forgalmazói termék

POST: /products
Request:

{
	"lang": "hu", - string, Nyelv, optional (default: "hu")
	"currency": "HUF", - string, Deviza, optional (dafault: "HUF")
	"products": [{
		"sku": "123456abc", - string, Cikkszám, required
		"name": "PróbaTermék", - string, Termék neve, required
		"description": "termék leírás html tag-ekkel", - string, termék leírás, optional
		"tax_key": 27, - int, Áfakulcs, optional (default: 27)
		"price": 1100, - float, Bruttó ár, egyszerű termék esetén kötelező mező, optional
		"sale_price": 900, - float, Akciós ár egyszerű termék esetén, optional
		"sale_price_from": "2024-04-01", - string, Időzített akciós ár kezdete egyszerű termék esetén (formátum: unix timestamp vagy ISO 8601 date), optional
		"sale_price_to": "2024-05-01", - string, Időzített akciós ár vége egyszerű termék esetén (formátum: unix timestamp vagy ISO 8601 date), optional
		"active": true, - bool, Elérhetőség, optional (default: true)
		"manage_stock": true, - bool, Készletkezelés egyszerű termék esetén (true esetén pontos készlet kezelés, "stock_qty" kötelező. false esetén korlátlan számban elérhető), optional (dafault: false)
		"stock_qty": 8, - int, Elérhető készlet egyszerű termék esetén, optional (required, ha "manage_stock" = true)
		"ean": "599123456789", - string, Vonalkód egyszerű termék esetén, optional
		"categories": [ - array of strings, Teljes mélységű kategória fák, ">" karakterrel elválasztva, optional
			"Úszók > Keszegező úszó",
			"Úszók > Harcsázó Úszó"
		],
		"images": [ - array of strings, Kép linkek, optional
			"https://fishinda.com/media/cache/slide_image/images/slide/647a15d9818d1668712428.jpg",
			"https://fishinda.com/media/cache/banner/images/banner/61893fbb9c5fa361628677.png"
		],
		"brand": "Delphin", - string, Márka, optional
		"attributes": [{ - array of objects, Attribútumok egyszerű termék esetén, optional
			"name": "length", - string, Attribútum neve, required
			"value": "3m", - string, Attribútum értéke, required
		},
		{
			"name": "color",
			"value": "red"
		}]
		"variations": [{ - array of objects, Variációk, optional
			"sku": "123456abc_variation1", - string, Cikkszám, required
			"price": 1100, - float, Variáció bruttó ára, required
			"sale_price": 900, - float, Variáció akciós ára, optional
			"sale_price_from": "2024-04-01", - string, Variáció időzített akciós ár kezdete (formátum: unix timestamp vagy ISO 8601 date), optional
			"sale_price_to": "2024-05-01", - string, Variáció időzített akciós ár vége (formátum: unix timestamp vagy ISO 8601 date), optional
			"active": true, - bool, Variáció elérhetősége, optional (default: true)
			"manage_stock": true, - bool, Készletkezelés egyszerű termék esetén (true esetén pontos készlet kezelés, "stock_qty" kötelező. false esetén korlátlan számban elérhető), optional (dafault: false)
			"stock_qty": 8, - int, Elérhető készlet egyszerű termék esetén, optional (required, ha "manage_stock" = true)
			"ean": "599123456789", - string, Variáció vonalkódja, optional
			"images": [ - array of strings, Variáció képek linkje, optional
				"https://fishinda.com/media/cache/slide_image/images/slide/647a15d9818d1668712428.jpg",
			],
			"attributes": [{ - array of objects, Variáció attribútumai, optional
				"name": "length", - string, Attribútum neve, required
				"value": "3m", - string, Attribútum értéke, required
				"variation": true - bool, Variációk esetén eltérő érték? (pl. 2 különböző hosszúságú bot esetében a "length" értéke true, "color" értéke false) több variáció esetén legalább egynek true-nak kell lennie, különböző értékekkel, optional (default: false)
			},
			{
				"name": "color",
				"value": "red"
				"variation": false
			}
			]
		},
		{ //other variations }
		]
	},
	{ //other products }
	]
}

Hibaüzenetek:


{
    "code": "rest_forbidden",
    "message": "Elnézést, nincs megfelelő jogosultság a kívánt művelethez.",
    "data": {
        "status": 401
    }
}
Hibás hitelesítés
 
{
    "code": "woocommerce_rest_authentication_error",
    "message": "Fogyasztói kulcs érvénytelen.",
    "data": {
        "status": 401
    }
}
Hibás jelszó
Fishinda Marketplace