Všechny sbírky
Dokumentace REST API
Pokročilé příkazy
Aktualizace požadavků na výdej - REST API
Aktualizace požadavků na výdej - REST API

Jak spustit přes REST API aktualizaci požadavků na výdej?

Petr Pech avatar
Autor: Petr Pech
Aktualizováno před více než týdnem

V případě, že je v nastavení firmy povolené generování požadavků na výdej, tak lze pomocí REST API volat službu Aktualizace skladových požadavků na výdej.

Nevíte, co je požadavek na výdej? Nahlédněte do naší dokumentace.

Způsob volání

Lze využít HTTP metodu:

PUT nebo POST

Služba je dostupná na adrese:

/c/{firma}/sklad/aktualizace-pozadavku

Jsou podporovány výstupní formáty:

XML nebo JSON

Parametry

Služba umožňuje použít parametr dry-run. Pomocí tohoto parametru lze zjistit, zda byl přepočet dokončen. Pokud ano, vrátí HTTP status 200. Pokud ne, vrátí HTTP status 409 s informací o tom, kdy a kým byl přepočet spuštěn.

Výsledek

Pro rozpoznání, zda byla služba vykonána úspěšně, lze kontrolovat HTTP status odpovědi nebo vlastnost success v získaném dokumentu.

Úspěšné volání

V případě úspěšného vykonání služby je vracen HTTP status 200 a dokument odpovídající požadovanému formátu:

XML

<?xml version="1.0"?>
<winstrom version="1.0">
  <success>true</success>
</winstrom>

JSON

{
    "winstrom": {
        "@version": "1.0",
        "success": "true"
    }
}

Neúspěšné volání

HTTP status odpovědi je 4xx nebo 5xx. A například v případě, že firma nemá povolené generování požadavků na výdej, získáme výsledný dokument:

XML

<?xml version="1.0"?>
<winstrom version="1.0">
  <success>false</success>
  <message>Nen&#xED; povoleno generov&#xE1;n&#xED; po&#x17E;adavk&#x16F; na v&#xFD;dej.</message>
</winstrom>

JSON

{
    "winstrom": {
        "@version": "1.0",
        "success": "false",
        "message": "Nen\u00ed povoleno generov\u00e1n\u00ed po\u017eadavk\u016f na v\u00fddej."
    }
}

Ukázky volání

  • PUT /c/demo/sklad/aktualizace-pozadavku.xml

  • PUT /c/demo/sklad/aktualizace-pozadavku.json

  • PUT /c/demo/sklad/aktualizace-pozadavku (s hlavičkou Accept: application/xml nebo Accept: application/json)

  • POST /c/demo/sklad/aktualizace-pozadavku.xml

  • POST /c/demo/sklad/aktualizace-pozadavku.json

  • POST /c/demo/sklad/aktualizace-pozadavku (s hlavičkou Accept: application/xml nebo Accept: application/json)

Dostali jste odpověď na svou otázku?