Partner cím API

Partner szállítási és számlázási címek kezelése — lekérés, létrehozás, módosítás és törlés

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A partner cím a partnerhez rendelt szállítási vagy számlázási helyszín — egy partnernek több címe is lehet.

GET /api/partner_address/get

Egyetlen partner cím lekérése azonosító, partner azonosító vagy checksum alapján.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintCím egyedi azonosítója
partner_idintPartner azonosítója — az első cím kerül visszaadásra
checksumstringCím checksum azonosítója
language_idintNyelv azonosítója a fordításhoz

Példa kérés

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

Partner címek lapozható listájának lekérése szűrési lehetőségekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
partner_idintSzűrés partner azonosítóra
list_condition[partner_id]intSzűrés partner azonosítóra (feltétel objektumban)
list_condition[partner_address_status_id]intSzűrés cím státuszra
language_idintNyelv azonosítója

Példa kérés

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

Partner cím létrehozása vagy módosítása. Új címhez data[id] = 0.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új cím, >0 = módosítás
partner_idintA partner azonosítója (új cím esetén kötelező)
country_idintOrszág azonosítója
zipstringIrányítószám
citystringVáros
addressstringUtca, házszám
partner_address_type_idintCím típusa (számlázási, szállítási stb.)
address_user_namestringKapcsolattartó neve a cimnél
address_commentstringMegjegyzés a címhez
address_buildingstringÉpület megjelölés
address_doorstringAjtó
address_floorstringEmelet
address_numberstringAjtó / lakásszám
address_stairwellstringLépcsőház
districtstringKerület (pont nélkül, pl. "XIV")
partner_address_status_idintCím státusz azonosítója
outer_resource_idstringKülső rendszer azonosítója

Példa kérés

POST /api/partner_address/save
X-API-KEY: {az_api_kulcsod}
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

Partner cím törlése azonosító alapján.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA törlendő cím azonosítója

Példa kérés

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

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

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!