Registrácia Prihlásenie

API adries partnera

Správa doručovacích a fakturačných adries partnera — získavanie, vytváranie, úprava a odstraňovanie

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

https://{tenant}.logzi.com/api/partner_address/

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Adresa partnera je doručovacie alebo fakturačné miesto priradené k partnerovi — partner môže mať viacero adries.

GET /api/partner_address/get

Získanie jednej adresy partnera podľa identifikátora, identifikátora partnera alebo kontrolného súčtu (checksum).

Query parametre

ParameterTypPovinnéPopis
idintJedinečný identifikátor adresy
partner_idintIdentifikátor partnera — vráti sa prvá adresa
checksumstringKontrolný súčet (checksum) adresy
language_idintIdentifikátor jazyka pre preklad

Príklad požiadavky

GET /api/partner_address/get?id=15
X-API-KEY: {vas_api_kluc}
GET /api/partner_address/list

Stránkovaný zoznam adries partnerov s možnosťami filtrovania.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
partner_idintFilter podľa identifikátora partnera
list_condition[partner_id]intFilter podľa identifikátora partnera (v objekte podmienok)
list_condition[partner_address_status_id]intFilter podľa stavu adresy
language_idintIdentifikátor jazyka

Príklad požiadavky

GET /api/partner_address/list?partner_id=42&list_offset=0
X-API-KEY: {vas_api_kluc}
POST /api/partner_address/save

Vytvorenie alebo úprava adresy partnera. Pre novú adresu data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nová adresa, >0 = úprava
partner_idintIdentifikátor partnera (povinné pri novej adrese)
country_idintIdentifikátor krajiny
zipstringPSČ
citystringMesto
addressstringUlica, číslo domu
partner_address_type_idintTyp adresy (fakturačná, doručovacia atď.)
address_user_namestringMeno kontaktnej osoby na adrese
address_commentstringPoznámka k adrese
address_buildingstringOznačenie budovy
address_doorstringDvere
address_floorstringPoschodie
address_numberstringČíslo dverí / bytu
address_stairwellstringSchodisko
districtstringMestská časť (bez bodky, napr. „XIV“)
partner_address_status_idintIdentifikátor stavu adresy
outer_resource_idstringIdentifikátor v externom systéme

Príklad požiadavky

POST /api/partner_address/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "partner_id": 42,
    "country_id": 1,
    "zip": "1051",
    "city": "Budapest",
    "address": "Nádor utca 10.",
    "partner_address_type_id": 1,
    "address_user_name": "Raktáros",
    "district": "V"
  }
}
POST /api/partner_address/delete

Odstránenie adresy partnera podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor adresy, ktorá sa má odstrániť

Príklad požiadavky

POST /api/partner_address/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 15 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia