Dokumentace API - Slevové kupóny

Základní informace

Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům a další najdete na API v2 základní informace

Vytvoření kupónů

Požadavek

• URI: /api/v2/vouchers
• HTTP metoda: POST
• hlavičky:
  • Authorization: Basic dGVzdDp0ZXN0
  • Content-Type: application/json
• tělo
  • count (int) - počet kupónů (výchozí hodnota je 1)
  • active_yn (bool) - příznak aktivní (výchozí hodnota je true)
  • global_yn (bool) - příznak globální (výchozí hodnota je false)
  • for_products_in_action_yn (bool) - příznak použitelný pro produkty v akci (výchozí hodnota je false)
  • date_from (date) - použitelný od data
  • date_to (date) - použitelný do data
  • type (string) - typ kuponu, možné hodnoty:
    • price - cena
    • percentage - procenta z objednávky
  • currency_id (currency) - měna
  • amount (float) - hodnota kuponu, podle typu buď procenta nebo částka
  • used_from (float) - hodnota objednávky od které lze kupon použít
  • note (string) - poznámka

Seznam kupónů

• URI: /api/v2/vouchers
• HTTP metoda: GET
• hlavičky:
  • Authorization: Basic dGVzdDp0ZXN0
  • Content-Type: application/json
• parametry - slouží pro filtrování výstupu (musí být definovám alespoň jeden parametr, neplatí pro page):
  • voucher_code (string) - kód kupónu
  • voucher_codes (string) - kódy kupónů oddělené středníkem ;
  • currency_id (currency) - měna
  • active_yn (bool) - aktivní
  • for_products_in_action_yn (bool) - lze použít na produkty v akci
  • date_from (date) - datum platnosti od
  • date_to (date) - datum platnosti do
  • global_yn (bool) - globální kupón
  • page (int) - stránka, pokud není definováno, vrací vždy stranu 1

Odpověď

Seznam objednávek je dostupný po jednotlivých stranách, výstup je omezen na 100 položek na stránku.

• tělo:
  • current_page (int) - aktuální strana
  • current_page_items (int) - počet položek na aktuální straně
  • number_of_pages (int) - celkový počet stran
  • number_of_items (int) - celkový počet položek
  • vouchers (array) - pole objektů s kupóny
    • voucher_code (string) - kód kupónu
    • active_yn (bool) - aktivní
    • global_yn (bool) - globální (lze použít vícekrát)
    • for_products_in_action_yn (bool) - lze použít na produkty v akci
    • date_from (date) - datum planosti od
    • date_to (date) - datum planosti do
    • type (string) - typ kuponu, možné hodnoty:
      • price - cena
      • percentage - procenta z objednávky
    • currency_id (currency) - měna
    • amount (float) - hodnota kupónu
    • used_from (float) - lze použít od částky
    • note (string) - poznámka
    • creation_time (date) - datum vytvoření

Smazání kupónů

• URI: /api/v2/vouchers/{voucher_code}/?voucher_code={voucher_code}&voucher_codes={voucher_codes}
• HTTP metoda: DELETE
• hlavičky:
  • Authorization: Basic dGVzdDp0ZXN0
  • Content-Type: application/json
• parametry (musí být definovám alespoň jeden parametr):
  • voucher_code (string) - kód kupónu
  • voucher_codes (string) - kódy kupónů oddělené středníkem ;

Odpověď

• tělo:
  • vouchers (array) - pole objektů s kupóny
    • code (string) - kód kupónu
    • deleted_yn (bool) - příznak jestli se kupón smazal
    • messages (array) - pole objektů chybových zpráv a upozornění
      • object (string) - název objektu (část JSONu) kterého se zpráva týká
      • property (string) - hodnota které se zpráva týká
      • message (string) - text zprávy