Összeszerelés API

Összeszerelési bizonylatok kezelése — lekérés, létrehozás, módosítás, lezárás és tételszintű felhasznált alkatrész rögzítés

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/assembly/get

Egyetlen összeszerelési bizonylat lekérése azonosító alapján, a hozzá tartozó felhasznált alkatrészekkel együtt.

Query paraméterek

Paraméter Típus Kötelező Leírás
id int Az összeszerelési bizonylat egyedi azonosítója

Példa kérés

GET /api/assembly/get?id=5
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 5,
    "identify": "ASM-2024-0005",
    "date_create": "2024-05-08 09:00:00",
    "status_id": 1,
    "store_id": 1,
    "product_id": 42,
    "quantity": 10,
    "company_user_name": "Kovács Péter",
    "item": [
      {
        "product_id": 12,
        "quantity": 20,
        "store_id": 1,
        "store_locality_id": null
      }
    ]
  }
}
GET /api/assembly/list

Összeszerelési bizonylatok listájának lapozható lekérése szűrési lehetőségekkel.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_offset int Lapozás eltolása (alapértelmezett: 0)
list_condition[identify] string Szűrés bizonylatazonosítóra (LIKE)
list_condition[status_id] int Szűrés státuszra (1=nyitott, 2=lezárt)
list_condition[date_create_from] date Létrehozás dátuma — tól (YYYY-MM-DD)
list_condition[date_create_to] date Létrehozás dátuma — ig (YYYY-MM-DD)

Példa kérés

GET /api/assembly/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 5,
      "identify": "ASM-2024-0005",
      "date_create": "2024-05-08",
      "status_name": "Nyitott",
      "product_id": 42,
      "quantity": 10,
      "company_user_name": "Kovács Péter"
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 3
  }
}
POST /api/assembly/save

Összeszerelési bizonylat létrehozása vagy módosítása. Meg kell adni a célraktárat, az összerakott terméket, a gyártott mennyiséget és a felhasznált alkatrészek tömbjét. Új bizonylathoz data[id] = 0.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új bizonylat, >0 = módosítás
company_id int Cég azonosítója
company_user_id int Felelős munkatárs azonosítója
company_address_id int Telephely azonosítója
store_id int Célraktár azonosítója (ide kerül az összerakott termék)
product_id int Az összerakott (kész) termék azonosítója
quantity decimal Gyártott (előállított) mennyiség
comment_bottom string Belső megjegyzés
item array Felhasznált alkatrészek tömbje — legalább egy tétel kötelező (ld. alább)

Tétel mezők — data[item][] (felhasznált alkatrészek)

Mező Típus Kötelező Leírás
product_id int Felhasznált alkatrész (termék) azonosítója
quantity decimal Felhasznált mennyiség
store_id int Forrásraktár azonosítója (ahonnan az alkatrész kivételre kerül)
store_locality_id int Tárolóhely azonosítója
remove int 1 = tétel törlése módosításkor

POST mezők — params objektum (opcionális)

Mező Típus Kötelező Leírás
close int 1 = mentés után automatikus lezárás

Példa kérés

POST /api/assembly/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "store_id": 1,
    "product_id": 42,
    "quantity": 10,
    "item": [
      {
        "product_id": 12,
        "quantity": 20,
        "store_id": 1
      },
      {
        "product_id": 15,
        "quantity": 10,
        "store_id": 1,
        "store_locality_id": 3
      }
    ]
  },
  "params": {
    "close": 0
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 6,
    "identify": "ASM-2024-0006"
  }
}
POST /api/assembly/delete

Összeszerelési bizonylat törlése. Csak nyitott (status_id = 1) bizonylat törölhető.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A törlendő bizonylat azonosítója

Példa kérés

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

{
  "data": {
    "receipt_id": 5
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/assembly/close

Nyitott összeszerelési bizonylat lezárása. A lezárás elvégzi a készletmozgást: levonja a felhasznált alkatrészeket és jóváírja az összerakott terméket a célraktárban. Csak status_id = 1 (nyitott) bizonylat zárható le.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A lezárandó bizonylat azonosítója

Példa kérés

POST /api/assembly/close
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "receipt_id": 5
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}

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!