Dokumentácia API - Zľavové kupóny

Základné informácie

Základné informácie k API, autentizácii, stavovým kódom, HTTP metódam, dátovým typom a ďalšie nájdete na API v2 základné informácie

Vytvorenie kupónov

Požiadavka

• URI: /api/v2/vouchers
• HTTP metóda: POST
• hlavičky:
• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
• telo
• count (int) - počet kupónov (východisková hodnota je 1)
• active_yn (bool) - príznak aktívny (východisková hodnota je true)
• global_yn (bool) - príznak globálny (východisková hodnota je false)
• for_products_in_action_yn (bool) - príznak použiteľný pre produkty v akcii (východisková hodnota je false)
• date_from (date) - použiteľný od dátumu
• date_to (date) - použiteľný do dátumu
• type (string) - typ kupónu, možné hodnoty:
• price - cena
• percentage - percentá z objednávky
• currency_id (currency) - mena
• amount (float) - hodnota kupónu, podľa typu buď percentá alebo suma
• used_from (float) - hodnota objednávky, od ktorej je možné kupón použiť
• note (string) - poznámka

Zoznam kupónov

• URI: /api/v2/vouchers
• HTTP metóda: GET
• hlavičky:
• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
• parametre - slúžia pre filtrovanie výstupu (musí byť definovaný aspoň jeden parameter, neplatí pre page):
• voucher_code (string) - kód kupónu
• voucher_codes (string) - kódy kupónov oddelené bodkočiarkou ;
• currency_id (currency) - mena
• active_yn (bool) - aktívne
• for_products_in_action_yn (bool) - je možné použiť na produkty v akcii
• date_from (date) - dátum platnosti od
• date_to (date) - dátum platnosti do
• global_yn (bool) - globálny kupón
• page (int) - stránka, pokiaľ nie je definované, vracia vždy stranu 1

Odpoveď

Zoznam objednávok je dostupný po jednotlivých stranách, výstup je obmedzený na 100 položiek na stránku.

• telo:
• current_page (int) - aktuálna strana
• current_page_items (int) - počet položiek na aktuálnej strane
• number_of_pages (int) - celkový počet strán
• number_of_items (int) - celkový počet položiek
• vouchers (array) - pole objektov s kupónmi
• voucher_code (string) - kód kupónu
• active_yn (bool) - aktívne
• global_yn (bool) - globálne (je možné použiť viackrát)
• for_products_in_action_yn (bool) - je možné použiť na produkty v akcii
• date_from (date) - dátum platnosti od
• date_to (date) - dátum platnosti do
• type (string) - typ kupónu, možné hodnoty:
• price - cena
• percentage - percentá z objednávky
• currency_id (currency) - mena
• amount (float) - hodnota kupónu
• used_from (float) - je možné použiť od sumy
• note (string) - poznámka
• creation_time (date) - dátum vytvorenia

Zmazanie kupónov

• URI: /api/v2/vouchers/{voucher_code}/?voucher_code={voucher_code}&voucher_codes={voucher_codes}
• HTTP metóda: DELETE
• hlavičky:
• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
• parametre (musí byť definovaný aspoň jeden parameter):
• voucher_code (string) - kód kupónu
• voucher_codes (string) - kódy kupónov oddelené bodkočiarkou ;

Odpoveď

• telo:
• vouchers (array) - pole objektov s kupónmi
• code (string) - kód kupónu
• deleted_yn (bool) - príznak, či sa kupón zmazal
• messages (array) - pole objektov chybových správ a upozornení
• object (string) - názov objektu (časť JSON), ktorého sa správa týka
• property (string) - hodnota, ktorej sa správa týka
• message (string) - text správy