Retouren

vm_erp.vm_erp.retouren.api.book_receipt

• POST
• Schreibend, rollengeschützt
• Fehlernummer bei unerwarteten Fehlern

Book the goods receipt: received_qty and condition per line, status Eingegangen.

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

Felder der Antwort (message): retoure, status

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"retoure": "<RETOURE>", "received": "<RECEIVED>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.api.book_receipt"

{"message": ...}

vm_erp.vm_erp.retouren.api.close_retoure

• GET
• POST
• Schreibend, rollengeschützt
• Fehlernummer bei unerwarteten Fehlern

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

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "retoure=<RETOURE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.api.close_retoure"

{"message": ...}

vm_erp.vm_erp.retouren.api.find_retoure

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Resolve a scanned reference (RET-00001) to an open Retoure.

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

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "scan=<SCAN>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.api.find_retoure"

{"message": ...}

vm_erp.vm_erp.retouren.api.get_receipt_data

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Header and lines for the Wareneingang. Only a draft in status Angemeldet or Eingegangen.

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

Felder der Antwort (message): conditions, customer_name, lines, retoure, sales_order

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "retoure=<RETOURE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.api.get_receipt_data"

{"message": ...}

vm_erp.vm_erp.retouren.api.make_credit_note

• GET
• POST
• Schreibend, rollengeschützt
• Fehlernummer bei unerwarteten Fehlern

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

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "retoure=<RETOURE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.api.make_credit_note"

{"message": ...}

vm_erp.vm_erp.retouren.api.make_return_delivery_note

• GET
• POST
• Schreibend, rollengeschützt
• Fehlernummer bei unerwarteten Fehlern

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

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "retoure=<RETOURE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.api.make_return_delivery_note"

{"message": ...}

vm_erp.vm_erp.retouren.api.mark_checked

• POST
• Schreibend, rollengeschützt
• Fehlernummer bei unerwarteten Fehlern

Eingegangen -> Geprüft once every line has condition and decision.

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

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

{"message": ...}

vm_erp.vm_erp.retouren.portal.lookup

• POST
• Öffentlich (ohne Anmeldung)

Verify the caller and list what may be returned (item, name, quantity). Nothing else.

Rollen: Keine Anmeldung nötig. Je Absenderadresse sind 20 Aufrufe in 600 Sekunden möglich.

Felder der Antwort (message): lines, ok, reasons

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"order_no": "<ORDER_NO>", "email": "<EMAIL>", "postcode": "<POSTCODE>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.portal.lookup"

{"message": ...}

vm_erp.vm_erp.retouren.portal.submit

• POST
• Öffentlich (ohne Anmeldung)

Create the Retoure (draft, status Angemeldet) and return its reference number.

Rollen: Keine Anmeldung nötig. Je Absenderadresse sind 10 Aufrufe in 600 Sekunden möglich.

Felder der Antwort (message): message, ok, reference

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"order_no": "<ORDER_NO>", "email": "<EMAIL>", "postcode": "<POSTCODE>", "lines": "<LINES>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.retouren.portal.submit"

{"message": ...}