API dokumentáció
Verzió: 0.5.5
Utolsó módosítás: 2026.09.17.
Általános információk
API url
Az API a következő URL-en keresztül érhető el:
https://api.whitefish.hu/
Az url-ben a tartományt követő rész határozza meg az API végpontot, amit el szeretnénk érni:
https://api.whitefish.hu/orders - rendelések
https://api.whitefish.hu/products - termékek
https://api.whitefish.hu/stock - készlet
https://api.whitefish.hu/inbound - beszállítások
https://api.whitefish.hu/receiving - bevételezés
Autentikáció
A használathoz szükséges az élő szerződés megléte a WhiteFish Logisztika Kft. -vel, illetve API hozzáférés, token és jogosultság az adott API végponthoz/hatókörhöz. Amennyiben szükséges, vegye fel a kapcsolatot ügyfélszolgálatunkkal a partner@whitefish.hu e-mail címen.
A kommunikáció HTTPS protokollon keresztül zajlik. Az üzenet átadás HTTP 1.1 protokoll alatt történik a következő metódusokkal:
GET
POST
PATCH
DELETE
Az autentikáció az Authorization header-el történik, Bearer token segítségével:
Authorization: Bearer aed182e65610f6c15fca80c483356f6dcurl -X GET "https://api.whitefish.hu/{endpoint urlpart}" \
-H "Authorization: Bearer {access_token}"Szűrők és limitációk
Lekérdező végpontokhoz beállíthatók különböző szűrők és limitációk is.
Szűrők
Szűrők segítségével szűkíthetjük a lekért elemek körét. Használatuk opcionális: ha nem adunk meg szűrőt a lekérdezésben, akkor az összes elemet visszakapjuk a válaszban. (A limitációnak megfelelően.)
Ha egy szűrőhöz több értéket állítunk be, azokat vesszővel (,) választjuk egy egymástól. Pl.:
https://api.whitefish.hu/products?barcode=8052469731430,8052469731423Egyszerre több szűrőt is beállíthatunk, ha több különböző termék készletét szeretnénk lekérni. Ilyenkor a szűrők közti reláció alapesetben VAGY (or). Ebben az esetben azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek VALAMELYIKE érvényesül. Pl.:
https://api.whitefish.hu/products?pid=799337&sku=41101004309Extrém esetben szükség lehet arra is, hogy ha több szűrőt használunk, az alapértelmezett VAGY (or) relációt megváltoztassuk ÉS (and) relációra. Így azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek MINDEGYIKE érvényesül. Pl.:
https://api.whitefish.hu/products?pid=799337&sku=41101004309&relation=andLimitációk
A limitáció segítségével meghatározhatjuk a lekért elemek maximális számát. Használatuk opcionális: ha nem adunk meg limitet a lekérdezésben, akkor az összes elemet visszakapjuk a válaszban. (Az adott végpont alapértelmezett, maximális limitácijáónak megfelelően.)
Ha nem állítunk be limitációt a lekérdezésben, az alapértelmezett limit 25 elem / lekérdezés.
Limitáció használata a lekérdezésben:
https://api.whitefish.hu/products?limit=100Offset
Ha az alapértelmezett limitáción túli elemeket szeretnénk lekérni, azt több lekérésben történő lapozással érhetjük el. Az offset paraméterrel beállíthatjuk, hogy limitációban beállított mennyiséget hányadik elemtől listázza ki a lekérdezés.
Példa: az alábbi lekérdezés a terméklista 300. és 400. közti elemet adja vissza.
https://api.whitefish.hu/products?limit=100&offset=300Minta file-ok
Az alábbiekben összegyűjtöttük a felfontosabb lekérdezéseket tartalmazó minta kódokat PHP nyelven.
whitefish_api_php_mintalekerdezesek.zip
Végpontok
Rendelések
Szükséges hozzá engedélyezni az adott API hozzáférésnél a Rendelések hatókört.
Rendelések információi kérhetők le és tölthetők fel ezzel a végponttal.
A Rendelések erőforrás
Tulajdonságai
id integer
Adott rendelés belső azonosítója (rendelés ID) a WhiteFish rendszerében.
order_id string
Adott rendelés webshopos azonosítója.
order_status integer
Adott rendelés státusza. Lehetséges értékek: 0: beérkezett, 5: csomagolás alatt, 6: csomagolva, 7: felfüggesztve, 9: futárnak átadva, 10: személyes átvételre vár, 12: csomagponton vár, 14: kiszállítva, 16: visszaérkezett, átvétel megtagadva
delivery array
Szállítási adatokat tartalmazó tömb, elemei:
name string
Címzett neve.
email string
Címzett e-mail címe.
phone string
Címzett telefonszáma.
country_code string
Címzett ország 2 betűs kódja ISO 3166-1 alpha-2 szabvány alapján. Alapértelmezett: HU
postcode string
Címzett irányítószáma.
city string
Címzett város/település.
address string
Címzett utca, házszám.
address2 string
Címzett kiegészítő adatok (emelet, kapu, stb.).
shipping_comment string
Üzenet a futárnak.
shipping_method array
Szállítási metódus adatait tartalmazó tömb, elemei:
id integer
Szállítási metódus azonosítója. (1 = GLS házhozszállítás, 2 = személyes átvétel, 3 = FoxPost csomagautomata, 4 = GLS csomagpont/automata, 6 = MPL házhozszállítás, 7 = MPL postán maradó, 8 = MPL postapont, 9 = MPL csomagautomata, 10 - Packeta csomagautomata, 15 = GLS csomagbeszállítás a WhiteFish-be, 19 = PalletWays raklapos szállítás, 22 = Spring házhozszállítás, 20 = GLS külföldi csomagpont/automata)
provider_id integer
Szállító cég azonosítója. (1 = GLS, 2 = MPL, 4 = Foxpost, 5 = Packeta, 9 = PalletWays, 11 = Spring, 0 - (nincs meghatározva - személyes átvételnél is ezt használjuk)
point_id string
Csomagpont / csomagautomata / átvételi hely azonosítója a futárszolgálat rendszerében.
payment array
Fizetési adatokat tartalmazó tömb, elemei:
type integer
(1 = banki átutalás, 2 = online kártyás fizetés, 3 = PayPal, 4 = utánvét) Default 1.
cost float
Utánvét összege, 2 tizedesjegy pontossággal.
currency string
Utánvét pénznemének 3 betűs kódja ISO 4217 szabvány alapján. Alapértelmezett: HUF
content array
A rendelésben szereplő termékeket tartalmazó tömb, elemei 1-1 termék adatai, szintén tömbök:
id integer
Termék ID-ja a Whitefish rendszerében.
quantity integer
Darabszám
documents array
A rendeléshez kapcsolódó dokumentumokat tartalmazó tömb, elemei 1-1 dokumentim adatai, szintén tömbök:
pdf_url string
A dokumentum pdf URL-je.
to_print integer
Kell-e nyomtatni. (0 = nem, 1 = igen) Default 0.
on_product integer
Kell-e a termékre ragasztani. (0 = nem, 1 = igen) Default 0.
quantity integer
Darabszám. Default 0.
print_size string
Méret, pl. 85x85mm, 60x50mm, A4 stb.
pid string
Kapcsolódó termék ID-ja a Whitefish rendszerében.
parcel_number string
Csomagszám (több csomag esetén a vezércsomag száma).
is_completable integer
Küldhető rendelés (rendelkezik a raktár elegendő szabad készlettel és a rendelés jóvá van hagyva és nincs karanténban ÉS beérkezett státuszú). (1 = igen, 0 = nem.) Default 0.
is_approved integer
Jóváhagyott rendelés. (1 = igen, 0 = nem.) Default 0.
Rendelések listázása
Kérés
Ezzel az API végponttal lekérhetjük az összes, vagy néhány, vagy egy rendelés adatait a rendszerből.
Alapértelmezett limit: 25, maximum limit: 100
Szűrők
Szűrők segítségével szűkíthetjük a lekért rendelések körét. Használatuk opcionális: ha nem adunk meg szűrőt a lekérdezésben, akkor az összes rendelést visszakapjuk a válaszban.
Ha egy szűrőhöz több értéket állítunk be, azokat vesszővel (,) választjuk egy egymástól. Pl.:
https://api.whitefish.hu/orders?order_id=0123,0125Egyszerre több szűrőt is beállíthatunk, ha több különböző rendelés adaait lekérni. Ilyenkor a szűrők közti reláció alapesetben VAGY (or). Ebben az esetben azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek VALAMELYIKE érvényesül. Pl.:
https://api.whitefish.hu/orders?id=323424&order_id=0123Extrém esetben szükség lehet arra is, hogy ha több szűrőt használunk, az alapértelmezett VAGY (or) relációt megváltoztassuk ÉS (and) relációra. Így azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek MINDEGYIKE érvényesül. Pl.:
https://api.whitefish.hu/orders?id=323424&order_id=0123&relation=andSzűrhető paraméterek:
id
Csak a megadott WhiteFish azonosítóval rendelkező rendelést adja vissza a válaszban. Pl.:
Pl. https://api.whitefish.hu/orders?id=799337order_id
Csak a megadott webshopos rendeléssazonosítóval rendelkező rendelést adja vissza a válaszban. Pl.:
https://api.whitefish.hu/orders?order_id=0123email
Csak a megadott e-mail címről érkező rendelést adja vissza a válaszban. Pl.:
https://api.whitefish.hu/orders?email=gipsz@jakab.huMinta kérés
curl -X GET "https://api.whitefish.hu/orders?order_id=0123" \
-H "Authorization: Bearer {access_token}"Válasz
A válasz minden esetben egy json kódolt tömb, ami a kérés alapadatain túl - ha értelmezhető választ tud visszaadni, a response tömb code mezőjében adja vissza.
{
"orders": [
{
"id": "879586",
"order_id": "Teszt2",
"order_status": "0",
"delivery": {
"name": "Gipsz Jakab",
"email": "info@whitefish.hu",
"phone": "06301234567",
"country_code": "HU",
"postcode": "",
"city": "",
"address": "",
"address2": "",
"shipping_comment": ""
},
"shipping_method": {
"id": "4",
"provider_id": "1",
"point_id": "HU2051-PARCELLOCK03"
},
"payment": {
"type": "4",
"cost": "15499.00",
"currency": ""
},
"content": [
{
"id": "3266135",
"quantity": "3"
}
],
"documents": [
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "0",
"quantity": "2",
"print_size": "60x50",
"pid": "121324"
}
],
"parcel_number": "",
"is_approved": "0",
"is_completable": 0
},
{
"id": "879585",
"order_id": "Teszt1",
"order_status": "6",
"delivery": {
"name": "Gipsz Jakab",
"email": "info@whitefish.hu",
"phone": "06301234567",
"country_code": "HU",
"postcode": "2051",
"city": "Biatorbágy",
"address": "Mészárosok útja 2-4",
"address2": "",
"shipping_comment": "47. rámpa"
},
"shipping_method": {
"id": "99",
"provider_id": "0",
"point_id": 0
},
"payment": {
"type": "1",
"cost": "0.00",
"currency": "HUF"
},
"content": [
{
"id": "3266135",
"quantity": "4"
}
],
"documents": [
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "0",
"quantity": "2",
"print_size": "60x50",
"pid": "121324"
},
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "0",
"quantity": "2",
"print_size": "60x50",
"pid": "121324"
}
],
"parcel_number": "9960000879585",
"is_approved": "1",
"is_completable": 0
}
]
}Új rendelés létrehozása
A rendelések végpont felé POST metódussal indított kéréssel rendelést hozhatunk létre a WhiteFish rendszerében. A végpont a rendelés adatait az order kulcshoz tartozó, JSON formátumú tömbként (JSON array) várja a HTTP POST kérésben.
Minta kérés header
curl -X POST "https://api.whitefish.hu/orders" \
-H "Authorization: Bearer {access_token}"Minta kérés body
A HTTPS POST kérés order változójában beküldendő json formátumú tömböt így épül fel:
{
"order": {
"order_id": "Teszt2",
"delivery": {
"name": "Gipsz Jakab",
"email": "info@whitefish.hu",
"phone": "06305387957",
"country_code": "HU",
"postcode": "",
"city": "",
"address": "",
"address2": "",
"shipping_comment": "Csengessen a futár!"
},
"shipping_method": {
"id": "4",
"provider_id": "1",
"point_id": "HU2051-PARCELLOCK03"
},
"payment": {
"type": "4",
"cost": "15499.00",
"currency": "HUF"
},
"content": [
{
"id": "3266135",
"quantity": "3"
},
{
"id": "3266132",
"quantity": "1"
}
],
"documents": [
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "0",
"quantity": "3",
"size": "60x50",
"productId": "3266135"
},
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "1",
"quantity": "1",
"size": "60x50",
"productId": "3266132"
}
],
"is_approved": "0",
}
}
}
}Kötelező mezők: order_id (rendelésazonosító), delivery => name (címzett neve), delivery => email (címzett e-mail címe), delivery => phone (címzett telefonszáma), shipping_method (szállítási mód), payment (fizetési mód).
Opcionális mezők: az összes többi, "A Rendelések erőforrás" szekcióban felsorolt mező.
Válasz
A válasz minden esetben egy json kódolt tömb, ami a - ha értelmezhető választ tud visszaadni - a response tömb code mezőjében adja vissza a létrehozott rendelés adatait, különös tekintettel az id mezőre, ami az új rendelés WhiteFish rendszerében létrehozott azonosítóját tartalmazza.
Minta válasz siker esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"orders",
"filters":"",
"error":0,
"requestmode":"POST",
"response":{
"code":"{
"order": {
"id": "879586",
"order_id": "Teszt2",
"order_status": "0",
"delivery": {
"name": "Gipsz Jakab",
"email": "info@whitefish.hu",
"phone": "06305387957",
"country_code": "HU",
"postcode": "",
"city": "",
"address": "",
"address2": "",
"shipping_comment": ""
},
"shipping_method": {
"id": "4",
"provider_id": "1",
"point_id": "HU2051-PARCELLOCK03"
},
"payment": {
"type": "4",
"cost": "15499.00",
"currency": ""
},
"content": [
{
"id": "3266135",
"quantity": "3"
}
],
"documents": [
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "0",
"quantity": "2",
"size": "60x50",
"pid": "121324"
}
],
"parcel_number": "",
"is_approved": "0",
"is_completable": 0
}
}
}
}
}
Minta válasz hiba esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"orders",
"filters":"",
"error":1,
"requestmode":"POST",
"response":{
"code":"{
"error": [
{
"txt":"A megadott rendelésazonosítóval már szerepel rendelés az adatbázisban."
}
]
}
}
}
}
Rendelés módosítása
A rendelések végpont felé PATCH metódussal indított kéréssel adott rendelés adatait módosíthatjuk a WhiteFish rendszerében. A végpont a rendelés adatait az order kulcshoz tartozó, JSON formátumú tömbként (JSON array) várja a HTTP PATCH kérésben.
Minta kérés header
curl -X PATCH "https://api.whitefish.hu/orders" \
-H "Authorization: Bearer {access_token} \ Content-Type: application/json"Minta kérés body
A HTTPS PATCH kérés order változójában beküldendő json formátumú tömb így épül fel:
{
"id": "879586",
"delivery": {
"name": "Gipsz Jakab",
"email": "info@whitefish.hu",
"phone": "06301234567",
"country_code": "HU",
"postcode": "",
"city": "",
"address": "",
"address2": "",
"shipping_comment": ""
},
"shipping_method": {
"id": "4",
"provider_id": "1",
"point_id": "HU2051-PARCELLOCK03"
},
"payment": {
"type": "4",
"cost": "15499.00",
"currency": ""
},
"content": [
{
"id": "3266135",
"quantity": "3"
}
],
"documents": [
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "0",
"quantity": "2",
"print_size": "60x50",
"pid": "121324"
}
],
}
}Kötelező mező: id - a rendelés WhiteFish rendszerben szereplő azonosítója.
Opcionális mezők: az összes többi, "A Rendelés erőforrás" szekcióban felsorolt mező. Amelyik mezőt beküldjük, felülírja a WhiteFish rendszerében szereplő rendelés adatait akkor is, ha üresen küldjük be. A módosítani nem kívánt mezőket ne üres változóként küldjük be, hanem ne küldjük be.
Válasz
A válasz minden esetben egy json kódolt tömb, ami a - ha értelmezhető választ tud visszaadni - a response tömb code mezőjében adja vissza a módosított rendelés adatait.
Minta válasz siker esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"orders",
"filters":"",
"error":0,
"requestmode":"PATCH",
"response":{
"code":"{
"order": [
"order_id": "Teszt2",
"delivery": {
"name": "Gipsz Jakab",
"email": "info@whitefish.hu",
"phone": "06305387957",
"country_code": "HU",
"postcode": "",
"city": "",
"address": "",
"address2": "",
"shipping_comment": "Csengessen a futár!"
},
"shipping_method": {
"id": "4",
"provider_id": "1",
"point_id": "HU2051-PARCELLOCK03"
},
"payment": {
"type": "4",
"cost": "15499.00",
"currency": "HUF"
},
"content": [
{
"id": "3266135",
"quantity": "3"
},
{
"id": "3266132",
"quantity": "1"
}
],
"documents": [
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "0",
"quantity": "3",
"size": "60x50",
"productId": "3266135"
},
{
"pdf_url": "asd.pdf",
"to_print": "1",
"on_product": "1",
"quantity": "1",
"size": "60x50",
"productId": "3266132"
}
],
"is_approved": "0",
}
]
}
}
}
}
Minta válasz hiba esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"orders",
"filters":"",
"error":1,
"requestmode":"PATCH",
"response":{
"code":"{
"error": [
{
"txt":"A megadott rendelésazonosító (id) nem lehet üres."
}
]
}
}
}
}
Rendelés törlése
A rendelések végpont felé DELETE metódussal indított kéréssel adott rendelést törölhetjük a WhiteFish rendszerében. A végpont a rendelés adatait az order kulcshoz tartozó, JSON formátumú tömbként (JSON array) várja a HTTP PATCH kérésben.
Minta kérés header
curl -X DELETE "https://api.whitefish.hu/orders" \
-H "Authorization: Bearer {access_token} \ Content-Type: application/json"Minta kérés body
A HTTPS DELETE kérés order változójában beküldendő json formátumú tömb így épül fel:
{
"id": "879586",
}Kötelező mező: id - a rendelés WhiteFish rendszerben szereplő azonosítója. A kérésnek kizárólag ezt a mezőt kell tartalmaznia.
Válasz
A válasz minden esetben egy json kódolt tömb, ami a - ha értelmezhető választ tud visszaadni - a response tömb code mezőjében adja vissza a törölt rendelés azonosítóját.
Minta válasz siker esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"orders",
"filters":"",
"error":0,
"requestmode":"DELETE",
"response":{
"code":"{
"order": [
"id": "879586",
]
}
}
}
}
Minta válasz hiba esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"orders",
"filters":"",
"error":1,
"requestmode":"DELETE",
"response":{
"code":"{
"error": [
{
"txt":"A rendelés már nem 'beérkezett' státuszú, így nem törölhető."
}
]
}
}
}
}
Termékek
Szükséges hozzá engedélyezni az adott API hozzáférésnél a Termékek hatókört.
Termékinformációk kérhetők le és tölthetők fel ezzel a végponttal.
A Termékek erőforrás
Tulajdonságai
id integer
Adott termék belső azonosítója (termék ID) a WhiteFish rendszerében.
client_id string
Adott termék külső rendszerben vagy webshopmotorban létrehozott azonosítója. Azokban az esetekben, amikor a külső rendszerben egy terméknek termékvariációi is lehetnek, ez az azonosító mindig a termékvariáció azonosítóját (variation id) tartalmazza.
sku string
Adott termék elsődleges cikkszáma.
barcode string
Adott termék elsődleges vonalkódja.
barcodes array
Adott termék összes vonalkódja, tömbbe rendezve.
product_name string
Adott termék megnevezése.
photo string
A termékhez tartozó fotó URL-je.
size_length integer
Méret - hosszúság, cm-ben megadva.
size_width integer
Méret - szélesség, cm-ben megadva.
size_depth integer
Méret - mélység, cm-ben megadva.
size_weight integer
Tömeg, grammban megadva.
fragile integer
Törékeny. (1 = igen, 0 = nem.) Default 0.
oversized integer
Túlméretes. (1 = igen, 0 = nem.) Default 0.
special_packaging_check_for_packing string
Speciális csomagolási igény a termék kiküldés előtti csomagolásához.
to_be_cooled integer
Hűtve tárolandó. (1 = igen, 0 = nem.) Default 0.
to_be_frozen integer
Fagyasztva tárolandó. (1 = igen, 0 = nem.) Default 0.
is_bio integer
Csak BIO termékekkel együtt tárolható. (1 = igen, 0 = nem.) Default 0.
expirationdate_handling integer
Lejárati idő kezelés. (1 = igen, 0 = nem.) Default 0.
lot_handling integer
LOT szám kezelés. (1 = igen, 0 = nem.) Default 0.
serial_handling integer
Sorozatszám kezelés. (1 = igen, 0 = nem.) Default 0.
stock_min integer
Készlet minumumszint készletriasztáshoz.
Termékek listázása
Kérés
Ezzel az API végponttal lekérhetjük az összes, vagy néhány, vagy egy termék adatait a rendszerből.
Alapértelmezett limit: 25, maximum limit: 250
Szűrők
Szűrők segítségével szűkíthetjük a lekért termékek körét. Használatuk opcionális: ha nem adunk meg szűrőt a lekérdezésben, akkor az összes terméket visszakapjuk a válaszban.
Ha egy szűrőhöz több értéket állítunk be, azokat vesszővel (,) választjuk egy egymástól. Pl.:
https://api.whitefish.hu/products?barcode=8052469731430,8052469731423Egyszerre több szűrőt is beállíthatunk, ha több különböző termék készletét szeretnénk lekérni. Ilyenkor a szűrők közti reláció alapesetben VAGY (or). Ebben az esetben azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek VALAMELYIKE érvényesül. Pl.:
https://api.whitefish.hu/products?pid=799337&sku=41101004309Extrém esetben szükség lehet arra is, hogy ha több szűrőt használunk, az alapértelmezett VAGY (or) relációt megváltoztassuk ÉS (and) relációra. Így azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek MINDEGYIKE érvényesül. Pl.:
https://api.whitefish.hu/products?pid=799337&sku=41101004309&relation=andSzűrhető paraméterek:
id
Csak a megadott WhiteFish azonosítóval rendelkező termékeket adja vissza a válaszban. Pl.:
Pl. https://api.whitefish.hu/products?pid=799337barcode
Csak a megadott vonalkóddal rendelkező termékeket adja vissza a válaszban. Pl.:
https://api.whitefish.hu/products?barcode=8052469731430,80524697314237sku
Csak a megadott cikkszámmal rendelkező termékeket adja vissza a válaszban. Pl.:
https://api.whitefish.hu/products?sku=41969E01008Minta kérés
curl -X GET "https://api.whitefish.hu/products?sku=41969E01008" \
-H "Authorization: Bearer {access_token}"Válasz
A válasz minden esetben egy json kódolt tömb, ami a kérés alapadatain túl - ha értelmezhető választ tud visszaadni, a response tömb code mezőjében adja vissza.
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"products",
"filters":"sku=41101004309,pid=799337,",
"error":0,
"requestmode":"get",
"response":{
"code":"{
"products": [
{
"id":"799337",
"client_id":45435354,
"sku":"AHGS8934",
"barcode":"8586018512961",
"barcodes": [
"8586018512961",
"2346018512342"
],
"product_name":"Little Dutch Gyerek hátizsák",
"photo":"https://whitefish.hu/photos/products_1/demo4.jpg",
"fragile":"0",
"special_packaging_check_for_packing":"Tilos összehajtani.",
},
{
"id":"890152",
"client_id":345634564,
"sku":"41101004309",
"barcode":"4586018512966",
"product_name":"Kanken Art Mini hátizsák",
"photo":"https://whitefish.hu/photos/products_1/demo3.jpg",
"fragile":"0",
"special_packaging_check_for_packing":"",
}
]
}
}
}
}Új termék létrehozása
A termékek végpont felé POST metódussal indított kéréssel terméket hozhatunk létre a WhiteFish rendszerében. A végpont a termék adatait a product kulcshoz tartozó, JSON formátumú tömbként (JSON array) várja a HTTP POST kérésben.
Minta kérés header
curl -X POST "https://api.whitefish.hu/products" \
-H "Authorization: Bearer {access_token}"Minta kérés body
A HTTPS POST kérés product változójában beküldendő json formátumú tömböt így épül fel:
{
"sku":"SKU-123",
"barcode":"5993745271825",
"product_name":"Pöttyös labda",
"client_id":"4324ASDFG",
"size_weight":"1400g",
"expirationdate_handling":"1",
"lot_handling":"1",
"stock_min":"10"
}
}Kötelező mezők: sku (cikkszám), barcode (vonalkód), product_name (termék neve).
Opcionális mezők: az összes többi, "A Termékek erőforrás" szekcióban felsorolt mező.
Válasz
A válasz minden esetben egy json kódolt tömb, ami a - ha értelmezhető választ tud visszaadni - a response tömb code mezőjében adja vissza a létrehozott termék adatait, különös tekintettel az id mezőre, ami az új termék WhiteFish rendszerében létrehozott azonosítóját tartalmazza.
Minta válasz siker esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"products",
"filters":"",
"error":0,
"requestmode":"POST",
"response":{
"code":"{
"product": [
{
"id":"799337",
"sku":"SKU-123",
"barcode":"5993745271825",
"product_name":"Pöttyös labda",
"client_id":"4324ASDFG",
"size_weight":"1400g",
"expirationdate_handling":"1",
"lot_handling":"1",
"stock_min":"10"
}
]
}
}
}
}
Minta válasz hiba esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"products",
"filters":"",
"error":1,
"requestmode":"POST",
"response":{
"code":"{
"error": [
{
"txt":"A megadott vonalkóddal már szerepel termék az adatbázisban."
}
]
}
}
}
}
Termék módosítása
A termékek végpont felé PATCH metódussal indított kéréssel adott termék adatait módosíthatjuk a WhiteFish rendszerében. A végpont a termék adatait a product kulcshoz tartozó, JSON formátumú tömbként (JSON array) várja a HTTP PATCH kérésben.
Minta kérés header
curl -X PATCH "https://api.whitefish.hu/products" \
-H "Authorization: Bearer {access_token} \ Content-Type: application/json"Minta kérés body
A HTTPS PATCH kérés product változójában beküldendő json formátumú tömb így épül fel:
{
"id":"356767867",
"sku":"SKU-123",
"barcode":"5993745271825",
"barcodes": [
"5993745271825",
"2346018512342"
],
"product_name":"Pöttyös labda",
"client_id":"4324ASDFG",
"size_weight":"1400g",
"expirationdate_handling":"1",
"lot_handling":"1",
"stock_min":"10"
}
}Kötelező mező: id - a termék WhiteFish rendszerben szereplő azonosítója.
Opcionális mezők: az összes többi, "A Termékek erőforrás" szekcióban felsorolt mező. Amelyik mezőt beküldjük, felülírja a WhiteFish rendszerében szereplő termékadatot akkor is, ha üresen küldjük be. A módosítani nem kívánt mezőket ne üres változóként küldjük be, hanem ne küldjük be.
Fontos: további vonalkódokat csak feltölteni lehet a rendszerbe, technikailag nem törlődnek, hanem az új vonalkódok hozzáadódnak a termékhez tartozó vonalkódlistához.
Válasz
A válasz minden esetben egy json kódolt tömb, ami a - ha értelmezhető választ tud visszaadni - a response tömb code mezőjében adja vissza a módosított termék adatait.
Minta válasz siker esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"products",
"filters":"",
"error":0,
"requestmode":"PATCH",
"response":{
"code":"{
"product": [
{
"id":"799337",
"sku":"SKU-123",
"barcode":"5993745271825",
"barcodes": [
"5993745271825",
"2346018512342"
],
"product_name":"Pöttyös labda",
"size_weight":"1400g",
"expirationdate_handling":"1",
"lot_handling":"1",
"stock_min":"10"
}
]
}
}
}
}
Minta válasz hiba esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"products",
"filters":"",
"error":1,
"requestmode":"PATCH",
"response":{
"code":"{
"error": [
{
"txt":"A megadott termék azonosító (id) nem lehet üres."
}
]
}
}
}
}
Készlet
Szükséges hozzá engedélyezni az adott API hozzáférésnél a Készlet hatókört.
Termék vagy termékek aktuális készlete kérhető le ezzel a végponttal.
A Készlet erőforrás
Tulajdonságai
id integer
Adott termék belső azonosítója (termék ID) a WhiteFish rendszerében.
client_id string
Adott termék külső rendszerben vagy webshopmotorban létrehozott azonosítója. Azokban az esetekben, amikor a külső rendszerben egy terméknek termékvariációi is lehetnek, ez az azonosító mindig a termékvariáció azonosítóját (variation id) tartalmazza.
sku string
Adott termék elsődleges cikkszáma.
barcode string
Adott termék elsődleges vonalkódja.
name string
Adott termék megnevezése.
stock_all integer
Adott termék teljes, aktuális raktárkészlete. Magában foglalja a szabad készletet és a WhiteFish rendszerében megtalálható, kiküldetlen rendelések által foglalt készletet is.
stock_free integer
Adott termék aktuális szabad raktárkészlete.
stock array
Adott termék aktuális raktárkészlete, különböző lejárati idők és LOT számok szerint diverzifikálva.
Készlet listázása
Kérés
Ezzel az API végponttal lekérhetjük az összes, vagy néhány, vagy egy termék aktuális készletét és a hozzá tartozó információkat.
Alapértelmezett limit: 25, maximum limitáció: 250
Szűrők
Szűrők segítségével szűkíthetjük a lekért termékek körét. Használatuk opcionális: ha nem adunk meg szűrőt a lekérdezésben, akkor az összes termék készletét visszakapjuk a válaszban.
Ha egy szűrőhöz több értéket állítunk be, azokat vesszővel (,) választjuk egy egymástól. Pl.:
https://api.whitefish.hu/stock?barcode=8052469731430,8052469731423Egyszerre több szűrőt is beállíthatunk, ha több különböző termék készletét szeretnénk lekérni. Ilyenkor a szűrők közti reláció alapesetben VAGY (or). Ebben az esetben azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek VALAMELYIKE érvényesül. Pl.:
https://api.whitefish.hu/stock?pid=799337&sku=41101004309Extrém esetben szükség lehet arra is, hogy ha több szűrőt használunk, az alapértelmezett VAGY (or) relációt megváltoztassuk ÉS (and) relációra. Így azokat az elemeket fogja visszaadni a szűrő, amikre a feltételek MINDEGYIKE érvényesül. Pl.:
https://api.whitefish.hu/stock?pid=799337&sku=41101004309&relation=andSzűrhető paraméterek:
id
Csak a megadott WhiteFish azonosítóval rendelkező termékeket adja vissza a válaszban. Pl.:
Pl. https://api.whitefish.hu/stock?pid=799337barcode
Csak a megadott vonalkóddal rendelkező termékeket adja vissza a válaszban. Pl.:
https://api.whitefish.hu/stock?barcode=8052469731430,80524697314237sku
Csak a megadott cikkszámmal rendelkező termékeket adja vissza a válaszban. Pl.:
https://api.whitefish.hu/stock?sku=41969E01008Minta kérés
curl -X GET "https://api.whitefish.hu/stock?sku=41969E01008" \
-H "Authorization: Bearer {access_token}"Válasz
A válasz minden esetben egy json kódolt tömb, ami a kérés alapadatain túl - ha értelmezhető választ tud visszaadni, a response tömb code mezőjében adja vissza.
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"stock",
"filters":"sku=41101004309,pid=799337,",
"error":0,
"requestmode":"get",
"response":{
"code":"{
"products": [
{
"id":"890152",
"client_id": "123ASD",
"sku":"AHGS8934",
"barcode":"8586018512961",
"name":"Fehérje 100g banános",
"stock_all":"9",
"stock_free":"8",
"stock": [
{
"quantity":"2",
"expiration_date":"2025-12-10",
"lot":"APH123"
}
},
{
"quantity":"7",
"expiration_date":"2026-06-11",
"lot":"BRT922"
}
}
},
{
"id":"799337",
"client_id":0,
"sku":"41969E01008",
"barcode":"8586018451703",
"name":"Krimpelő cső 20db",
"stock_all":"9",
"stock_free":"9",
"stock": [
{
"quantity":"9",
"expiration_date":"",
"lot":""
}
]
]
}
}
}
}Beszállítások
Szükséges hozzá engedélyezni az adott API hozzáférésnél a Beszállítások hatókört.
Raktárba történő termékbeszállítások kérhetők le és tölthetők fel ezzel a végponttal.
A Beszállítások erőforrás
Tulajdonságai
id integer
Adott beszállítás belső azonosítója a WhiteFish rendszerében.
upload_date datetime
Beszállítás feltöltésének időpontja.
partner_name string
Beszállító partner (pl. gyártó vagy nagyker) neve.
partner_id string
Beszállító partner (pl. gyártó vagy nagyker) belső azonosítója a WhiteFish rendszerében.
products array
A beszállításban szereplő termékeket tartalmazó tömb, elemei 1-1 termék adatai, szintén tömbök:
id integer
Termék ID-ja a Whitefish rendszerében.
quantity integer
Darabszám
Beszállítások listázása
Kérés
Ezzel az API végponttal lekérhetjük az összes, vagy néhány, vagy egy beszállítás adatait a rendszerből.
Alapértelmezett limit: 10, maximum limit: 25
Minta kérés
curl -X GET "https://api.whitefish.hu/inbound" \
-H "Authorization: Bearer {access_token}"Válasz
A válasz minden esetben egy json kódolt tömb, ami a kérés alapadatain túl - ha értelmezhető választ tud visszaadni, a response tömb code mezőjében adja vissza.
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"inbound",
"filters":"",
"error":0,
"requestmode":"get",
"response":{
"code":"{
"inbound": [
{
"id":"799337",
"partner_name":"Új beszállító partner #1",
"partner_id":"1278",
"upload_date":"2026-08-11 13:28:51",
"products": [
{
"id":"36456",
"quantity":"1",
},
{
"id":"36459",
"quantity":"10",
}
]
},
]
}
}
}
}Új beszállítás létrehozása
A beszállítások végpont felé POST metódussal indított kéréssel beszállítást hozhatunk létre a WhiteFish rendszerében. A végpont a beszállítás adatait az inbound kulcshoz tartozó, JSON formátumú tömbként (JSON array) várja a HTTP POST kérésben.
Minta kérés header
curl -X POST "https://api.whitefish.hu/inbound" \
-H "Authorization: Bearer {access_token}"Minta kérés body
A HTTPS POST kérés inbound változójában beküldendő json formátumú tömb így épül fel:
{
"partner_name":"Új beszállító partner #1",
"products": [
{
"id":"36456",
"quantity":"1",
},
{
"id":"36459",
"quantity":"10",
}
]
}
}Kötelező mezők: partner_name (beszállító partner neve), és products tömb (minden elemnél id és quantity, ahol az id a WhiteFish rendszerében található termék id-t jelöli).
Válasz
A válasz minden esetben egy json kódolt tömb, ami a - ha értelmezhető választ tud visszaadni - a response tömb code mezőjében adja vissza a létrehozott beszállítás adatait, különös tekintettel az id mezőre, ami az új beszállítás WhiteFish rendszerében létrehozott azonosítóját tartalmazza.
Minta válasz siker esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"inbound",
"filters":"",
"error":0,
"requestmode":"POST",
"response":{
"code":"{
"id":"16887",
"upload_date":"2026-08-11 13:28:51",
"partner_name":"Új beszállító partner #1",
"partner_id":"1836",
"products": [
{
"id":"36456",
"quantity":"1",
},
{
"id":"36459",
"quantity":"10",
}
]
}
}
}
}
Minta válasz hiba esetén
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"inbound",
"filters":"",
"error":1,
"requestmode":"POST",
"response":{
"code":"{
"error": [
{
"txt":"Az alábbi termékazonosítókkal nem sikerült terméket beazonosítani: 666"
}
]
}
}
}
}
Bevételezés
Szükséges hozzá engedélyezni az adott API hozzáférésnél a Bevételezés hatókört.
Bevételezések kérhető le ezzel a végponttal.
A Bevételezések erőforrás
Bevételezések
id integer
Adott bevételezés belső azonosítója (bevételezés ID) a WhiteFish rendszerében.
datum datetime
Adott bevételezés dátuma és ideje. Formátum: YYYY-MM-DD HH:II, azaz pl. 2026-02-11 11:34
supplier string
Beszállító partner neve.
is_return integer
Visszáru bevételezés? (1 = igen, 0 = nem.) Default 0.
Kérés
Ezzel az API végponttal lekérhetjük az összes, vagy néhány, vagy egy bevételezés adatait a rendszerből.
Alapértelmezett limit: 10, maximum limitáció: 25
Szűrők
Szűrők segítségével szűkíthetjük a lekért bevételezések körét. Használatuk opcionális: ha nem adunk meg szűrőt a lekérdezésben, akkor az összes bevételezést visszakapjuk a válaszban.
Ha egy szűrőhöz több értéket állítunk be, azokat vesszővel (,) választjuk egy egymástól. Pl.:
https://api.whitefish.hu/receiving?date=2026-02-11,2026-02-12Szűrhető paraméterek:
date
Csak a megadott napon történt bevételezéseket adja vissza válaszban. Pl.:
Pl. https://api.whitefish.hu/receiving?date=2026-02-11Minta kérés
curl -X GET "https://api.whitefish.hu/receiving?date=2026-02-11" \
-H "Authorization: Bearer {access_token}"Válasz
A válasz minden esetben egy json kódolt tömb, ami a kérés alapadatain túl - ha értelmezhető választ tud visszaadni, a response tömb code mezőjében adja vissza.
{
"token":"ded182e65610f6c15fca80c483356f6d",
"endpoint":"receiving",
"filters":"date=2026-02-11",
"error":0,
"requestmode":"get",
"response":{
"code":"{
"receiving": [
{
"id":"23422",
"datum":"2026-02-11 13:32",
"supplier":"Siófoki fügenagyker",
"is_return":"0",
"products":[
{
"id":"799337",
"client_id":"45435354",
"sku":"AHGS8934",
"barcode":"8586018512961",
"title":"Little Dutch Gyerek hátizsák",
"quantity":"2",
"expiration_date":"",
"lot":"",
},
{
"id":"1239337",
"client_id":"123132",
"sku":"49943563434",
"barcode":"49943563434",
"title":"Fehérje 100g banános",
"quantity":"1",
"expiration_date":"2025-12-10",
"lot":"APH123",
},
]
}
]
}
}
}
}