Versand

vm_erp.vm_erp.shipping.api.create_shipment

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

Create the Delivery Note (submitted) for the confirmed quantities and the Sendung record.

One request = one transaction: if any step fails nothing is kept.

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

Felder der Antwort (message): delivery_note, label_file, partial, sendung, tracking_url

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"order": "<ORDER>", "packed": "<PACKED>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.shipping.api.create_shipment"

{"message": ...}

vm_erp.vm_erp.shipping.api.find_order

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Resolve a scan (order name, or a Delivery Note's order reference) to a Sales Order name.

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

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

{"message": ...}

vm_erp.vm_erp.shipping.api.get_pack_data

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Header and packable lines of one order. Refuses orders that are not shippable.

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

Felder der Antwort (message): address, company, customer_name, lines, order, shipping

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "order=<ORDER>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.shipping.api.get_pack_data"

{"message": ...}

vm_erp.vm_erp.shipping.api.get_ready_orders

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Orders that may ship now (Versand light green; yellow too with include_partial).

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

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

{"message": ...}

vm_erp.vm_erp.shipping.api.get_shipping_methods

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

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

Parameter: keine.

Felder der Antwort (message): carriers, methods

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

{"message": ...}

vm_erp.vm_erp.shipping.api.kosten_ausnahme

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

Versandkosten-Ausnahme am Auftrag protokollieren (Kommentar). Nur mit Grund (mindestens 10 Zeichen), nur Sales Manager oder hoeher.

Die Funktion aendert keine Preise im Auftrag; sie haelt fest, wer welchen Betrag aus welchem Grund freigegeben hat.

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

Felder der Antwort (message): auftrag, betrag, protokolliert

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"auftrag": "<AUFTRAG>", "betrag": "<BETRAG>", "grund": "<GRUND>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.shipping.api.kosten_ausnahme"

{"message": ...}

vm_erp.vm_erp.shipping.api.kosten_vorschau

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Vorschau der Versandkosten (netto) am Auftrag. Schreibt nichts. Gewicht aus den Artikeln, Zone aus der Lieferadresse.

Ohne Gewicht oder ohne passende Regel kommt ein klarer Hinweis statt einer geratenen Zahl.

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

Felder der Antwort (message): auftrag, erklaerung, frachtfrei, gewicht_kg, hinweise, preis, regel, status, ueberlappungen, waehrung, warenwert_netto, zone

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "auftrag=<AUFTRAG>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.shipping.api.kosten_vorschau"

{"message": ...}

vm_erp.vm_erp.shipping.api.tracking_aktualisieren

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

Fragt den Status der genannten Sendungen ab und schreibt Status und Pruefzeit in VM Sendung (höchstens 200 je Aufruf).

Ein 404 beim Dienstleister heisst "unbekannt", ein Netzfehler "fehler"; beides aendert einen bekannten Status nicht.

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

Felder der Antwort (message): ergebnisse, geprueft

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

{"message": ...}

vm_erp.vm_erp.shipping.api.zustellausnahmen

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Liste der Zustellausnahmen mit Zaehlung je Grund und Textentwurf je Zeile (wird nirgends gesendet).

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

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

{"message": ...}