Objednávky

Objednávky

Vytvoření nové objednávky

Pomocí API lze vytvořit novou objednávku v systému. Je potřeba vyplnit informace o objednávce jako například informace o zákazníkovi a měnu objednávky.

Endpoint [POST] /System/Orders na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Načtení jedné konkrétní objednávky

Pomocí API lze načíst jedna konkrétní objednávka pomocí jejího identifikátoru, tato akce se používá při manipulaci s objednávkami, například u platebních bran. Dostaneme informace, které jsou uloženy u objednávek například její hodnota, položky v ní obsažené, cena objednávky, její status, informace o zákazníkovi apod.

Endpoint [GET] /System/Orders/{id} na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Načtení objednávek dle parametrů

Pomocí API lze také načíst objednávky dle různých parametrů. Například si můžeme načíst objednávky jen od konkrétního zákazníka.

Endpoint [GET] /System/Orders na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Položky objednávky

Vytvoření nové položky

Pomocí API lze vytvořit novou položku u konkrétní objednávky.

Endpoint [POST] /System/Orders/{id}/item na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Upravení položky

Pomocí API lze upravit konkrétní položku u konkrétní objednávky.

Endpoint [PUT] /System/Orders/{id}/item na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Smazání položky

Pomocí API lze smazat konkrétní položku u konkrétní objednávky.

Endpoint [DELETE] /System/Orders/{id}/item/{itemId} na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Načtení všech statusů objednávek pro danou instanci

Pomocí API lze načíst všechny statusy objednávek, které jsou nastaveny na dané instanci. Tyto statusy se dají přiřadit například k notifikacím.

Endpoint [GET] /System/Orders/Statuses na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Nastavení statusu k objednávce

Pomocí API lze přiřadit k objednávce libovolný status, pokud známe jeho identifikátor. Ten si můžeme například načíst pomocí endpointu pro všechny statusy na dané instanci.

Endpoint [PATCH] /System/Orders/{id}/status na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Přidání sledovacího čísla k objednávce

Pomocí API lze přidat k objednávce sledovací číslo.

Endpoint [POST] /System/Orders/{id}/tracking na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Přidání historie k objednávce

Pomocí API lze ke konkrétní objednávce vytvořit nový záznam do historie objednávky, například když dojde k jejímu zaplacení, stornování nebo jiné změně.

Endpoint [POST] /System/Orders/{id}/history na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Stavy objednávek

Pomocí API lze změnit stav u objednávky. Například po zaplacení objednávky, jejím zrušení, dokončení apod.

Zaplacená

Endpoint [PATCH] /System/Orders/{id}/paid na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Dokončená

Endpoint [PATCH] /System/Orders/{id}/done na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Zrušená

Endpoint [PATCH] /System/Orders/{id}/cancel na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Odeslána

Endpoint [PATCH] /System/Orders/{id}/sent na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci

Doručena

Endpoint [PATCH] /System/Orders/{id}/delivered na API kde můžete snadno vyzkoušet.

Více informací o endpointu a jeho parametrech naleznete v naší API dokumentaci