Výpis nabídek Vašeho účtu. ID nabídky z odpovědi pak použijete jako parametr price při vytváření objednávky.
Pro přístup k API potřebujete chráněný klíč Vašeho Clipsan účtu.
Naleznete jej na stránce https://clipsan.com/cs/clipsan/securekey.
Výpis nabídek
Vrací nabídky účtu seřazené podle interního názvu. Bez parametru state vrací jen aktivní nabídky, tedy ty, které mají v přehledu pod položkou „Prodej“ a dále pak „Nabídky“ zapnutý přepínač „Aktivní“. Smazané nabídky se nevypisují nikdy.
Base URL:
https://clipsan.com/api/price/list/
Vyžadované parametry
- key – Chráněný klíč Clipsan účtu
Volitelné parametry
- state – Které nabídky vypsat: active – aktivní (výchozí), inactive – neaktivní, all – aktivní i neaktivní
Odpověď
{"result":"ok","data":[{"id":"ID nabídky","name":"Interní název","label":"Text na formuláři","type":"Typ produktu","price":"Cena bez DPH","currency":"Měna","vat":"DPH v %","transfer":"Poštovné","transferfree":"Poštovné zdarma","cod":"Dobírečné","codfree":"Dobírka zdarma","funnel":"ID automatu Platební upomínka","codfunnel":"ID automatu dobírky","memberfunnel":"ID automatu členství","landings":["ID prodejní stránky"],"repeat":"Délka členství ve dnech","enabled":"Aktivní","added":"Čas vytvoření"}]}
- label – Text nabídky na objednávkovém formuláři, může obsahovat HTML
- type – digital (digitální produkt), real (fyzický produkt), membership (opakované platby)
- price – Cena za položku bez DPH, může mít více desetinných míst
- currency – Kód měny malými písmeny, např. czk, eur, usd
- transfer, cod – Poštovné a dobírečné, 0 když nejsou nastavené
- transferfree, codfree – Počet kusů v objednávce, od kterého je poštovné, resp. dobírka zdarma
- funnel – ID automatu, který se spustí po zakoupení nabídky (ve formuláři nabídky „Platební upomínka“)
- codfunnel – ID automatu dobírky, null když není vybraný (dobírka se pak nenabízí)
- memberfunnel – ID automatu členství, null když není vybraný
- landings – ID prodejních stránek, na kterých je nabídka, prázdné pole když na žádné není
- repeat – Délka členství ve dnech u nabídek s opakovanými platbami, jinak null
- enabled – true u aktivní nabídky, false u neaktivní
- added – Čas vytvoření nabídky (Unix timestamp)
Příklad volání
https://clipsan.com/api/price/list/key/VASKLIC
https://clipsan.com/api/price/list/?key=VASKLIC
Příklad odpovědi
{"result":"ok","data":[{"id":2876,"name":"Kurz vaření","label":"Online kurz vaření","type":"digital","price":1990,"currency":"czk","vat":21,"transfer":0,"transferfree":0,"cod":0,"codfree":0,"funnel":3685,"codfunnel":null,"memberfunnel":null,"landings":[3555],"repeat":null,"enabled":true,"added":1692809993},{"id":3224,"name":"Kurkumin","label":"Kurkumin 60 kapslí","type":"real","price":350,"currency":"czk","vat":12,"transfer":89,"transferfree":2,"cod":40,"codfree":10,"funnel":2274,"codfunnel":2275,"memberfunnel":null,"landings":[3791,3792],"repeat":null,"enabled":true,"added":1750676110}]}
Příklad volání (všechny nabídky)
https://clipsan.com/api/price/list/key/VASKLIC/state/all
https://clipsan.com/api/price/list/?key=VASKLIC&state=all
Příklad odpovědi
{"result":"ok","data":[{"id":2876,"name":"Kurz vaření","label":"Online kurz vaření","type":"digital","price":1990,"currency":"czk","vat":21,"transfer":0,"transferfree":0,"cod":0,"codfree":0,"funnel":3685,"codfunnel":null,"memberfunnel":null,"landings":[3555],"repeat":null,"enabled":true,"added":1692809993},{"id":2877,"name":"Kurz vaření 2025","label":"Online kurz vaření","type":"digital","price":1490,"currency":"czk","vat":21,"transfer":0,"transferfree":0,"cod":0,"codfree":0,"funnel":3684,"codfunnel":null,"memberfunnel":null,"landings":[],"repeat":null,"enabled":false,"added":1661273993},{"id":3224,"name":"Kurkumin","label":"Kurkumin 60 kapslí","type":"real","price":350,"currency":"czk","vat":12,"transfer":89,"transferfree":2,"cod":40,"codfree":10,"funnel":2274,"codfunnel":2275,"memberfunnel":null,"landings":[3791,3792],"repeat":null,"enabled":true,"added":1750676110}]}
Příklad volání (účet bez nabídek)
https://clipsan.com/api/price/list/key/VASKLIC
Příklad odpovědi
{"result":"ok","data":[]}
Příklad volání (neplatná hodnota state)
https://clipsan.com/api/price/list/key/VASKLIC/state/enabled
Příklad odpovědi
{"result":"error","error":"invalid state, use active, inactive or all"}
Příklad volání (neplatný klíč)
https://clipsan.com/api/price/list/key/NEPLATNYKLIC
Příklad odpovědi
{"result":"error","error":"invalid secure key"}
Jak ID nabídky použít při vytváření objednávky, najdete v návodu „API: Prodej“, ID automatu v návodu „API: Automaty“.