Tento zdroj slouží k importu vlastností objednávek do Quantu především ke změně stavů objednávky. Vstupním i výstupním formátem je JSON.

Pro vytvoření a nastavení importu použijte dialog Automatické úlohy. Po vytvoření bude v seznamu úloh ID, které předáte v URL požadavku.

Automatická úloha

ID úlohy

• Nastavení

Před použitím API je nutno upravit tyto atributy v záložce Nastavení:

• Zaškrtněte atribut Zapnuto pro povolení úlohy.
• V atributu Uživatelé s povoleným přístupem pro API zvolte jednoho nebo více uživatelů s rolí Robot, kteří budou mít oprávnění úlohu spouštět.
• V atributu Mapování atributů vlastností objednávek zvolte atributy pro import a volitelně upravte jejich JSON klíče.
• Dále doporučujeme vyplnit Emaily k notifikacím, kde zadáte jednu či více e-mailových adres, na které budou zasílány e-maily s chybovými stavy.

• Atributy 

Nastavení

• Požadavek

/v1/import/order-properties/{id_ulohy}

Parametr	Hodnota
URL	?debug přidaný do URL zobrazí v odpovědi i varování. Bez toho se vypisují pouze chyby.
Hlavička	Accept: application/json
Hlavička	Content-type: application/json
Hlavička	Authorization: Bearer  <TOKEN> TOKEN se získává pomocí /authenticate (viz. Přihlášení).
Metoda	POST

Obsahem požadavku je pole JSON objektů obsahující klíče definované v nastavení Mapování atributů vlastností objednávek, konkrétně QID objednávky a její stav. Názvy stavů musí být následující "Delivered", "Ordered", "Canceled", "Open". Pokud požadujete zasílat názvy stavů v jiném formátu, je potřeba tuto skutečnost nastavit v mapování atributů v řádku Text náhrady.

Je důležité, aby požadavek odpovídal standardům pro JSON formát. Kompletní definici těchto standardů najdete zde. Hodnoty číselných atributů prosím posílejte bez uvozovek viz příklad.

• Odpověď

Klíč	Hodnota
Status	Řetězec popisující výsledný stav importu. SUCCESS = bezchybný průběh importu PARTIAL_SUCCESS = import proběhl, ale vygeneroval jedno nebo více varování FAILURE = při importu nastala jedna nebo více chyb
Warnings	Volitelný - je zahrnut pouze, pokud je v URL parametr ?debug a import vygeneroval alespoň jedno varování. Seznam řetězců s varováními.
Errors	Volitelný - je zahrnut pouze, pokud import vygeneroval alespoň jednu chybu. Seznam řetězců s varováními.

 

• Stavové kódy

Stav	Význam
200 OK	Import proběhl úspěšně s výsledným stavem "SUCCESS" nebo "PARTIAL_SUCCESS". Odpověď může obsahovat varování nebo nezávažné chyby.
400 Bad Request	Chybné nastavení úlohy, nebo chybný požadavek.
401 Unauthorized	Autorizační token je neplatný, nebo uživatel, který je tokenem přihlášen, nemá oprávnění spouštět tuto úlohu.
404 Not Found	Nebyla nalezena úloha s ID daným v URL.
500 Internal Server Error	Během importu nastala kritická chyba na straně serveru.
503 Service Unavailable	Import již běží. Zkuste spustit znovu za počet sekund udávaných v hlavičce Retry-After.

• Záznam průběhu

V Quantu vedle nastavení úlohy lze prohlížet i záznamy průběhů jednotlivých importů, včetně statistik, chyb a varování.

Záznam průběhu

 Vybereme-li konkrétní záznam, můžeme zobrazit jeho detaily tlačítkem Zobrazit položky.

Zobrazení detailů záznamu

• Požadavek

curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/order-properties/54?debug" \
    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Cache-Control: no-cache" \
-d "[{\"QID\":\"932554\",\"State\":\"Delivered\"},
   {\"QID\":\"1289017\",\"State\":\"Canceled\"}
]"

• Odpověď

{
  "Status": "SUCCESS", 
}