Barion Pixel

Fishinda REST API dokumentáció

A kékkel jelölt elemek változtak az előző API-hoz képest

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á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ó
            },
        ],
        "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




            "street": "Teszt", Közterület
            "street_suffix": "utca", Közterület jellege
            "street_number": "42", Házszám
            "floor": "3", Emelet
            "flat": "71" Ajtó


        },
        "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",
            "city": "Budapest",
            "zip": 1139,


            "address": Teszt utca 42, 3/71, Cím




            "street": "Teszt", Közterület
            "street_suffix": "utca", Közterület jellege
            "street_number": "42", Házszám
            "floor": "3", Emelet
            "flat": "71" Ajtó


        },
        "status": "pending", Rendelés státusz

        "created": "2020-01-06 15:03:21", Rendelés dátuma


        "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
    }
}

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

  • cod: ‘cash on delivery’ – utánvét,
  • barion: 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
  • barion: Bankkártyás online fizetés

Forgalmazói termék

POST: /products
Request:

{
    'products': [
        {
            "eanCode": string, required, Termék ean kód (ez alapján azonosítja be)
            "name": string, Termék neve, új termék beküldése esetén kötelező mező
            "number": string, Cikkszám
            "price": float, Nettó ár, a kereskedő alapértelmezett pénznemében
            "qty": integer, Szabadon elérhető mennyiség (db)
            "warranty": integer, Garancia (hónapok száma)
            "freeDelivery": boolean, default: false, Ingyenes szállítás
            "active": boolean, default: true, Aktív, megjelenik a termék
            "noMinStock": boolean, default: false, Nincs kosár készletfigyelés. Ha "true", akkor mindig van belőle készlet.


            "brand": string, Márka neve





            "packagingUnit": string, Kiszerelési egység *
            "countries": string, default: hu, Elérhető ország kódjai, vesszővel elválasztva, pl.: "hu,en" *
            "translations": array [ Többnyelvű tartalom
                "hu": {
                        "intro": string, Bevezető
                        "detail": string, Részletek
                }
            ]
Nem kerülnek feldolgozásra




            "flashdeals": array [ Akciók - Változás: csak a tömb első elemét dolgozza fel, a továbbiakat figyelmen kívül hagyja


                {
                    "date1": date, required Akció kezdetének dátuma, formátum: Y-m-d H:i:s
                    "date2": date, required Akció végének dátuma, formátum: Y-m-d H:i:s
                    "price": float, Nettó ár, a kereskedő alapértelmezett pénznemében
                    "discount": float, Százalékos kedvezmény
                    "countries": string, default: hu, Elérhető ország kódjai, vesszővel elválasztva, pl.: "hu,en"
                }
            ],
            "images": array [ Képek
                {
                    'origUrl': string, required, Kép url
                },
            ],
            "importedCategoryName": string, Importált kategórianév
        }
    ]
}

* = Csak akkor veszi figyelembe, ha az adott ean kóddal még nem rendelkezik fő termék a rendszerben. Ebben az esetben létrehozza a fő terméket is.

Response:

{
    "success": boolean,


    "{eanCode}": [
        {
            "info": "product found",            
            "updated": true,
            "modified": [
                "status activated",
                "sale_time_from old: {unix_timecode}",
                "sale_time_from new: {unix_timecode}",
                "sale_time_to old: {unix_timecode}",
                "sale_time_to new: {unix_timecode}",
                "sale_price old: {integer}",
                "sale_price new: {integer}"
            ]
        }
    ],
    "{eanCode}": [
        {
            "info": "no product found by ean, new product created",
            "error": "'origUrl' value should not be blank"
        }
    ]



}

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ó
  • This collection should contain 1 element or more. – Ha nincs beküldve egy termék sem.
  • This value should not be blank. – Ez az érték nem lehet üres (pl. nincs megadva a rendelési termék, vagy a státusz azonosító).
  • This value is not valid. – Ez az érték nem érvényes (pl. nem érvényes a rendelési termék, vagy a státusz azonosító).
  • The ordered products belong to different orders – Ha a beküldött rendelési termékek nem ugyanahhoz a rendelésben vannak