Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
682 changes: 450 additions & 232 deletions api-reference/openapi.json

Large diffs are not rendered by default.

47 changes: 36 additions & 11 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,45 @@
},
{
"tab": "API reference",
"groups": [
"versions": [
{
"group": "Endpoints",
"openapi": {
"source": "/api-reference/openapi.json",
"directory": "api-reference"
}
"version": "1.0",
"groups": [
{
"group": "Endpoints",
"openapi": {
"source": "/api-reference/openapi.json",
"directory": "api-reference"
}
},
{
"group": "Events",
"openapi": {
"source": "/api-reference/OpenAPIWebhooks.json",
"directory": "api-reference"
}
}
]
},
{
"group": "Events",
"openapi": {
"source": "/api-reference/OpenAPIWebhooks.json",
"directory": "api-reference"
}
"version": "2.0",
"groups": [
{
"group": "Endpoints",
"pages": [
"reference-docs/Introduction",
{
"group": "Publications",
"openapi": "/api-reference/openapi.json",
"pages": [
"reference-docs/test",
"GET /v1/publications",
"POST /v1/publications"
]
}
]
}
]
}
]
},
Expand Down
190 changes: 190 additions & 0 deletions reference-docs/ASYNC-ACTIONS-Async-Action-Object.md

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions reference-docs/ASYNC-ACTIONS-Get-Async-Action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Get Async Action
type: endpoint
categorySlug: voucherify-api
slug: get-async-action
parentDocSlug: async-actions
hidden: false
order: 3
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/ASYNC-ACTIONS-List-Async-Actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: List Async Actions
type: endpoint
categorySlug: voucherify-api
slug: list-async-actions
parentDocSlug: async-actions
hidden: false
order: 2
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Add Voucher with Specific Code to Campaign
type: endpoint
categorySlug: voucherify-api
slug: add-voucher-with-specific-code-to-campaign
parentDocSlug: campaigns
hidden: false
order: 80
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Add-Vouchers-To-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Add Voucher to Campaign
type: endpoint
categorySlug: voucherify-api
slug: add-vouchers-to-campaign
parentDocSlug: campaigns
hidden: false
order: 70
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
319 changes: 319 additions & 0 deletions reference-docs/CAMPAIGNS-Campaign-Object.md

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Create-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Create Campaign
type: endpoint
categorySlug: voucherify-api
slug: create-campaign
parentDocSlug: campaigns
hidden: false
order: 30
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Delete-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Delete Campaign
type: endpoint
categorySlug: voucherify-api
slug: delete-campaign
parentDocSlug: campaigns
hidden: false
order: 50
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Disable-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Disable Campaign
type: endpoint
categorySlug: voucherify-api
slug: disable-campaign
parentDocSlug: campaigns
hidden: false
order: 120
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Enable-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Enable Campaign
type: endpoint
categorySlug: voucherify-api
slug: enable-campaign
parentDocSlug: campaigns
hidden: false
order: 110
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Examine-Qualification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Examine Qualification [Deprecated]
type: endpoint
categorySlug: voucherify-api
slug: examine-campaigns-qualification
parentDocSlug: campaigns
hidden: false
order: 130
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Export-Campaign-Transactions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Export Campaign Transactions
type: endpoint
categorySlug: voucherify-api
slug: export-campaign-transactions
parentDocSlug: campaigns
hidden: false
order: 65
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Get-Campaign-Summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Get Campaign Summary
type: endpoint
categorySlug: voucherify-api
slug: get-campaign-summary
parentDocSlug: campaigns
hidden: false
order: 67
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Get-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Get Campaign
type: endpoint
categorySlug: voucherify-api
slug: get-campaign
parentDocSlug: campaigns
hidden: false
order: 20
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Import-Vouchers-To-Campaign-Using-CSV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Import Vouchers to Campaign by CSV
type: endpoint
categorySlug: voucherify-api
slug: import-vouchers-to-campaign-using-csv
parentDocSlug: campaigns
hidden: false
order: 100
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Import-Vouchers-To-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Import Vouchers to Campaign
type: endpoint
categorySlug: voucherify-api
slug: import-vouchers-to-campaign
parentDocSlug: campaigns
hidden: false
order: 90
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-List-Campaign-Transactions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: List Campaign Transactions
type: endpoint
categorySlug: voucherify-api
slug: list-campaign-transactions
parentDocSlug: campaigns
hidden: false
order: 60
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-List-Campaigns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: List Campaigns
type: endpoint
categorySlug: voucherify-api
slug: list-campaigns
parentDocSlug: campaigns
hidden: false
order: 10
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CAMPAIGNS-Update-Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Update Campaign
type: endpoint
categorySlug: voucherify-api
slug: update-campaign
parentDocSlug: campaigns
hidden: false
order: 40
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
25 changes: 25 additions & 0 deletions reference-docs/CATEGORIES-Category-Object.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Category Object
type: basic
categorySlug: voucherify-api
parentDocSlug: categories
slug: category-object
hidden: false
order: 1
---

## Category
| Attributes | Description |
|:-----|:--------|
| id</br>`string` | <p>Unique category ID assigned by Voucherify.</p> |
| name</br>`string` | <p>Category name.</p> |
| hierarchy</br>`integer` | <p>Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.</p> |
| object</br>`string` | <p>The type of the object represented by the JSON. This object stores information about the category.</p> Available values: `category` |
| created_at</br>`string` | <p>Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.</p> **Example:** <p>2022-07-14T10:45:13.156Z</p> |
| updated_at</br>`string` | <p>Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.</p> **Example:** <p>2022-08-16T10:52:08.094Z</p> |

[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n.headline-container-article-info2GaOf2jMpV0r {\n display: none; }\n.APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.APIResponseSchemaPicker-label3XMQ9E-slNcS {\n display: none; }\n.PlaygroundC7DInM9NFvBg {\n display: none; }\n.Modal-Header3VPrQs3MUWWd {\n display: none; }\n.rm-ReferenceMain .rm-Article {\n max-width: 2000px; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CATEGORIES-Create-Category.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Create Category
type: endpoint
categorySlug: voucherify-api
slug: create-category
parentDocSlug: categories
hidden: false
order: 4
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CATEGORIES-Delete-Category.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Delete Category
type: endpoint
categorySlug: voucherify-api
slug: delete-category
parentDocSlug: categories
hidden: false
order: 6
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CATEGORIES-Get-Category.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Get Category
type: endpoint
categorySlug: voucherify-api
slug: get-category
parentDocSlug: categories
hidden: false
order: 3
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
14 changes: 14 additions & 0 deletions reference-docs/CATEGORIES-List-Categories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: List Categories
type: endpoint
categorySlug: voucherify-api
slug: list-categories
parentDocSlug: categories
hidden: false
order: 2
---
[block:html]
{
"html": "<style>\n[title=\"Toggle library\"] { \n display: none; }\n.LanguagePicker-divider { \n display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n display: none; }\n</style>"
}
[/block]
Loading