Inhalt der Dokumentation

Marktplätze

Import, Journal, Fristen, Auszahlungsabgleich, Vorschau und Kanalbilanz.

16 Funktionen. Aufruf unter /api/method/<Pfad>, Anmeldung und Fehlerformat stehen unter Authentifizierung und Fehlermodell.

confirm_import
deadline_card
import_settlement
journal_entries
journal_retry
preview_import
get_kanalbilanz
auszahlungen
differenz_ursachen
fehlergruppen
journal_suchen
mapping_vorschlag
probelauf
wiederholen
woche
zuordnen_liste

`vm_erp.vm_erp.marktplatz.api.confirm_import`

POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Writes draft Sales Orders for ready, new orders. Only after the user confirmed the preview.

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter). Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Parameter	Typ	Pflicht	Beschreibung
`channel`	string	ja
`payload`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"channel": "<CHANNEL>", "payload": "<PAYLOAD>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.api.confirm_import"

{"message": ...}

`vm_erp.vm_erp.marktplatz.api.deadline_card`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.api.deadline_card"

{"message": ...}

`vm_erp.vm_erp.marktplatz.api.import_settlement`

POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Stores the payout with differences and booking SUGGESTIONS. Books nothing.

Parameter	Typ	Pflicht	Beschreibung
`channel`	string	ja
`text`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"channel": "<CHANNEL>", "text": "<TEXT>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.api.import_settlement"

{"message": ...}

`vm_erp.vm_erp.marktplatz.api.journal_entries`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht
`channel`	string	nein
`status`	string	nein
`limit`	integer	nein, Standard `200`

Felder der Antwort (message): rows, summary

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.api.journal_entries"

{"message": ...}

`vm_erp.vm_erp.marktplatz.api.journal_retry`

POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Manual retry of one entry. Idempotent: an already delivered key is never sent again.

Parameter	Typ	Pflicht	Beschreibung
`name`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"name": "<NAME>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.api.journal_retry"

{"message": ...}

`vm_erp.vm_erp.marktplatz.api.preview_import`

POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Dry run: new, skipped and unmatched lines. Writes nothing.

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht	Beschreibung
`channel`	string	ja
`payload`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"channel": "<CHANNEL>", "payload": "<PAYLOAD>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.api.preview_import"

{"message": ...}

`vm_erp.vm_erp.marktplatz.kanalbilanz_api.get_kanalbilanz`

GET
POST
Lesend

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter: keine.

Felder der Antwort (message): beispiel, bilanzen, kanaele, preisradar, rechnungen, versand

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.kanalbilanz_api.get_kanalbilanz"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.auszahlungen`

GET
POST
Lesend

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht	Beschreibung
`kanal`	string	nein

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.auszahlungen"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.differenz_ursachen`

GET
POST
Lesend

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht	Beschreibung
`payout_id`	string	ja

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "payout_id=<PAYOUT_ID>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.differenz_ursachen"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.fehlergruppen`

GET
POST
Lesend

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht	Beschreibung
`ursache`	string	nein

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.fehlergruppen"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.journal_suchen`

GET
POST
Lesend

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht	Beschreibung
`abfrage`	string	ja
`kanal`	string	nein

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "abfrage=<ABFRAGE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.journal_suchen"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.mapping_vorschlag`

POST
Lesend

Nur ein Datensatz-Vorschlag. Gespeichert wird erst im Formular, nach Bestätigung.

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht
`kanal`	string	ja
`channel_sku`	string	ja
`item_code`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"kanal": "<KANAL>", "channel_sku": "<CHANNEL_SKU>", "item_code": "<ITEM_CODE>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.mapping_vorschlag"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.probelauf`

POST
Lesend

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht	Beschreibung
`kanal`	string	ja
`rohdaten`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"kanal": "<KANAL>", "rohdaten": "<ROHDATEN>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.probelauf"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.wiederholen`

POST
Schreibend, rollengeschützt

Parameter	Typ	Pflicht	Beschreibung
`ursache`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"ursache": "<URSACHE>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.wiederholen"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.woche`

GET
POST
Lesend

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.woche"

{"message": ...}

`vm_erp.vm_erp.marktplatz.vorschau_api.zuordnen_liste`

POST
Lesend

Rollen: (Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Buchhaltung (Leitung), Systemverwalter) oder (Vertrieb (Leitung), Buchhaltung (Leitung), Systemverwalter).

Parameter	Typ	Pflicht	Beschreibung
`kanal`	string	ja
`rohdaten`	string	ja

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"kanal": "<KANAL>", "rohdaten": "<ROHDATEN>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.zuordnen_liste"

{"message": ...}