Objednávky - historie

unikátním identifikátorem objednávek je číslo objednávky (order_number)
pro práci s objednávkami lze využívat webhooky
více o objednávkách v Upgates e-shopech najdete zde

Seznam

GET

/api/v2/orders/{order_number}/history

Vrací seznam událostí z historie objednávky. Data historie mohou obsahovat HTML značky.

Seznam › path Parameters

order_number

string · required

Číslo objednávky

Seznam › Responses

200

number_of_items

integer

počet položek historie

object[]

pole objektů s událostmi historie

Přidání záznamu

POST

/api/v2/orders/{order_number}/history

Přidá záznam do historie objednávky. Jeden požadavek znamená přidání jednoho záznamu do historie. Slouží hlavně pro systémy třetích stran, které chtějí informovat administrátora e-shopu o tom, že proběhla nějaká událost. Čas události nelze upravovat. Pokud chcete, můžete si poslat čas v datech události.

Přidání záznamu › path Parameters

order_number

string · required

Číslo objednávky

Přidání záznamu › Request Body

object[] · required

pole objektů s daty historie

Přidání záznamu › Responses

200

updated

boolean

příznak, zda došlo k aktualizaci

object[]

chybové zprávy

Objednávky Objednávky - přílohy

Seznam

GET

/api/v2/orders/{order_number}/history

Vrací seznam událostí z historie objednávky. Data historie mohou obsahovat HTML značky.

Seznam › path Parameters

order_number

string · required

Číslo objednávky

Seznam › Responses

200

number_of_items

integer

počet položek historie

object[]

pole objektů s událostmi historie

Přidání záznamu

POST

/api/v2/orders/{order_number}/history

Přidání záznamu › path Parameters

order_number

string · required

Číslo objednávky

Přidání záznamu › Request Body

object[] · required

pole objektů s daty historie

Přidání záznamu › Responses

200

updated

boolean

příznak, zda došlo k aktualizaci

object[]

chybové zprávy