Belföldi csomagfeladás gyorsan és olcsón

1. BEVEZETÉS

A Foxpost 2021. októberében publikálta legújabb, FoxWeb API névre keresztelt API-ját. Jelen dokumentum segítséget nyújt a FoxWeb API-ra történő átálláshoz, valamint új integrációk megvalósításához.

A FoxWeb API RESTful API, működési elve szinkron: a hívás azonnali válaszban tér vissza, a hívás sikerességének visszajelzésével, valamint annak eredményével, a szükséges adatokkal együtt.

Amennyiben az API összekötéssel kapcsolatban informatikai jellegű kérdése merülne fel, keressen minket a b2chelpdesk@foxpost.hu email címen.

A FoxWeb API Swagger dokumentációja itt érhető el:

production: https://webapi.foxpost.hu/swagger-ui/index.html
sandbox: https://webapi-test.foxpost.hu/swagger-ui/index.html

2. API HÍVÁSHOZ SZÜKSÉGES ADATOK

Az API használatához legelőször a https://foxpost.hu/uzleti-partner-regisztracio oldalon kell üzleti partnerként regisztrálni. Amennyiben ez sikeresen megtörtént, akkor kezdhető el az integráció.

Az API authentikációhoz három adatra van szükség:

Basic auth username
Basic auth password
API-key

Az API hívásához szükséges paraméterek a foxpost.hu oldalra belépve, a Beállítások (https://foxpost.hu/beallitasok) aloldal tetején találhatók.

Amennyiben az API-key mező üres, abban az esetben az "Új generálása" gombra kattintva generálható az API kulcs. A kulcs módosítására szintén itt van lehetőség.

Egy fiókhoz csak egy API kulcs generálására van lehetőség, azonban egy kulcsot több helyen is lehet használni.

A tesztkörnyezetünk (Sandbox) használatához szükséges regisztrációban kérje B2C ügyfélszolgálatunk (b2chelpdesk@foxpost.hu) segítségét.

3. HÍVÁS ÉS AZONOSÍTÁS

A Webapi API baseUrl-je:

Éles környezet: https://webapi.foxpost.hu/api

Tesztkörnyezet (sandbox): https://webapi-test.foxpost.hu/api

Basic auth

Az API Basic authentikációval jelentkeztet be, melynek két paramétere az Basic auth username és a Basic auth password. Ezt a két adatot minden hívásnál küldeni kell.

Api kulcs

A másik kötelező paraméter az API-key, melyet minden hívás esetén Header paraméterként szükséges küldeni.

Fejlécek

Az API json adatformátummal kommunikál, így vár minden adatot és - néhány eseten kívül - így is adja vissza a választ. Ahol a visszatérési érték nem json, ott ez külön kiemelésre kerül! A kommunikációhoz szükséges fejlécek:

                        
{
    "Content-Type": "Application/json",
    "Api-key": "...",
}

4. CSOMAGAUTOMATA (APM) LISTA (JSON)

A FoxPost csomagautomatáinak (https://foxpost.hu/csomagautomatak) folyamatosan, óránként frissülő listája az alábbi címen érhető el:

https://cdn.foxpost.hu/apms.json

Új csomagautomata telepítése, illetve a meglévők megszűnése/inaktiválása is ebben a json fájlban követhető.

Az állomány mezőinek leírása:

Mező neve	Leírás
place_id	Automata azonosítója, új kapcsolat esetén nem ezt, hanem az operator_id-t kell használni
operator_id	Automata azonosítója, új kapcsolat esetén ezt a mezőt szükséges használni!
name	Automata neve
vapt	Csak adott típusú csomagok fogadására alkalmas automata, új kapcsolat esetén nem releváns
olapt	Csak adott típusú csomagok fogadására alkalmas automata, új kapcsolat esetén nem releváns
japt	Csak adott típusú csomagok fogadására alkalmas automata, új kapcsolat esetén nem releváns
ssapt	Csak adott típusú csomagok fogadására alkalmas automata, új kapcsolat esetén nem releváns
sdapt	Csak adott típusú csomagok fogadására alkalmas automata, új kapcsolat esetén nem releváns
group	Automata (pl. település alapján meghatározott) csoportja
address	Automata helyének teljes címe
zip	Automata helyének irányítószáma
city	Automata helyének települése
street	Automata helyének közterülete (közterület név, jelleg, házszám)
findme	Megtalálhatóság, az adott helyen (címen) belül hol található az automata
geolat	GPS szélességi koordináta
geolng	GPS hosszúsági koordináta
allowed2	Megadja, hogy az adott automatából milyen típusú csomagot lehet küldeni. Lehetséges értékei: "ALL" - bármilyen típusú csomag küldhető "C2C" - csak C2C csomag adható fel "B2C" - csak B2C csomag adható fel
load	Automata telítettsége Lehetséges értékei: normal loaded medium loaded overloaded
isOutdoor	Megadja, hogy az automata kültéren helyezkedik-e el. Lehetséges értékei (boolean): true false
apmType	Automata gyártó szerinti típusa. Lehetséges értékei: Cleveron Keba Rollkon Rotte
substitutes	Automata (telítettség esetén automatikus átirányítást lehetővé tevő) helyettesítő automatája/automatái
open	Nyitvatartási idő, napok szerint
fillEmptyList	Megadja azokat az időszakokat, amikor az adott automatába elhelyezésre (filling), illetve, amikor onnan elszállításra (emptying) kerülnek a csomagok.

5. CSOMAGSTÁTUSZOK

Az alábbi táblázat a FoxPost rendszere által használt csomag-nyomonkövetési (tracking) státuszok leírását tartalmazza. Azok a státuszok “technikaiak”, amiknél nincs rövid elnevezés, illetve hosszú elnevezés megadva: a https://foxpost.hu/csomagkovetes oldalon történő nyomonkövetésben nem jelennek meg, de az API-n átadásra kerülnek.

Kód	Szállítási típus	Rövid elnevezés	Hosszú elnevezés
CREATE	Házhozszállítás Csomagautomata	Csomagod elkészült	Csomagod létrejött a rendszerünkben, a feladó még nem adta át azt a FOXPOST részére.
OPERIN	Csomagautomata	Automatában	Csomagod megérkezett az általad választott (vissza)kézbesítési automatába, most már átveheted!
OPEROUT	Csomagautomata	Úton	Csomagodat futárunk kivette a csomagautomatából.
RECEIVE	Csomagautomata	Átvéve	Csomagod (vissza)kézbesítve lett, a címzett/feladó átvette.
RETURN	Házhozszállítás Csomagautomata	-	-
REDIRECT	Csomagautomata	Raktárban	Csomagodat az automata telítettsége / műszaki hibája miatt átírányítottuk egy másik csomagautomatába < destination_apm >
OVERTIMEOUT	Csomagautomata	Visszaküldve	Csomagod nem került átvételre a tárolási idő alatt, ezért a küldeményt visszaküldjük a feladónak.
SORTIN	Házhozszállítás Csomagautomata	Raktárban	Csomagod beérkezett a FoxPost raktárába. A feladott/visszaküldött csomagot hamarosan kézbesítjük.
SORTOUT	Házhozszállítás Csomagautomata	Úton	Csomag úton (kiszállítás/visszaszállítás alatt) van az általad választott csomagautomatához.
SLOTCHANGE	Csomagautomata	-	-
OVERTIMED	Csomagautomata	-	-
MPSIN	Csomagautomata	-	-
C2CIN	Csomagautomata	Automatában	Csomagod fel lett adva, a csomagautomatában el lett helyezve. A neked címzett (feladott/visszaküldött) csomagot hamarosan kézbesítjük.
HDSENT	Házhozszállítás	Raktárban	Csomagod beérkezett a FoxPost raktárába, hamarosan átadjuk a házhozszállítást végző partnerünknek.
HDDEPO	Házhozszállítás	Úton	Csomagod megérkezett a házhozszállítást végző partnerünk kiszállító depójába.
HDINTRANSIT	Házhozszállítás	-	-
HDRETURN	Házhozszállítás	Visszaszállítva	Csomagodat a címzett a házhozszállítás során nem vette át (oka: < info_field >), a csomag visszaszállításra került a FoxPost raktárába.
HDRECEIVE	Házhozszállítás	Átvéve	Csomagod házhozszállítással kézbesítve lett, a címzett átvette.
WBXREDIRECT	Házhozszállítás	-	-
BACKTOSENDER	Házhozszállítás Csomagautomata	Úton	Csomagot a címzett nem vette át, a csomag vissza lett küldve a feladónak.
HDHUBIN	Házhozszállítás	-	-
HDHUBOUT	Házhozszállítás	Úton	Csomagod a házhozszállítást végző partnerünk raktárát elhagyta. Partnerünk a csomagot hamarosan kézbesíti.
HDCOURIER	Házhozszállítás	Úton	Csomagod kiszállítás alatt van, a házhozszállítást végző partnerünk futára hamarosan kézbesíti.
HDUNDELIVERABLE	Házhozszállítás	Úton	Csomagod a házhozszállítás során nem lett átvéve, kézbesítése egyelőre sikertelen (oka: < info_field >).
PREPAREDFORPD	Házhozszállítás	Raktárban	Csomagodat az automata telítettsége / műszaki hibája miatt személyesen veheted át munkatársunktól. < delivery_date >
INWAREHOUSE	Házhozszállítás Csomagautomata	Raktárban	Címzett által át nem vett / visszaküldött csomagod visszaszállításra került a FoxPost raktárába.
COLLECTSENT	Házhozszállítás Csomagautomata	Raktárban	Visszaküldött csomagod előkészítettük átadásra.
C2BIN	Csomagautomata	Automatában	Csomagot a feladó (eredeti csomag címzettje) visszaküldte, a csomagautomatában elhelyezte.
RETURNED	Házhozszállítás Csomagautomata	Visszaküldve	Átvevő által visszaküldött csomag.
COLLECTED	Házhozszállítás Csomagautomata	Úton	Csomagodat partnerünk átadta részünkre, már úton van a raktárunkba.
BACKLOGINFULL	Csomagautomata	Túltelítettség miatt nem betölthető	Csomagodat a célautomata túltelítettsége miatt egyelőre nem tudjuk kézbesíteni, amint szabadul fel hely, csomagodat behelyezzük.
BACKLOGINFAIL	Csomagautomata	Műszaki hiba miatt nem betölthető	Csomagodat a célautomata műszaki hibája miatt egyelőre nem tudjuk kézbesíteni, amint a hibát javítottuk, csomagodat behelyezzük.
MISSORT	Házhozszállítás Csomagautomata	Téves szortolás	A csomag nem megfelelő automatára lett szortolva.
EMPTYSLOT	Csomagautomata	Üres rekesz	Futárunk csomag nélküli üres rekeszt talált.
RESENT	Házhozszállítás Csomagautomata	Raktárban	Az át nem vett csomagod újraküldésre került.
PREREDIRECT	Csomagautomata	-	-
RETURNCOURIER	Házhozszállítás Csomagautomata	Úton	Visszaküldött csomagod a futárunknál van, hamarosan átadja üzleti partnerünk részére.
RETURNDELIVERED	Házhozszállítás Csomagautomata	Átvéve	Visszaküldött csomagodat üzleti partnerünk átvette.
DESTROYED	Csomagautomata	-	-

6. API-VÉGPONTOK LEÍRÁSA

6.1. PARCELS (NORMAL csomagok létrehozása)

A FoxPost rendszerében az alábbi végpontok hívásával lehet új „normál” (nem visszáru) csomagot létrehozni, illetve már létrejött (CREATE státuszú) csomag adatait módosítani, törölni.

POST/api/parcel

Új normál csomag létrehozására szolgáló végpont.

Egy hívással több csomag is átadható, amennyiben egynél több elemű json kerül átadásra.

Két fajta csomagot különböztetünk meg, egyik típus a csomagautomatába történő szállítás APM), másik pedig a házhozszállításos csomag (továbbiakban HD). A csomagok beküldése történhet vegyesen is, nem kell külön küldeni az APM és a HD rendeléseket.

Request query

Paraméter név	Típus	Leírás
isWeb Opcionális	Boolean	Megadja, hogy a csomag megjelenjen-e a foxpost.hu oldalon, a Csomagjaim menüpontban (csak foxpost.hu regisztrált ügyfeleknek érhető el). Tesztkörnyezetben (sandbox-ban) való csomag létrehozás során a kérést isWeb = false paraméterrel kell beküldeni. Engedélyezett értékek: true, false Alapértelmezett érték: true

Request body

Paraméter név	Típus	Leírás
[] Kötelező	RequestItem[]	Tetszőleges számú HD vagy APM Request Item tömb.

Request Items

Paraméter név	Típus	Leírás
cod Opcionális	Integer	Utánvét értéke. Minimális érték: 0 Maximális érték: 1000000 Alapértelmezett érték: 0
comment Opcionális	String	Csomaghoz kapcsolódó szöveges kiegészítés (pl. mit tartalmaz a csomag). Minimális hossz: 0 Maximális hossz: 50 Alapértelmezett érték: null
destination Kötelező	String	A célautomata kódja. Értéke a json fájl operator_id mezője.
label Opcionális	Boolean	Megadja, hogy a Foxpost nyomtasson-e címkét. Csak C2C típusú csomag esetén használatos, üzleti partnerek (webshop-ok) integrációja esetén nem releváns.
recipientEmail Kötelező	String	Címzett email címe, melynek formailag helyes email címnek kell lennie!
recipientName Kötelező	String	Címzett neve Minimális hossz: 1 Maximális hossz: 150
recipientPhone Kötelező	String	Címzett telefonszáma +36 formátumban. Csak magyarországi mobiltelefon-számokat fogad el a rendszer! reguláris kifejezés: ^(\+36\|36)(20\|30\|31\|70\|50\|51)\d{7}$ Kérésre, a FoxPost üzleti kapcsolattartójával való egyeztetés alapján, a telefonszám validáció kikapcsolható.
refCode Opcionális	String	Ügyfél-oldali (pl. megrendelés, számla, visszáru) azonosításhoz használható csomagazonosító szám. Értéke tetszőleges lehet, ugyanakkor javasolt egyedivé tenni. Ha kitöltésre kerül, akkor az értéke megjelenik a címkén. Minimális hossz: 0 Maximális hossz: 30
size Kötelező	String	Csomag mérete, melynek értékét kötelező megadni a csomag létrehozásakor. Azonban a rendszer ezt ekkor még nem veszi figyelembe, így az értéke létrehozáskor lehet fixen például `M`. A végleges érték a Foxpost raktári folyamatai során, automatikusan kerül meghatározásra. Lehetséges értékek: ["XS","S", "M", "L", "XL"] vagy ["1", "2", "3", "4", "5"]
uniqueBarcode Opcionális	String	Egyedi vonalkód, amely csak automatába történő szállítás esetén használható. Ebben az esetben a címkére nem a Foxpost által generált CLFOX kezdetű vonalkód lesz rányomtatva, hanem a webshop által generált vonalkód. A vonalkódnak egyedinek kell lennie, két egyforma vonalkód nem fordulhat elő a Foxpost rendszerében, ezért fontos, hogy a webshop gondoskodjon a vonalkód egyediségéről. Kérjük, hogy az átadandó kódokat ún. hibrid, legalább 4 betűt és legalább 4 számot tartalmazó azonosítók használatával tegyék egyedivé. A betűk lehetőség szerint utaljanak az adott partnerre. Például: FIRMA987654321 Amennyiben olyan vonalkód kerül átadásra, ami már létezik a rendszerben, úgy a csomag létrehozása sikertelen lesz (DUPLICATED_UNIQUE_BARCODE hibakód). Minimális hossz: 0 Maximális hossz: 20

Paraméter név	Típus	Leírás
barcode Kötelező	String	Módosítás esetén a módosított csomag CLFOX kezdetű azonosítója. Alapértelmezett érték: null
cod Opcionális	Integer	Utánvét értéke. Minimális érték: 0 Maximális érték: 1000000 Alapértelmezett érték: 0
comment Opcionális	String	Csomaghoz kapcsolódó szöveges kiegészítés (pl. mit tartalmaz a csomag). Minimális hossz: 0 Maximális hossz: 50 Alapértelmezett érték: null
deliveryNote Opcionális	String	Futárnak szóló üzenet. Minimális hossz: 0 Maximális hossz: 50 Alapértelmezett érték: null
fragile Opcionális	Boolean	Megadja, hogy a csomag törékeny árut tartalmaz-e. Engedélyezett értékek: true, false Alapértelmezett érték: true
label Opcionális	Boolean	Megadja, hogy a Foxpost nyomtasson-e címkét. Csak C2C típusú csomag esetén használatos, üzleti partnerek (webshop-ok) integrációja esetén nem releváns.
recipientAddress Kötelező	String	Címzett szállítási címének további adatai (közterület neve és jellege, házszám, emelet, ajtó stb.). Minimális hossz: 1 Maximális hossz: 150
recipientCity Kötelező	String	Címzett szállítási címe település Minimális hossz: 1 Maximális hossz: 50
recipientCountry Opcionális	String	Címzett szállítási országa
recipientEmail Kötelező	String	Címzett email címe, melynek formailag helyes email címnek kell lennie!
recipientName Kötelező	String	Címzett neve Minimális hossz: 1 Maximális hossz: 150
recipientPhone Kötelező	String	Címzett telefonszáma +36 formátumban. Csak magyarországi mobiltelefon-számokat fogad el a rendszer! reguláris kifejezés: ^(\+36\|36)(20\|30\|31\|70\|50\|51)\d{7}$ Kérésre, a FoxPost üzleti kapcsolattartójával való egyeztetés alapján, a telefonszám validáció kikapcsolható.
recipientZip Kötelező	String	Címzett szállítási címének irányítószáma Minimális hossz: 1000 Maximális hossz: 9999
refCode Opcionális	String	Ügyfél-oldali (pl. megrendelés, számla, visszáru) azonosításhoz használható csomagazonosító szám. Értéke tetszőleges lehet, ugyanakkor javasolt egyedivé tenni. Ha kitöltésre kerül, akkor az értéke megjelenik a címkén. Minimális hossz: 0 Maximális hossz: 30
size Kötelező	String	Csomag mérete, melynek értékét kötelező megadni a csomag létrehozásakor. Azonban a rendszer ezt ekkor még nem veszi figyelembe, így az értéke létrehozáskor lehet fixen például `M`. A végleges érték a Foxpost raktári folyamatai során, automatikusan kerül meghatározásra. Lehetséges értékek: ["XS","S", "M", "L", "XL"] vagy ["1", "2", "3", "4", "5"]
uniqueBarcode Opcionális	String	Egyedi vonalkód, amely csak automatába történő szállítás esetén használható. Ebben az esetben a címkére nem a Foxpost által generált CLFOX kezdetű vonalkód lesz rányomtatva, hanem a webshop által generált vonalkód. A vonalkódnak egyedinek kell lennie, két egyforma vonalkód nem fordulhat elő a Foxpost rendszerében, ezért fontos, hogy a webshop gondoskodjon a vonalkód egyediségéről. Kérjük, hogy az átadandó kódokat ún. hibrid, legalább 4 betűt és legalább 4 számot tartalmazó azonosítók használatával tegyék egyedivé. A betűk lehetőség szerint utaljanak az adott partnerre. Például: FIRMA987654321 Amennyiben olyan vonalkód kerül átadásra, ami már létezik a rendszerben, úgy a csomag létrehozása sikertelen lesz (DUPLICATED_UNIQUE_BARCODE hibakód). Minimális hossz: 0 Maximális hossz: 20

Response

Kód	Megnevezés	Leírás
200	OK	A kérés helyes volt, viszont valamelyik beküldött csomag adat nem, ezért a csomag nem generálódott le a Foxpost rendszerében. Ilyenkor a válasz objektumban a „valid” mező értéke false, az "errors" pedig tartalmazza a hibákat.
201	CREATED	A csomag(ok) sikeresen legenerálódott (legenerálódtak) a Foxpost rendszerében.

Válasz objektum

A válasz objektumban minden egyes rendeléshez visszakapjuk azokat az adatokat, amik mentésre kerültek. Ezek az adatok reprezentálják, hogy a Foxpost rendszerében mi került lementésre. Mindkét rendeléstípus esetén ugyanazokat a kulcsokat kapjuk vissza.

Kulcs	Szállítási típus	Leírás
recipientName	Házhozszállítás Csomagautomata	Címzett neve
recipientPhone	Házhozszállítás Csomagautomata	Címzett telefonszáma +36 formátumban
recipientEmail	Házhozszállítás Csomagautomata	Címzett email címe
size	Házhozszállítás Csomagautomata	Csomag mérete
recipientCity	Házhozszállítás	Címzett szállítási címe település Alapértelmezett: null
recipientZip	Házhozszállítás	Címzett szállítási címének irányítószáma Alapértelmezett: null
recipientAddress	Házhozszállítás	Címzett szállítási címének további adatai (közterület neve és jellege, házszám, emelet, ajtó stb.) Alapértelmezett: null
recipientCountry	Házhozszállítás	Címzett szállítási országa Minimális hossz: 0 Maximális hossz: 3
cod	Házhozszállítás Csomagautomata	Utánvét értéke Alapértelmezett: 0
deliveryNote	Házhozszállítás	Futárnak szóló üzenet Alapértelmezett: null
comment	Házhozszállítás Csomagautomata	Csomaghoz kapcsolódó szöveges kiegészítés (pl. mit tartalmaz a csomag). Alapértelmezett: null
label	Házhozszállítás	Megadja, hogy a Foxpost nyomtasson-e címkét. Alapértelmezett: null
fragile	Házhozszállítás	Megadja, hogy a csomag törékeny árut tartalmaz-e. Alapértelmezett: false
uniqueBarcode	Csomagautomata	Egyedi vonalkód Alapértelmezett: null
refCode	Házhozszállítás Csomagautomata	Ügyfél-oldali (pl. megrendelés, számla, visszáru) azonosításhoz használható csomagazonosító szám. Alapértelmezett: null
barcode	Házhozszállítás Csomagautomata	Módosítás esetén a módosított csomag CLFOX kezdetű azonosítója. Alapértelmezett: null
errors	Házhozszállítás Csomagautomata	A hibákat tartalmazó kulcs. Ha legalább egy hiba van, akkor értéke egy json, ami egyesével tartalmazza a hibákat. Minden hiba egy json objektum, két kulccsal: {field: 'mező neve', 'message': 'hiba kódja'} Alapértelmezett: null
barcodeTof	Házhozszállítás	A csomag házhozszállítását végző partner (50139 kezdetű) csomagazonosítója. Házhozszállításos csomag esetén ez kerül a címkére, illetve ez használható a csomagnyomkövetés (tracking) lekérdezésnél is. Alapértelmezett: null
sendCode	Házhozszállítás Csomagautomata	Csomag feladási kódja, B2C (webshop) feladás esetén nem releváns.
clFoxId	Házhozszállítás Csomagautomata	A csomag CLFOX kezdetű Foxpost-os azonosítója
partnerType	Házhozszállítás Csomagautomata	Lehetséges értéke (webshop integráció esetén): "B2C"
parcelType	Csomagautomata	Csomag típusa, értéke automatikusan töltődik. Lehetséges értékei: "NORMAL" (Normál csomag) "RE" (Címzett által visszaküldött, eredetileg Foxpost által kiszállított csomag) "XRE" (Címzett által visszaküldött, eredetileg más csomagküldő által kiszállított csomag) "IRE" (Kiszállító által visszaküldött, lejárt tartási idejű, címzett által (tartási időn belül) át nem vett csomag) "C2B" (Magánszemély címzett által feladott, üzleti partnernek átadandó csomag)
sendType	Házhozszállítás Csomagautomata	Csomagküldés típusa. Lehetséges értékei: "HD", "APM", "COLLECT”
orderId	Házhozszállítás Csomagautomata	Rendelési azonosító, integrációs szempontból nem releváns.
destination	Csomagautomata	A célautomata kódja Alapértelmezett: null
validTo	Házhozszállítás Csomagautomata	Érvényességi idő
routeInfo { routeNumber countryCode labelSubType depoCode destinationApm }	Házhozszállítás Csomagautomata	A csomag futár általi betöltését/kézbesítését támogatandó, egyedi címke esetében feltüntetendő információk: járatszám, ország azonosító, címke típus (webshop esetén: B2C), depó azonosító, célautomata azonosítója.

PUT/api/parcel

Ez a végpont szolgál a már létrejött csomagok adatainak módosítására. De csak azok a csomagok módosíthatók, melyeknek a státusza a Foxpost rendszerében még CREATE!

Egy hívással több csomag is átadható, amennyiben egynél több elemű json kerül átadásra.

Request query

Paraméter név	Típus	Leírás
isWeb Opcionális	Boolean	Megadja, hogy a csomag megjelenjen-e a foxpost.hu oldalon, a Csomagjaim menüpontban (csak foxpost.hu regisztrált ügyfeleknek érhető el). Tesztkörnyezetben (sandbox-ban) való csomag létrehozás során a kérést isWeb = false paraméterrel kell beküldeni. Engedélyezett értékek: true, false Alapértelmezett érték: true

Request body

Paraméter név	Típus	Leírás
[] Kötelező	[UpdateParcelRequest]	Tetszőleges számú HD vagy API Request Item tömb.

Request Items

Paraméter név	Típus	Leírás
barcode Kötelező	String	Módosítás esetén a módosított csomag CLFOX kezdetű azonosítója. Alapértelmezett érték: null
cod Opcionális	Integer	Utánvét értéke. Minimális érték: 0 Maximális érték: 1000000 Alapértelmezett érték: 0
comment Opcionális	String	Csomaghoz kapcsolódó szöveges kiegészítés (pl. mit tartalmaz a csomag). Minimális hossz: 0 Maximális hossz: 50 Alapértelmezett érték: null
destination Kötelező	String	A célautomata kódja. Értéke a json fájl operator_id mezője.
label Opcionális	Boolean	Megadja, hogy a Foxpost nyomtasson-e címkét. Csak C2C típusú csomag esetén használatos, üzleti partnerek (webshop-ok) integrációja esetén nem releváns.
recipientEmail Kötelező	String	Címzett email címe, melynek formailag helyes email címnek kell lennie!
recipientName Kötelező	String	Címzett neve Minimális hossz: 1 Maximális hossz: 150
recipientPhone Kötelező	String	Címzett telefonszáma +36 formátumban. Csak magyarországi mobiltelefon-számokat fogad el a rendszer! reguláris kifejezés: ^(\+36\|36)(20\|30\|31\|70\|50\|51)\d{7}$ Kérésre, a FoxPost üzleti kapcsolattartójával való egyeztetés alapján, a telefonszám validáció kikapcsolható.
refCode Opcionális	String	Ügyfél-oldali (pl. megrendelés, számla, visszáru) azonosításhoz használható csomagazonosító szám. Értéke tetszőleges lehet, ugyanakkor javasolt egyedivé tenni. Ha kitöltésre kerül, akkor az értéke megjelenik a címkén. Minimális hossz: 0 Maximális hossz: 30
size Kötelező	String	Csomag mérete, melynek értékét kötelező megadni a csomag létrehozásakor. Azonban a rendszer ezt ekkor még nem veszi figyelembe, így az értéke létrehozáskor lehet fixen például `M`. A végleges érték a Foxpost raktári folyamatai során, automatikusan kerül meghatározásra. Lehetséges értékek: ["XS","S", "M", "L", "XL"] vagy ["1", "2", "3", "4", "5"]
uniqueBarcode Opcionális	String	Egyedi vonalkód, amely csak automatába történő szállítás esetén használható. Ebben az esetben a címkére nem a Foxpost által generált CLFOX kezdetű vonalkód lesz rányomtatva, hanem a webshop által generált vonalkód. A vonalkódnak egyedinek kell lennie, két egyforma vonalkód nem fordulhat elő a Foxpost rendszerében, ezért fontos, hogy a webshop gondoskodjon a vonalkód egyediségéről. Kérjük, hogy az átadandó kódokat ún. hibrid, legalább 4 betűt és legalább 4 számot tartalmazó azonosítók használatával tegyék egyedivé. A betűk lehetőség szerint utaljanak az adott partnerre. Például: FIRMA987654321 Amennyiben olyan vonalkód kerül átadásra, ami már létezik a rendszerben, úgy a csomag létrehozása sikertelen lesz (DUPLICATED_UNIQUE_BARCODE hibakód). Minimális hossz: 0 Maximális hossz: 20

Paraméter név	Típus	Leírás
barcode Kötelező	String	Módosítás esetén a módosított csomag CLFOX kezdetű azonosítója. Alapértelmezett érték: null
cod Opcionális	Integer	Utánvét értéke. Minimális érték: 0 Maximális érték: 1000000 Alapértelmezett érték: 0
comment Opcionális	String	Csomaghoz kapcsolódó szöveges kiegészítés (pl. mit tartalmaz a csomag). Minimális hossz: 0 Maximális hossz: 50 Alapértelmezett érték: null
deliveryNote Opcionális	String	Futárnak szóló üzenet. Minimális hossz: 0 Maximális hossz: 50 Alapértelmezett érték: null
fragile Opcionális	Boolean	Megadja, hogy a csomag törékeny árut tartalmaz-e. Engedélyezett értékek: true, false Alapértelmezett érték: true
label Opcionális	Boolean	Megadja, hogy a Foxpost nyomtasson-e címkét. Csak C2C típusú csomag esetén használatos, üzleti partnerek (webshop-ok) integrációja esetén nem releváns.
recipientAddress Kötelező	String	Címzett szállítási címének további adatai (közterület neve és jellege, házszám, emelet, ajtó stb.). Minimális hossz: 1 Maximális hossz: 150
recipientCity Kötelező	String	Címzett szállítási címe település Minimális hossz: 1 Maximális hossz: 50
recipientCountry Opcionális	String	Címzett szállítási országa
recipientEmail Kötelező	String	Címzett email címe, melynek formailag helyes email címnek kell lennie!
recipientName Kötelező	String	Címzett neve Minimális hossz: 1 Maximális hossz: 150
recipientPhone Kötelező	String	Címzett telefonszáma +36 formátumban. Csak magyarországi mobiltelefon-számokat fogad el a rendszer! reguláris kifejezés: ^(\+36\|36)(20\|30\|31\|70\|50\|51)\d{7}$ Kérésre, a FoxPost üzleti kapcsolattartójával való egyeztetés alapján, a telefonszám validáció kikapcsolható.
recipientZip Kötelező	String	Címzett szállítási címének irányítószáma Minimális hossz: 1000 Maximális hossz: 9999
refCode Opcionális	String	Ügyfél-oldali (pl. megrendelés, számla, visszáru) azonosításhoz használható csomagazonosító szám. Értéke tetszőleges lehet, ugyanakkor javasolt egyedivé tenni. Ha kitöltésre kerül, akkor az értéke megjelenik a címkén. Minimális hossz: 0 Maximális hossz: 30
size Kötelező	String	Csomag mérete, melynek értékét kötelező megadni a csomag létrehozásakor. Azonban a rendszer ezt ekkor még nem veszi figyelembe, így az értéke létrehozáskor lehet fixen például `M`. A végleges érték a Foxpost raktári folyamatai során, automatikusan kerül meghatározásra. Lehetséges értékek: ["XS","S", "M", "L", "XL"] vagy ["1", "2", "3", "4", "5"]
uniqueBarcode Opcionális	String	Egyedi vonalkód, amely csak automatába történő szállítás esetén használható. Ebben az esetben a címkére nem a Foxpost által generált CLFOX kezdetű vonalkód lesz rányomtatva, hanem a webshop által generált vonalkód. A vonalkódnak egyedinek kell lennie, két egyforma vonalkód nem fordulhat elő a Foxpost rendszerében, ezért fontos, hogy a webshop gondoskodjon a vonalkód egyediségéről. Kérjük, hogy az átadandó kódokat ún. hibrid, legalább 4 betűt és legalább 4 számot tartalmazó azonosítók használatával tegyék egyedivé. A betűk lehetőség szerint utaljanak az adott partnerre. Például: FIRMA987654321 Amennyiben olyan vonalkód kerül átadásra, ami már létezik a rendszerben, úgy a csomag létrehozása sikertelen lesz (DUPLICATED_UNIQUE_BARCODE hibakód). Minimális hossz: 0 Maximális hossz: 20

Response

Kód	Megnevezés	Leírás
200	OK	Sikeres hívás
400	Bad Request	Sikertelen hívás, hiba volt a beküldött csomagadatokban.
500	Ismeretlen hiba	Sikertelen hívás, a hiba oka ismeretlen (nem a beküldött csomagadatok voltak hibásak).

Válasz objektum

A válasz objektumban minden egyes rendeléshez visszakapjuk azokat az adatokat, amik mentésre kerültek. Ezek az adatok reprezentálják, hogy a Foxpost rendszerében mi került lementésre.

Kulcs	Szállítási típus	Leírás
recipientName	Házhozszállítás Csomagautomata	Címzett neve
recipientPhone	Házhozszállítás Csomagautomata	Címzett telefonszáma +36 formátumban
recipientEmail	Házhozszállítás Csomagautomata	Címzett email címe
size	Házhozszállítás Csomagautomata	Csomag mérete
recipientCity	Házhozszállítás	Címzett szállítási címe település Alapértelmezett: null
recipientZip	Házhozszállítás	Címzett szállítási címének irányítószáma Alapértelmezett: null
recipientAddress	Házhozszállítás	Címzett szállítási címének további adatai (közterület neve és jellege, házszám, emelet, ajtó stb.) Alapértelmezett: null
recipientCountry	Házhozszállítás	Címzett szállítási országa Minimális hossz: 0 Maximális hossz: 3
cod	Házhozszállítás Csomagautomata	Utánvét értéke Alapértelmezett: 0
deliveryNote	Házhozszállítás	Futárnak szóló üzenet Alapértelmezett: null
comment	Házhozszállítás Csomagautomata	Csomaghoz kapcsolódó szöveges kiegészítés (pl. mit tartalmaz a csomag). Alapértelmezett: null
label	Házhozszállítás	Megadja, hogy a Foxpost nyomtasson-e címkét. Alapértelmezett: null
fragile	Házhozszállítás	Megadja, hogy a csomag törékeny árut tartalmaz-e. Alapértelmezett: null
uniqueBarcode	Csomagautomata	Egyedi vonalkód Alapértelmezett: null
refCode	Házhozszállítás Csomagautomata	Ügyfél-oldali (pl. megrendelés, számla, visszáru) azonosításhoz használható csomagazonosító szám. Alapértelmezett: null
barcode	Házhozszállítás Csomagautomata	Módosítás esetén a módosított csomag CLFOX kezdetű azonosítója. Alapértelmezett: null
errors	Házhozszállítás Csomagautomata	A hibákat tartalmazó kulcs. Ha legalább egy hiba van, akkor értéke egy json, ami egyesével tartalmazza a hibákat. Minden hiba egy json objektum, két kulccsal: {field: 'mező neve', 'message': 'hiba kódja'} Alapértelmezett: null
barcodeTof	Házhozszállítás	A csomag házhozszállítását végző Express One (50139 kezdetű) csomagazonosítója. Házhozszállításos csomag esetén ez kerül a címkére, illetve ez használható a csomagnyomkövetés (tracking) lekérdezésnél is. Alapértelmezett: null
sendCode	Házhozszállítás Csomagautomata	Csomag feladási kódja, B2C (webshop) feladás esetén nem releváns.
clFoxId	Házhozszállítás Csomagautomata	A csomag CLFOX kezdetű Foxpost-os azonosítója
partnerType	Házhozszállítás Csomagautomata	A feladó típusa. Lehetséges értéke (webshop integráció esetén): "B2C"
parcelType	Csomagautomata	Csomag típusa, értéke automatikusan töltődik. Lehetséges értékei: "NORMAL" (Normál csomag) "RE" (Címzett által visszaküldött, eredetileg Foxpost által kiszállított csomag) "XRE" (Címzett által visszaküldött, eredetileg más csomagküldő által kiszállított csomag) "IRE" (Kiszállító által visszaküldött, lejárt tartási idejű, címzett által (tartási időn belül) át nem vett csomag) "C2B" (Magánszemély címzett által feladott, üzleti partnernek átadandó csomag)
sendType	Házhozszállítás Csomagautomata	Csomagküldés típusa. Lehetséges értékei: "HD", "APM", "COLLECT”
orderId	Házhozszállítás Csomagautomata	Rendelési azonosító, integrációs szempontból nem releváns.
destination	Csomagautomata	A célautomata kódja Alapértelmezett: null
validTo	Házhozszállítás Csomagautomata	Érvényességi idő
routeInfo { routeNumber countryCode labelSubType depoCode destinationApm }	Házhozszállítás Csomagautomata	A csomag futár általi betöltését/kézbesítését támogatandó, egyedi címke esetében feltüntetendő információk: járatszám, ország azonosító, címke típus (webshop esetén: B2C), depó azonosító, célautomata azonosítója.

DELETE/api/parcel/{barcode}

Ez a végpont a már létrejött csomag törlésére szolgál, de csak azt a csomagot lehet törölni, amelyik a Foxpost rendszerében még csak CREATE státusszal rendelkezik.

Törölni egyszerre csak egy csomagot lehet. A barcode helyére a csomag CLFOX id-ját kell behelyettesíteni.

Request query

Paraméter név	Típus	Leírás
isWeb Opcionális	Boolean	Megadja, hogy a csomag megjelenjen-e a foxpost.hu oldalon, a Csomagjaim menüpontban (csak foxpost.hu regisztrált ügyfeleknek érhető el). Tesztkörnyezetben (sandbox-ban) való csomag létrehozás során a kérést isWeb = false paraméterrel kell beküldeni. Engedélyezett értékek: true, false Alapértelmezett érték: true
barcode	String	Módosítás esetén a módosított csomag CLFOX kezdetű azonosítója. Alapértelmezett érték: null

Response

Kód	Megnevezés	Leírás
204	Sikeres törlés	A csomag sikeresen törlődött a Foxpost rendszeréből.

POST/api/parcel/c2b

Ez a végpont olyan csomagok létrehozására szolgál, melyek (APM-en) feladója magánszemély (C), ugyanakkor a (FoxPost számára releváns) címzettje üzleti vállalkozás (B).

Az esetleges kapcsolódás tervezéséhez kérjük vegye fel a kapcsolatot velünk, a sales@foxpost.hu email címen.

POST/api/parcel/ext

Ez a végpont olyan esetekben releváns, amikor üzleti partnerünk (jellemzően egy online piactér) olyan csomagokat hoz létre a rendszerünkben, ahol a címzett magánszemély, a küldő pedig az üzleti partnerünktől eltérő cég vagy magánszemély.

Elsősorban abban különbözik az /api/parcel végponttól, hogy a kérésben a csomag feladójának az adatait is küldeni kell.

A végponthoz való csatlakozás megtervezéséhez kérjük vegye fel a kapcsolatot Foxpost-os kapcsolattartójával!

6.2. LABELS (címkék és szállítólevelek nyomtatása)

Csomagcímkék, illetve szállítólevelek generálása az alábbi végpontok hívásával lehetséges.

POST/api/label/{pageSize}

Ez a végpont a FoxPost standard, különböző méretben kinyomtatható csomagcímkéjének pdf formátumban történő lekérésére szolgál. Címkét bármilyen státuszú csomaghoz lehet generálni. Ha a csomaghoz tartozik refCode, akkor annak értéke megjeleníthető a csomag címkéjén. Egyedi címke tervezéséhez kérjük vegye fel a kapcsolatot Foxpost-os kapcsolattartójával!

Fejlécek

A korábbi hívásokkal ellentétben itt a content-type fejlécnek nem json-t kell beállítani, hanem application/pdf-et.

                    
{
    "Accept-Encoding": "Application/pdf",
    "Content-Type": "Application/json",
    "Api-key": "...",
}

Request path

Paraméter név	Típus	Leírás
pageSize Kötelező	String	Megadja, hogy mekkora méretben adja vissza a Foxpost rendszere a pdf fájlt. A hívás egy pdf fájllal tér vissza, ami közvetlenül lementhető/kinyomtatható. Engedélyezett értékek: A5,A6,A7,_85X85
startPos Opcionális	integer	Csak `A7` méretű címkénél használható. Megadja, hogy hanyadik pozícióban kezdődjön az A4-es lapon a címkék nyomtatása. Engedélyezett értékek: 1,2,3,4,5,6,7

Request body

Paraméter név	Típus	Leírás
[] Kötelező	String	Azon csomagok egyedi azonosítói (clfoxid-jai), amikhez címke nyomtatására van szükség.

Response

Sikeres hívás esetén a válaszban egy pdf fájlt kapunk, amit lementve azonnal nyomtathatóvá válik a csomag címkéje. Az uri nem menthető le, a válasz „null” értéket ad vissza.

GET/api/label/info/{barcode}

Ez a végpont az egyedi (nem Foxpost-standard szerinti) címkézéshez szükséges adatok lekérésére szolgál. Egyedi címke tervezéséhez kérjük vegye fel a kapcsolatot Foxpost-os kapcsolattartójával!

Request body

Paraméter név	Típus	Leírás
barcode Kötelező	String	Azon csomagok egyedi azonosítói (clfoxid-jai), amikhez címke nyomtatásához adatokra van szükség.

Response

Kód	Megnevezés	Leírás
200	Sikeres művelet	A lekérdezés sikeres volt.

Válasz objektum

A válasz objektumban minden egyes rendeléshez visszakapjuk azokat az adatokat, amik mentésre kerültek. Ezek az adatok reprezentálják, hogy a Foxpost rendszerében mi került lementésre.

Kulcs	Szállítási típus	Leírás
apm	Csomagautomata	A célautomata kódja. Alapértelmezett: null
barcode	Házhozszállítás Csomagautomata	Azon csomagok egyedi azonosítói (clfoxid-jai), amikhez címke nyomtatásához adatokra van szükség.
cod	Házhozszállítás Csomagautomata	Utánvét értéke Alapértelmezett: 0
courierCode	Házhozszállítás Csomagautomata	Futár kódja
depoCode	Házhozszállítás Csomagautomata	Depó azonosító
isFragile	Házhozszállítás	Megadja, hogy a csomag törékeny árut tartalmaz-e. Alapértelmezett: false
recipientAddress	Házhozszállítás	Címzett szállítási címének további adatai (közterület neve és jellege, házszám, emelet, ajtó stb.) Alapértelmezett: null
recipientCity	Házhozszállítás	Címzett szállítási címe település Alapértelmezett: null
recipientEmail	Házhozszállítás Csomagautomata	Címzett email címe
recipientName	Házhozszállítás Csomagautomata	Címzett neve
recipientPhone	Házhozszállítás Csomagautomata	Címzett telefonszáma +36 formátumban
recipientZip	Házhozszállítás	Címzett szállítási címének irányítószáma Alapértelmezett: null
refCode	Házhozszállítás Csomagautomata	Ügyfél-oldali (pl. megrendelés, számla, visszáru) azonosításhoz használható csomagazonosító szám. Alapértelmezett: null
sendType	Házhozszállítás Csomagautomata	Csomagküldés típusa. Lehetséges értékei: "HD", "APM", "COLLECT”
senderAddress	Házhozszállítás Csomagautomata	Feladó szállítási címének további adatai (közterület neve és jellege, házszám, emelet, ajtó stb.) Alapértelmezett:null
senderCity	Házhozszállítás Csomagautomata	Feladó szállítási címe település Alapértelmezett:null
senderName	Házhozszállítás Csomagautomata	Feladó neve
senderZip	Házhozszállítás Csomagautomata	Feladó szállítási címének irányítószáma Alapértelmezett:null

POST/api/label/deliveryNote

Ez a végpont a FoxPost standard, a begyűjtős típusú (collect-es) üzleti partnerek által használt, kinyomtatható szállítólevél pdf formátumban történő lekérésére szolgál. Szállítólevelet bármilyen státuszú csomaghoz lehet generálni.

Fejlécek

A korábbi hívásokkal ellentétben itt a content-type fejlécnek nem json-t kell beállítani, hanem application/pdf-et.

                    
{
    "Accept-Encoding": "Application/pdf",
    "Content-Type": "Application/json",
    "Api-key": "...",
}

Request body

Paraméter név	Típus	Leírás
clFoxCodes Kötelező	String[]	Azon csomagok egyedi azonosítói (clfoxid-jai), amikhez szállítólevél nyomtatására van szükség.
sender Kötelező	String	Feladó – szállítólevélen szerepeltetendő – neve. A szállítólevelek feldolgozása érdekében javasolt a regisztrált cégnév megadása.

Response

Sikeres hívás esetén a válaszban egy pdf fájlt kapunk, amit lementve azonnal nyomtathatóvá válik a szállítólevél.

6.3. TRACKS (csomagkövetési információk)

FoxWeb API-n keresztül az alábbi végpontokon kérdezhetők le a csomagok aktuális státuszára (lásd 5. pont) vonatkozó (csomag-nyomonkövetési) információk. A FoxPost már rendelkezik ún. tracking callback megoldással is, igény esetén, ennek tervezéséhez kérjük vegye fel a kapcsolatot Foxpost-os kapcsolattartójával!

GET/api/tracking/{barcode}

A végpont adott csomag státuszainak lekérdezésére szolgál.

Request path

Paraméter név	Típus	Leírás
barcode Kötelező	String	A lekérdezni kívánt csomag clFox id-ja, vagy egyedi vonalkód esetén a uniqueBarcode.

Response

Sikeres hívás esetén az API válaszban visszaküldi a tracking információkat.

Kulcs	Típus	Leírás
clFox	String	A lekérdezett csomag CLFOXID-ja
estimatedDelivery	String	A csomag várható kézbesítési dátuma (éééé-hh-nn)
parcelType	String	Csomag típusa, értéke automatikusan töltődik. Lehetséges értékei: "NORMAL" (Normál csomag) "RE" (Címzett által visszaküldött, eredetileg Foxpost által kiszállított csomag) "XRE" (Címzett által visszaküldött, eredetileg más csomagküldő által kiszállított csomag) "IRE" (Kiszállító által visszaküldött, lejárt tartási idejű, címzett által (tartási időn belül) át nem vett csomag) "C2B" (Magánszemély címzett által feladott, üzleti partnernek átadandó csomag)
relatedParcel	String	A kapcsolódó (előzmény) csomag clFox-ja. Csak visszárunál (RE, XRE, IRE) típusú csomagoknál releváns. A kapcsolódó csomagszámot mutatja.
sendType	String	Csomagküldés típusa. Lehetséges értékek: ["APM", "HD", "COLLECT”]
traces	[]	Minden olyan csomag-nyomonkövetési státusz, melyet a csomag az addigi (a lekérdezés időpontjáig tartó életútja során) felvett, időben visszafelé sorrendben. Az első elem (0. kulcs) az aktuális státusz. Egy elem (tömb) tartalma: longName: státusz hosszú elnevezése shortName: státusz rövid elnevezése status: státusz kódja statusDate: státusz bekövetkezésének időpontja statusStatidionId: státuszhoz tartozó sorrend azonosító a foxpost.hu-n

GET/api/tracking/tracks/{barcode}

A végpont visszaadja az összes olyan FoxPost státuszt, amit adott csomag megkapott a lekérdezés időpontjáig. Igény esetén, ennek tervezéséhez kérjük vegye fel a kapcsolatot velünk a b2chelpdesk@foxpost.hu email címen.

POST/api/tracking/tracks

A végpont több csomagra adja vissza a FoxPost státuszokat. Igény esetén, ennek tervezéséhez kérjük vegye fel a kapcsolatot velünk a b2chelpdesk@foxpost.hu email címen.

6.4. RETURNS (RE csomagok létrehozása)

A RE típusú, azaz eredetileg a Foxpost által kiszállított, de a címzett által visszaküldött csomagok Foxpost rendszerében történő létrehozását az alábbi végpontok támogatják.

Az esetleges kapcsolódás tervezéséhez kérjük vegye fel a kapcsolatot velünk, a sales@foxpost.hu email címen.

POST/api/re/ext

Hívásával egy RE csomag hozható létre.
Igény esetén írjon a sales@foxpost.hu email címre.

POST/api/re/exts

Hívásával egyszerre több RE csomag hozható létre.
Igény esetén írjon a sales@foxpost.hu email címre.

6.5. EXTERNAL RETURNS (XRE csomagok létrehozása)

Az XRE típusú, azaz eredetileg nem a Foxpost által kiszállított, de a címzett által Foxpost-tal visszaküldött csomagok Foxpost rendszerében történő létrehozását az alábbi végpontok támogatják. Igény esetén, ennek tervezéséhez kérjük vegye fel a kapcsolatot velünk, a sales@foxpost.hu email címen. Ha a címzett az XRE típusú visszaküldést a https://foxpost.hu/egyeb-csomag-visszakuldes kezdeményezi, és megadja az eredeti csomag referenciakódját / csomagazonosítóját, akkor ez a refCode érték jelenik meg a Foxpost raktárában kinyomtatott visszáru-címkén.

Az esetleges kapcsolódás tervezéséhez kérjük vegye fel a kapcsolatot velünk, a sales@foxpost.hu email címen.

POST/api/xre/unique

Hívásával egy XRE típusú csomag hozható létre. A válasz visszaadja a csomag APM-en történő feladásához szükséges kódot.

POST/api/re/exts

Hívásával egyszerre több RE csomag hozható létre.
Igény esetén írjon a sales@foxpost.hu email címre.

6.6. ADDRESSES (visszaküldési címek kezelése)

Az XRE típusú csomagok esetében lehetőség van az üzleti partner regisztrált (székhely-) címétől eltérő visszaküldési (telephely/raktár) cím megadására. Ezeknek a címeknek a létrehozására, lekérdezésére, törlésére szolgálnak az alábbi végpontok. Az esetleges kapcsolódás tervezéséhez kérjük vegye fel a kapcsolatot velünk, a sales@foxpost.hu email címen.

Az esetleges kapcsolódás tervezéséhez kérjük vegye fel a kapcsolatot velünk, a sales@foxpost.hu email címen.

POST/api/address

Új visszaküldési cím létrehozására szolgáló végpont.
Igény esetén írjon a sales@foxpost.hu email címre.

DELETE/api/address/{name}

Meglévő visszaküldési cím törlésére szolgáló végpont.
Igény esetén írjon a sales@foxpost.hu email címre.

GET/api/address

A végpont hívásával lekérdezhető az adott üzleti partnerhez tartozó összes visszaküldési cím.
Igény esetén írjon a sales@foxpost.hu email címre.

6.7. FILES (csomagok létrehozása tömeges feltöltéssel)

Normál csomagokat nem csak egyesével, az /api/parcel végpont hívásával, hanem xlsx vagy csv fájl feltöltésével is létre lehet hozni a Foxpost rendszerében. Egyszerre legfeljebb 1000 db csomag hozható létre ilyen módon. A feltölthető fájlra vonatkozó követelmények itt érhetők el: https://foxpost.hu/uzleti-partnereknek/integracios-segedlet/tomeges-csomagfeltoltes. Igény esetén, ennek tervezéséhez kérjük vegye fel a kapcsolatot Foxpost-os kapcsolattartójával!

POST/api/file

Új normál csomagok tömeges, xlsx vagy csv fájl feltöltésével történő létrehozására szolgáló végpont.

Az esetleges kapcsolódás tervezéséhez kérjük vegye fel a kapcsolatot velünk, a sales@foxpost.hu email címen.

7. HIBAKEZELÉS

Minden csomag visszakapott adatai között található egy errors kulcs. Amennyiben egy beküldés hibára fut, abban az esetben ez az errors kulcs fogja tartalmazni azokat a hibákat, amiket javítani kell a sikeres beküldéshez.

A hibakódok leírását az alábbi táblázat tartalmazza.

Hibakód	Leírás
MIN_VALUE	A kapott érték kisebb, mint a minimálisan elfogadott.
MAX_VALUE	A kapott érték nagyobb, mint a maximálisan elfogadott.
MAX_LENGTH	A kapott érték hossza nagyobb, mint a maximálisan elfogadott.
INVALID_COD	Érvénytelen utánvét érték.
INVALID_ZIP	Érvénytelen irányítószám. A megfelelő érték 1000 és 9999 közötti egész szám.
INVALID_SIZE	A kapott csomagméret nem megfelelő. A lehetséges értékek: "XS", "S", "M", "L", "XL"
INVALID_NAME	Érvénytelen név
CANT_BE_NULL	A mező értéke nem lehet null (üres).
INVALID_EMAIL	Érvénytelen email cím (formailag hibás)
CANT_BE_EMPTY	Mező értéke nem lehet üres
INVALID_PHONE	Telefonszám formátuma érvénytelen. reguláris kifejezés: ^(\+36\|36)(20\|30\|31\|70\|50\|51)\d{7}$
INVALID_APM_ID	A megadott automata id-ja érvénytelen. Az aktuális (óránként frissülő) automata lista innen elérhető: https://cdn.foxpost.hu/apms.json
INVALID_FORMAT	A kapott formátum érvénytelen
ADDRESS_NOT_SET	Nincs beállítva cím
INVALID_PARCEL_ID	Érvénytelen csomagazonosító.
DUPLICATED_UNIQUE_BARCODE	Az egyedi vonalkódként beküldött adat már létezik a rendszerben.