Montage API

Verwaltung von Montagebelegen — Abrufen, Erstellen, Bearbeiten, Abschließen und positionsweise Erfassung der verwendeten Bauteile

Basis-URL

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

Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0.

GET /api/assembly/get

Abruf eines einzelnen Montagebelegs anhand der ID, einschließlich der zugehörigen verwendeten Bauteile.

Query-Parameter

Parameter Typ Pflichtfeld Beschreibung
id int Eindeutige Kennung des Montagebelegs

Beispielanfrage

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

Beispielantwort

{
  "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

Paginierter Abruf der Liste der Montagebelege mit Filtermöglichkeiten.

Query-Parameter

Parameter Typ Pflichtfeld Beschreibung
list_offset int Paginierungs-Offset (Standard: 0)
list_condition[identify] string Filter nach Belegkennung (LIKE)
list_condition[status_id] int Filter nach Status (1 = offen, 2 = abgeschlossen)
list_condition[date_create_from] date Erstellungsdatum — von (YYYY-MM-DD)
list_condition[date_create_to] date Erstellungsdatum — bis (YYYY-MM-DD)

Beispielanfrage

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

Beispielantwort

{
  "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

Erstellen oder Bearbeiten eines Montagebelegs. Anzugeben sind das Ziellager, das zusammengebaute Produkt, die produzierte Menge und das Array der verwendeten Bauteile. Für einen neuen Beleg data[id] = 0.

POST-Felder — data-Objekt

Feld Typ Pflichtfeld Beschreibung
id int 0 = neuer Beleg, >0 = Bearbeitung
company_id int Firmen-ID
company_user_id int ID des zuständigen Mitarbeiters
company_address_id int Standort-ID
store_id int ID des Ziellagers (hier wird das zusammengebaute Produkt eingelagert)
product_id int ID des zusammengebauten (fertigen) Produkts
quantity decimal Produzierte (hergestellte) Menge
comment_bottom string Interner Kommentar
item array Array der verwendeten Bauteile — mindestens eine Position ist erforderlich (siehe unten)

Positionsfelder — data[item][] (verwendete Bauteile)

Feld Typ Pflichtfeld Beschreibung
product_id int ID des verwendeten Bauteils (Produkts)
quantity decimal Verwendete Menge
store_id int ID des Quelllagers (aus dem das Bauteil entnommen wird)
store_locality_id int Lagerplatz-ID
remove int 1 = Position beim Bearbeiten löschen

POST-Felder — params-Objekt (optional)

Feld Typ Pflichtfeld Beschreibung
close int 1 = automatischer Abschluss nach dem Speichern

Beispielanfrage

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

Beispielantwort

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

Löschen eines Montagebelegs. Es kann nur ein offener Beleg (status_id = 1) gelöscht werden.

POST-Felder — data-Objekt

Feld Typ Pflichtfeld Beschreibung
receipt_id int ID des zu löschenden Belegs

Beispielanfrage

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

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

Beispielantwort

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

Abschließen eines offenen Montagebelegs. Beim Abschluss wird die Bestandsbewegung durchgeführt: Die verwendeten Bauteile werden abgebucht und das zusammengebaute Produkt wird dem Ziellager gutgeschrieben. Es kann nur ein Beleg mit status_id = 1 (offen) abgeschlossen werden.

POST-Felder — data-Objekt

Feld Typ Pflichtfeld Beschreibung
receipt_id int ID des abzuschließenden Belegs

Beispielanfrage

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

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

Beispielantwort

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

Nimm Kontakt mit uns auf

Interessierst du dich für unsere Software? Schreib uns einfach!

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!