diff --git a/docs/script/.env.example b/.env.example similarity index 100% rename from docs/script/.env.example rename to .env.example diff --git a/.gitignore b/.gitignore index 481db3c5d..e54052eab 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ -.idea/* -docs/script/.env -node_modules/* +node_modules +scripts/output/*.md +.env +.DS_Store \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f8bce17f3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,141 @@ +# Voucherify's documentation and OpenAPI contribution + +## Introduction + +Voucherify builds and maintains REST API documentation and SDKs to make it easier for software developers to understand and integrate Voucherify into their e-commerce platforms. + +This document describes all deliverables and their development process. + +## Deliverables + +Voucherify's dev experience is built based on three main items: +- **Guides** documentation that describes key concepts, integration with Voucherify development and common recipes. This documentation is available on the page: https://docs.voucherify.io/docs. +- **API Reference** documentation describing REST API endpoints, including available parameters and responses. This documentation is available on the page: https://docs.voucherify.io/reference/introduction-1 +- **SDKs** - clients for all major programming languages, e.g., JavaScript, Java, Ruby, Python, .NET, PHP. SDK's source codes are hosted on the GitHub platform and available for the developers in language-specific package repositories like https://npmjs.com/, https://rubygems.org/ or https://maven.apache.org/ + + +## Guides and API Reference + +Guides and API Reference pages are hosted on readme.io, the platform for creating and hosting developer documentation. Still, the source of documentation content is stored in the GitHub repository: https://github.com/voucherifyio/voucherify-openapi. Guides are stored purely as markdown files in the https://github.com/voucherifyio/voucherify-openapi/tree/master/docs/guides folder and can be easily uploaded to the readme.io platform via readme CLI. API Reference pages are built by readme.io, which combines the OpenAPI file that describes Voucherify API endpoints, parameters and responses with markdown files from https://github.com/voucherifyio/voucherify-openapi/tree/master/docs/reference-docs folder. + +## API Reference - Endpoint Pages + +API Endpoint Pages like https://docs.voucherify.io/reference/get-voucher describe REST API endpoint, including details like path, HTTP method, path params, body params, response schema and response statuses. On the right side of those pages, we have a `Playground Widget` that allows developers to make test API calls. Readme.io builds those pages using information about the REST API from the uploaded OpenAPI file and displays a UI that allows the exploration of all details. For each endpoint page, we have a corresponding dummy markdown file like https://github.com/voucherifyio/voucherify-openapi/blob/master/docs/reference-docs/VOUCHERS-API-Get-Voucher.md that allows us to control visual aspect of the page displayed in the readme, in particular: +- The markdown attributes section at the beginning of the file wrapped by `---` describes the page title, type, slug, order, and visibility. +- `[block:html]` section that adds custom styles to the page that hides unnecessary UI elements like Playground language selector or expandable readme object exploration widget. It also can be used to display the "Beta" tag next to the title. + +Reamde.io platform compares the `operationId` endpoint details attribute from the OpenAPI file with the `slug` from the markdown attributes to combine it and display the final version of the API Endpoint Page. + +As you can notice, all API Endpoint pages are grouped by sections like `Vouchers API`, `Campaigns API` or `Promotions API`. Those sections are built by reamde.io based on the `tags` endpoint details attribute from the OpenAPI file and must be repeated in the `parentDocSlug` attribute of the dummy markdown file. + + +## API Reference - Data Model Pages + + +Data model pages like: https://docs.voucherify.io/reference/voucher-object describe the schema of the main building blocks used in specific sections. There are two types of Data Model Pages: +1. using readme.io expandable object exploration widget, like on the page: https://docs.voucherify.io/reference/validation-object +2. displaying schema of the object wit all attributes in a table like on the page: https://docs.voucherify.io/reference/voucher-object + +We believe that displaying object details in a table is more intuitive for developers. Unfortunately, readme.io does not have the feature to display building block objects defined in OpenAPI in a table format, so we have built custom JS scripts (`build-md-tables-from-openapi` and `update-md-tables-in-doc`) that generate markdown tables automatically using an OpenAPI file and put them inside the markdown inside the `reference-docs` folder, e.g.: https://github.com/voucherifyio/voucherify-openapi/blob/master/docs/reference-docs/VOUCHERS-API-Voucher-Object.md. Once we generate the markdown files we can upload them to readme.io using the readme.io CLI. + +## API Reference - Introduction pages + +Pages from the introduction section, like https://docs.voucherify.io/reference/introduction-1, are just markdown pages uploaded to readme.io using CLI. Content can be found along with other markdown files inside the `docs/reference-docs` folder, e.g. https://github.com/voucherifyio/voucherify-openapi/blob/master/docs/reference-docs/Introduction.md. + +## Beta endpoints + +To label the API endpoint as a beta in readme.io, you should make the following changes in the corresponding markdown file: +- add `[Beta]` postfix in page title (`title` markdown attribute) +- add to `[block:html]` section following style: + +```css +h1::after {\n content: \"BETA\";\n background-color: rgb(237, 117, 71);\n color: rgb(255, 255, 255);\n border-radius: 2rem;padding: 8px 13px 8px;\n white-space: nowrap;font-size:12px;\n} +``` + +## OpenAPI + +OpenAPI syntax documentation can be found here: https://swagger.io/specification/. +Voucherify OpenAPI is located here: https://github.com/voucherifyio/voucherify-openapi/blob/master/reference/OpenAPI.json. +We use stoplight to edit the OpenAPI file as it gives a nice UI that helps to edit this 80k+ line of code json file. Everyone can create a free account on the Stoplight platform. + +How to edit OpenAPI file: +1. upload OpenAPI to the Stoplight platform +2. make changes in OpenAPI using Stoplight UI +3. export modified OpenAPI content and update the OpenAPI file in the repository +4. run `npm run remove-stoplight-tags-from-openapi` command to remove from OpenAPI unwanted Stoplight tags `x-stoplight` (that makes it hard to review changes) +5. ensure that OpenAPI has only expected modifications + +> [!WARNING] Each OpenAPI change should be tested by reviewing documentation on readme.io after the full documentation update process. + + Building new models, we should follow the following name convention: +- Use snake case casing. +- If a model is used as a specific API endpoint description (0-level model), then we follow the pattern: `{resource}_{action}_{request|response}_{body|param|query}`, where: + - `resource`: plural name taken from API path, e.g. `vouchers`, `customers`, `products` + - `action` : `get`(single record), `list`, `update`, `delete`, `create` (etc.) +- If a 0-level model has dedicated sub-models, then those model's names should follow the pattern: + `{resource}_{action}_{differentiator}_{request|response}_{body|param|query}` + where the `differentiator` describes the child model, e.g., `publication`. +- If a model is used by more than one API endpoint (general model), we use simple domain language, e.g. `voucher`, `customer`, `product`, `discount`, `discount_unit` + +For example: +- The general voucher model, used in many different API endpoints, should have the name `voucher` (currently, it has a name: `1_obj_voucher_object`) +- for path `GET /v1/vouchers` (list vouchers), we have a `1_res_vouchers_GET` 0-level model, that should be named: `vouchers_list_response_body`. +- for path `GET /v1/vouchers` (list vouchers), we have a `1_res_vouchers_GET` 0-level model which has sub-model `1_obj_voucher_object_list_vouchers` that should be named: `vouchers_list_item_response_body` +- General model `1_obj_voucher_object` is used in many paths (`GET /v1/vouchers/{code}`, `POST /v1/vouchers/qualification`, `GET /v1/publications/create`); therefore, we should rename the model to `voucher`. + +> [!NOTE] Try to avoid building complex type structures. 0-level models, sub-modules and general modules should be enough to describe the API. Do not be afraid to repeat models for different API endpoints if there are differences. + + + +Good practices: +- for literal unions use `enum` +- for types unions, use `anyOf`, +- for attributes that may contain `null`, add `"nullable": true` +- for dates use `"type": "string", "format": "date-time"` +- for the object, add the "required" attribute which should contain a list of required attributes in the object + +## Contribution to documentation + +### Prerequisites + +- Instal `git`, `nodejs`, and `npm`. +- Clone repository locally: `git clone https://github.com/voucherifyio/voucherify-openapi`. +- Ensure you have the readme.io account with access to the `Voucherify` project (ask your line manager for help). +- Instal `rdme` tool (readme.io CLI): follow the installation instructions from https://github.com/readmeio/rdme#readme website. +- Authenticate `rdme` tool by running: `rdme login` command; you can check if it works using the command `rdme whoami`; what should result: `You are currently logged in as xxx@voucherify.io to the voucherify project.` +- Copy `.env.example` to `.env` and add to this file your personal API Key created in readme.io: `dashboard` > `configuration` > `API Keys` + +### Development process +- For each change / pull request, create your copy of the current documentation, where you will test changes. + - Create your own branch from `master`, + - Create a draft pull request, + - Go to `Manage Versions` page in readme.io + - Click `Add New Version` from top right corner. + - Select the current public version in `Fork from` field, most likely `2018-08-01` + - Type your version name in `Create version` field following the pattern: + `2018-08-01-{your name}-{pull request number}` +- Make changes in the repository following patterns and good practices. +- Deploy changes to test your documentation: + - Update tables in markdown tables: + - `npm run build-md-tables-from-openapi` + - `npm run update-md-tables-in-doc` + - If before created, remove from API Reference the existing OpenAPI file and all specification files. + - Deploy OpenAPI file by command `rdme openapi ./reference/OpenAPI.json --version=2018-08-01-{your name}-{pull request number}`, choose `Create a new spec` option. Command most likely will fail with the message: `We're sorry, your upload request timed out. Please try again or split your file up into smaller chunks`, but so far, we see that this operation still works correctly. + - Deploy guides pages: `rdme docs ./docs/guides --version=2018-08-01-{your name}-{pull request number}` + - Deploy api reference pages: `rdme docs ./docs/reference-docs --version=2018-08-01-{your name}-{pull request number}` + - Fix docs order: `npm run readme-fix-docs-order -- --version=v2018-08-01-{your name}-{pull request number}` +- test changes using preview on readme.io +- if changes are fine, then: + - Add a note in the changelog. + - `git commit` + - `git push` + - publish PR + + +## How to merge PR and update public documentation + +- Test changes on readme (you can use the version prepared by the contributor). +- Ensure the changelog was updated. +- Merge PR to `master` branch +- In reamde.io, change the current documentation version from `v2018-08-01` to `v2018-08-01-deprecated-mm-dd-yyyy` +- Change the name of your new release version from `2018-08-01-{your name}-{pull request number}` to `v2018-08-01` diff --git a/Changelog.md b/Changelog.md index 5aa488163..4daf624ac 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,5 +1,19 @@ # Changelog +## 20230928 - Order references/guides script + +- Removed `beta` label from qualification API endpoints. +- Described contribution process. +- Added the script to clean up OpenAPI from Stoplight tags. +- Reorganised maintenance scripts. +- Automated the process of updating the data model documents based on the OpenAPI file. +- Improve script which generates markdown tables based on the OpenAPI file. + - Render objects referred directly by $ref. + - fix rendering oneOf + ref. + - Render ref to simple types (e.g. enum) + - Do not duplicate rendering tables when there is more than one reference. + - add the missing title to `23_obj_qualification_object_stacking_rules object. + ## 20230925 - Order references/guides script Added script, located in `docs/script/` directory to quickly update order of references and guides based on `.md` files. For more information please check [Update-Order-Standard-Work.md](automation%2FUpdate-Order-Standard-Work.md) under `Update Order of Docs - AUTOMATIC` section. diff --git a/automation/Readme-Voucherify-Docs-API-Reference.postman_collection.json b/automation/Readme-Voucherify-Docs-API-Reference.postman_collection.json deleted file mode 100644 index 461e61e2b..000000000 --- a/automation/Readme-Voucherify-Docs-API-Reference.postman_collection.json +++ /dev/null @@ -1,9220 +0,0 @@ -{ - "info": { - "_postman_id": "bb5e210d-b31f-40b6-a456-abe59ee15c94", - "name": "Readme - Voucherify Docs - API - With Object Schemas", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "18603863", - "_collection_link": "https://crimson-zodiac-829239.postman.co/workspace/Voucherify-Testing~59bed91e-93d8-4799-9838-b01ffcc9f6f8/collection/18603863-bb5e210d-b31f-40b6-a456-abe59ee15c94?action=share&source=collection_link&creator=18603863" - }, - "item": [ - { - "name": "Introduction", - "item": [ - { - "name": "Introduction", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Introduction\",\n \"category\": \"639ba44d204cb60020b4b7ec\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "introduction-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Errors", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Errors\",\n \"category\": \"639ba44d204cb60020b4b7ec\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "errors" - } - ] - } - }, - "response": [] - }, - { - "name": "Versioning", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Versioning\",\n \"category\": \"639ba44d204cb60020b4b7ec\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "versioning" - } - ] - } - }, - "response": [] - }, - { - "name": "Fetching Data", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Fetching Data\",\n \"category\": \"639ba44d204cb60020b4b7ec\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "listing" - } - ] - } - }, - "response": [] - }, - { - "name": "Object Schemas", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Object Schemas\",\n \"category\": \"639ba44d204cb60020b4b7ec\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "object-schemas" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Vouchers API", - "item": [ - { - "name": "Voucher Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Voucher Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "voucher-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Vouchers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Vouchers\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-vouchers" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Voucher", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Voucher\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Voucher", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Voucher\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Generate Random Code", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Generate Random Code\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "generate-random-code" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Voucher", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Voucher\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Voucher", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Voucher\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Enable Voucher", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Enable Voucher\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "enable-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Disable Voucher", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Disable Voucher\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "disable-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Add or Remove Gift Card Balance", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Add or Remove Gift Card Balance\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "add-remove-gift-voucher-balance" - } - ] - } - }, - "response": [] - }, - { - "name": "List Gift Card Transactions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Gift Card Transactions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-gift-card-transactions" - } - ] - } - }, - "response": [] - }, - { - "name": "Export Gift Card Transactions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Export Gift Card Transactions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "export-gift-card-transactions" - } - ] - } - }, - "response": [] - }, - { - "name": "Import Vouchers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import Vouchers\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 13\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-vouchers" - } - ] - } - }, - "response": [] - }, - { - "name": "Import Vouchers using CSV", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import Vouchers using CSV\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 14\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-vouchers-using-csv" - } - ] - } - }, - "response": [] - }, - { - "name": "Examine Qualification [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Examine Qualification [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 15\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "examine-vouchers-qualification" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Vouchers in Bulk", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Vouchers in bulk\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 16\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-vouchers-in-bulk" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Vouchers` metadata in bulk", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Vouchers' metadata in bulk\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 17\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-vouchers-metadata-in-bulk" - } - ] - } - }, - "response": [] - }, - { - "name": "Release Validation Session", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Release Validation Session\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faae\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 18\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "release-validation-session" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Campaigns API", - "item": [ - { - "name": "Campaign Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Campaign Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "campaign-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Campaigns", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Campaigns\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-campaigns" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Add Vouchers to Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Add Vouchers to Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "add-vouchers-to-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Add Vouchers with Specific Code to Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Add Voucher with Specific Code to Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "add-voucher-with-specific-code-to-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Import Vouchers to Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import Vouchers to Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-vouchers-to-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Import Vouchers to Campaign by CSV", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import Vouchers to Campaign by CSV\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-vouchers-to-campaign-using-csv" - } - ] - } - }, - "response": [] - }, - { - "name": "Examine Qualification [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Examine Qualification [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "examine-campaigns-qualification" - } - ] - } - }, - "response": [] - }, - { - "name": "Enable Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Enable Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "enable-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Disable Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Disable Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faaf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 13\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "disable-campaign" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Promotions API", - "item": [ - { - "name": "Promotion Tier Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Promotion Tier Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "promotion-tier-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Promotion Tiers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Promotion Tiers\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-promotion-tiers" - } - ] - } - }, - "response": [] - }, - { - "name": "List Promotion Tiers (client-side)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Promotion Tiers (client-side)\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-promotion-tiers-client-side" - } - ] - } - }, - "response": [] - }, - { - "name": "List Promotion Tiers from Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Promotion Tiers from Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-promotion-tiers-from-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Add Promotion Tier to Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Add Promotion Tier to Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "add-promotion-tier-to-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Promotion Tier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Promotion Tier\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-promotion-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Promotion Tier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Promotion Tier\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-promotion-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Promotion Tier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Promotion Tier\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-promotion-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "Enable Promotion Tier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Enable Promotion Tier\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "enable-promotion-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "Disable Promotion Tier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Disable Promotion Tier\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "disable-promotion-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "List Promotion Stacks", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Promotion Stacks\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-all-promotion-stacks" - } - ] - } - }, - "response": [] - }, - { - "name": "List Promotion Stacks in Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Promotion Stacks in Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-promotion-stacks-in-campaign" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Promotion Stack", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Promotion Stack\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 13\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-promotion-stack" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Promotion Stack", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Promotion Stack\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 14\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-promotion-stack" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Promotion Stack", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Promotion Stack\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 15\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-promotion-stack" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Promotion Stack", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Promotion Stack\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 16\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-promotion-stack" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Rewards API", - "item": [ - { - "name": "Reward Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Reward Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "reward-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Reward Assignment Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Reward Assignment Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "reward-assignment-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Rewards", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Rewards\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-rewards" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Reward", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Reward\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-reward" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Reward", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Reward\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-reward" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Reward", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Reward\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-reward" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Reward", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Reward\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-reward" - } - ] - } - }, - "response": [] - }, - { - "name": "List Reward Assignments", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Reward Assignments\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-reward-assignments" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-reward-assignment" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-reward-assignment" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-reward-assignment" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-reward-assignment" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Publications API", - "item": [ - { - "name": "Publication Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Publication Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"63b58495b5ee6800ab6535dc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "publication-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Publications", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Publications\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"63b58495b5ee6800ab6535dc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-publications" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Publication", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Publication\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"63b58495b5ee6800ab6535dc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-publication-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Publication", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Publication\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"63b58495b5ee6800ab6535dc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-publication" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Validations API", - "item": [ - { - "name": "Establish Validation Session", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Establish Validation Session\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab3\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validation-session" - } - ] - } - }, - "response": [] - }, - { - "name": "Validation Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validation Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab3\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validation-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Validate Voucher [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validate Voucher [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab3\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validate-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Validate Voucher (client-side) [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validate Voucher (client-side) [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab3\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validate-voucher-client-side" - } - ] - } - }, - "response": [] - }, - { - "name": "Validate Promotions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validate Promotions [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab3\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validate-promotions" - } - ] - } - }, - "response": [] - }, - { - "name": "Validate Promotion Tier [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validate Promotion Tier [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab3\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validate-promotion-tier" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Redemptions API", - "item": [ - { - "name": "Redemption Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redemption Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redemption-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Rollback Redemption Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Rollback Redemption Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "rollback-redemption-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Redemptions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Redemptions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-redemptions" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Redemption", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Redemption\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-redemption" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Voucher Redemptions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Voucher's Redemptions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-voucher-redemptions" - } - ] - } - }, - "response": [] - }, - { - "name": "Redeem Voucher [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redeem Voucher [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redeem-voucher" - } - ] - } - }, - "response": [] - }, - { - "name": "Redeem Voucher (client-side) [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redeem Voucher (client-side) [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redeem-voucher-client-side" - } - ] - } - }, - "response": [] - }, - { - "name": "Rollback Redemption", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Rollback Redemption\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "rollback-redemption" - } - ] - } - }, - "response": [] - }, - { - "name": "Redeem Promotion [Deprecated]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redeem Promotion [Deprecated]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab4\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redeem-promotion" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Stackable Discounts API", - "item": [ - { - "name": "Stacking API Overview", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Stacking API Overview\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "stacking-api-overview" - } - ] - } - }, - "response": [] - }, - { - "name": "Establish Validation Session", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Establish Validation Session\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "establish-validation-session" - } - ] - } - }, - "response": [] - }, - { - "name": "Stackable Redemptions Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Stackable Redemptions Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "stackable-redemptions-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Validate Stacked Discounts", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validate Stackable Discounts\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validate-stacked-discounts" - } - ] - } - }, - "response": [] - }, - { - "name": "Validate Stacked Discounts (client-side)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validate Stackable Discounts (client-side)\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validate-stacked-discounts-client-side" - } - ] - } - }, - "response": [] - }, - { - "name": "Redeem Stacked Discounts", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redeem Stackable Discounts\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redeem-stacked-discounts" - } - ] - } - }, - "response": [] - }, - { - "name": "Redeem Stacked Discounts (client-side)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redeem Stackable Discounts (client-side)\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redeem-stacked-discounts-client-side" - } - ] - } - }, - "response": [] - }, - { - "name": "Rollback Stackable Redemptions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Rollback Stackable Redemptions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab5\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "rollback-stacked-redemptions" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Loyalties API", - "item": [ - { - "name": "Loyalty Campaign Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Loyalty Campaign Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "loyalty-campaign-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Loyalty Card Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Loyalty Card Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "loyalty-card-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Loyalty Tier Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Loyalty Tier Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "loyalty-tier-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Earning Rule Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Earning Rule Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "earning-rule-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Loyalty Programs", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Loyalty Campaigns\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-loyalty-programs" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Loyalty Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Loyalty Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-loyalty-program" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Loyalty Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Loyalty Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-loyalty-program" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Loyalty Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Loyalty Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-loyalty-program" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Loyalty Campaign", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Loyalty Campaign\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-loyalty-program" - } - ] - } - }, - "response": [] - }, - { - "name": "List Members", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Members\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-members" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Member", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Member\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-member" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Member", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Member\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-member-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Add Member", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Add Member\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 13\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "add-member" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Member Activities", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Member Activities\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 14\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-member-activities" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Member Activities", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Member Activities\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 15\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-member-activities-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Add or Remove Loyalty Card Balance", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Add or Remove Loyalty Card Balance\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 16\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "add-remove-loyalty-card-balance" - } - ] - } - }, - "response": [] - }, - { - "name": "Add or Remove Loyalty Card Balance", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Add or Remove Loyalty Card Balance\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 17\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "add-remove-loyalty-card-balance-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Transfer Loyalty Points", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Transfer Points\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 18\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "transfer-points" - } - ] - } - }, - "response": [] - }, - { - "name": "List Loyalty Card Transactions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Loyalty Card Transactions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 19\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-loyalty-card-transactions-1" - } - ] - } - }, - "response": [] - }, - { - "name": "List Loyalty Card Transactions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Loyalty Card Transactions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 20\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-loyalty-card-transactions" - } - ] - } - }, - "response": [] - }, - { - "name": "Export Loyalty Card Transactions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Export Loyalty Card Transactions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 21\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "export-loyalty-card-transactions-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Export Loyalty Card Transactions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Export Loyalty Card Transactions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 22\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "export-loyalty-card-transactions" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Points Expiration", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Points Expiration\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 23\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-points-expiration" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Points Expiration Export", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Points Expiration Export\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 24\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-points-expiration-export" - } - ] - } - }, - "response": [] - }, - { - "name": "List Earning Rules", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Earning Rules\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 25\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-earning-rules" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Earning Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Earning Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 26\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-earning-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Earning Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Earning Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 27\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-earning-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Earning Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Earning Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 28\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-earning-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Earning Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Earning Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 29\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-earning-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "Enable Earning Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Enable Earning Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 30\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "enable-earning-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "Disable Earning Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Disable Earning Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 31\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "disable-earning-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "List Member Rewards", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Member Rewards\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 32\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-member-rewards" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Reward Details", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Reward Details\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 33\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-reward-details" - } - ] - } - }, - "response": [] - }, - { - "name": "Redeem Reward", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redeem Reward\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 34\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redeem-reward" - } - ] - } - }, - "response": [] - }, - { - "name": "Redeem Reward", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redeem Reward\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 35\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redeem-reward-1" - } - ] - } - }, - "response": [] - }, - { - "name": "List Reward Assignments", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Reward Assignments\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 36\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-reward-assignments-1" - } - ] - } - }, - "response": [] - }, - { - "name": "List Reward Assignments", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Reward Assignments\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 37\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-reward-assignments-2" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 38\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-reward-assignment-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 39\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-reward-assignment-2" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 40\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-reward-assignment-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 41\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-reward-assignment-1" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Reward Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Reward Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 42\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-reward-assignment-1" - } - ] - } - }, - "response": [] - }, - { - "name": "List Loyalty Tiers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Loyalty Tiers\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 43\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-loyalty-tiers" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Loyalty Tier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Loyalty Tier\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 44\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-loyalty-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "List Member's Loyalty Tiers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Member's Loyalty Tiers\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 45\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-member-loyalty-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "List Loyalty Tier Earning Rules", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Loyalty Tier Earning Rules\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 46\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-loyalty-tier-earning-rules" - } - ] - } - }, - "response": [] - }, - { - "name": "List Loyalty Tier Rewards", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Loyalty Tier Rewards\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab6\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 47\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-loyalty-tier-rewards" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Customers API", - "item": [ - { - "name": "Customer Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Customer Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "customer-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Customer Activity Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Customer Activity Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "customer-activity-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Customers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Customers\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-customers" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Customer", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Customer\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-customer" - } - ] - } - }, - "response": [] - }, - { - "name": "List Customer Activities", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Customer Activities\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-customer-activities" - } - ] - } - }, - "response": [] - }, - { - "name": "List Customer Segments", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Customer's Segments\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-customer-segments" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Customer", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Customer\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-customer" - } - ] - } - }, - "response": [] - }, - { - "name": "Import and Update Customers using CSV", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import and Update Customers using CSV\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-customers-using-csv" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Customer", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Customer\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-customer" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Customer's Consents", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Customer's Consents\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-customers-consents" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Customer's Consents (client-side)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Customer's Consents (client-side)\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-customers-consents-client-side" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Customers in bulk", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Customers in bulk\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-customers-in-bulk" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Customers Metadata in bulk", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Customers' Metadata in bulk\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 13\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-customers-metadata-in-bulk" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Customer", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Customer\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 14\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-customer" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Customer Permanently", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Customer Permanently\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 15\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-customer-permanently" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Orders API", - "item": [ - { - "name": "Order Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Order Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "order-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Orders", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Orders\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-orders" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Order", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Order\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-order" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Order", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Order\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-order" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Order", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Order\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-order" - } - ] - } - }, - "response": [] - }, - { - "name": "Import Orders", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import Orders\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-orders" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Orders Export", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Orders Export\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-order-export" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Products API", - "item": [ - { - "name": "Product Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Product Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "product-object" - } - ] - } - }, - "response": [] - }, - { - "name": "SKU Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"SKU Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "sku-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Products", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Products\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-products" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Product", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Product\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-product" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Product", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Product\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-product" - } - ] - } - }, - "response": [] - }, - { - "name": "Import Products using CSV", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import Products using CSV\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-products-using-csv" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Product", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Product\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-product" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Products in bulk", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Products in bulk\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-products-in-bulk" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Products' Metadata in bulk", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Products' Metadata in bulk\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-products-metadata-in-bulk" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Product", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Product\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-product" - } - ] - } - }, - "response": [] - }, - { - "name": "List SKUs in Product", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List SKUs in Product\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-skus-in-product" - } - ] - } - }, - "response": [] - }, - { - "name": "Get SKU", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get SKU\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-sku" - } - ] - } - }, - "response": [] - }, - { - "name": "Create SKU", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create SKU\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 13\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-sku" - } - ] - } - }, - "response": [] - }, - { - "name": "Import SKUs using CSV", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import SKUs using CSV\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 14\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-skus-using-csv" - } - ] - } - }, - "response": [] - }, - { - "name": "Update SKU", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update SKU\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 15\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-sku" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete SKU", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete SKU\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fab9\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 16\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-sku" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Product Collections API", - "item": [ - { - "name": "Product Collection Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Product Collection Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faba\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "product-collection-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Product Collections", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Product Collections\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faba\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-product-collections" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Product Collection", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Product Collection\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faba\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-product-collection" - } - ] - } - }, - "response": [] - }, - { - "name": "List Products in Collection", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Products Collection\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faba\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-products-in-collection" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Product Collection", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Product Collection\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5faba\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-product-collection" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Validation Rules API", - "item": [ - { - "name": "Validation Rule Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validation Rule Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validation-rule-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Validation Rule Assignment Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validation Rule Assignment Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validation-rule-assignment-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Validation Rules", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Validation Rules\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-validation-rules" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Validation Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Validation Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-validation-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Validation Rules", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Validation Rules\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-validation-rules" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Validation Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Validation Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-validation-rule" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Validation Rule", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Validation Rule\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-validation-rules" - } - ] - } - }, - "response": [] - }, - { - "name": "List Validation Rules' Assignments(s)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Validation Rules' Assignment(s)\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-validation-rules-assignments" - } - ] - } - }, - "response": [] - }, - { - "name": "List Validation Rule Assignments", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Validation Rule Assignments\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-validation-rule-assignments" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Validation Rules Assignments", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Validation Rules Assignments\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-validation-rule-assignment" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Validation Rule Assignment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Validation Rule Assignment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabb\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-validation-rule-assignment" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Segments API", - "item": [ - { - "name": "Customer Segment Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Customer Segment Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "customer-segment-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Segment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Segment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-segment" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Segment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Segment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-segment" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Segment", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Segment\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabc\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-segment" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Events API", - "item": [ - { - "name": "Custom Event Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Custom Event Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabd\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "custom-event-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Track Custom Event", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Track Custom Event\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabd\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "track-custom-event" - } - ] - } - }, - "response": [] - }, - { - "name": "Track Custom Event (client-side)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Track Custom Event (client-side)\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabd\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "track-custom-event-client-side" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Consents API", - "item": [ - { - "name": "Consents Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Consents Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabe\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "consents-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Consents", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Consents\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabe\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-consents" - } - ] - } - }, - "response": [] - }, - { - "name": "List Consents (client-side)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Consents (client-side)\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabe\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-consents-client-side" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Async Actions API", - "item": [ - { - "name": "Async Action Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Async Action Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "async-action-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Async Actions", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Async Actions\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-async-actions" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Async Action", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Async Action\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fabf\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-async-action" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Exports API", - "item": [ - { - "name": "Export Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Export Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "export-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Exports", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Exports\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-exports" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Export", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Export\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-export" - } - ] - } - }, - "response": [] - }, - { - "name": "Download Export", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Download Export\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "download-export" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Export", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Export\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-export" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Export", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Export\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac0\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-export" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Categories API", - "item": [ - { - "name": "Category Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Category Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "category-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Categories", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Categories\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-categories" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Category", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Category\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-category" - } - ] - } - }, - "response": [] - }, - { - "name": "Create Category", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Create Category\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "create-category" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Category", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Update Category\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "update-category" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Category", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Delete Category\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac1\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "delete-category" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Metadata Schemas API", - "item": [ - { - "name": "Metadata Schema Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Metadata Schema Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac2\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "metadata-schema-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Metadata Schemas", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Metadata Schemas\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac2\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-metadata-schemas" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Metadata Schema", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Metadata Schema\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"639ba2658407100061f5fac2\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-metadata-schema" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Locations API", - "item": [ - { - "name": "Location Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Location Object\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"64d0e09b5a917a1254315da7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "location-object" - } - ] - } - }, - "response": [] - }, - { - "name": "List Locations", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"List Locations\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"64d0e09b5a917a1254315da7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "list-locations" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Location", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Get Location\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"64d0e09b5a917a1254315da7\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "get-location" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Qualifications API", - "item": [ - { - "name": "Qualification Object", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Qualification Object [Beta]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"64d0e09b5a917a1254315da8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "qualification-object" - } - ] - } - }, - "response": [] - }, - { - "name": "Examine Qualification [Beta]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Check Eligibility [Beta]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"64d0e09b5a917a1254315da8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "check-eligibility" - } - ] - } - }, - "response": [] - }, - { - "name": "Examine Qualification (client-side) [Beta]", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Check Eligibility (client-side) [Beta]\",\n \"category\": \"639ba2628407100061f5faac\",\n \"parentDoc\": \"64d0e09b5a917a1254315da8\",\n \"type\": \"endpoint\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "check-eligibility-client-side" - } - ] - } - }, - "response": [] - } - ] - } - ], - "auth": { - "type": "basic", - "basic": [ - { - "key": "username", - "value": "{{u}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "username", - "value": "", - "type": "string", - "disabled": true - }, - { - "key": "password", - "value": "", - "type": "string", - "disabled": true - }, - { - "key": "u", - "value": "", - "type": "string" - } - ] -} \ No newline at end of file diff --git a/automation/Readme-Voucherify-Docs-Guides.postman_collection.json b/automation/Readme-Voucherify-Docs-Guides.postman_collection.json deleted file mode 100644 index 456771a6d..000000000 --- a/automation/Readme-Voucherify-Docs-Guides.postman_collection.json +++ /dev/null @@ -1,2095 +0,0 @@ -{ - "info": { - "_postman_id": "6d68eb46-6ebf-427d-8937-60176d4b0354", - "name": "Readme - Voucherify Docs - Guides", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "18603863", - "_collection_link": "https://crimson-zodiac-829239.postman.co/workspace/Voucherify-Testing~59bed91e-93d8-4799-9838-b01ffcc9f6f8/collection/18603863-6d68eb46-6ebf-427d-8937-60176d4b0354?action=share&source=collection_link&creator=18603863" - }, - "item": [ - { - "name": "Getting Started", - "item": [ - { - "name": "Introduction", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Home\",\n \"category\": \"639ba16d677235008f80043f\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "introduction" - } - ] - } - }, - "response": [] - }, - { - "name": "Quickstart", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Quickstart\",\n \"category\": \"639ba16d677235008f80043f\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "quickstart" - } - ] - } - }, - "response": [] - }, - { - "name": "Integration checklist", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Integration checklist\",\n \"category\": \"639ba16d677235008f80043f\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "welcome" - } - ] - } - }, - "response": [] - }, - { - "name": "Key concepts", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Key concepts\",\n \"category\": \"639ba16d677235008f80043f\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "key-concepts" - } - ] - } - }, - "response": [] - }, - { - "name": "Authentication", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Authentication\",\n \"category\": \"639ba16d677235008f80043f\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "authentication" - } - ] - } - }, - "response": [] - }, - { - "name": "API Endpoints", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"API Endpoints\",\n \"category\": \"639ba16d677235008f80043f\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "api-endpoints" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Development", - "item": [ - { - "name": "Security", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Security\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "security" - } - ] - } - }, - "response": [] - }, - { - "name": "Examples", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Examples\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "examples" - } - ] - } - }, - "response": [] - }, - { - "name": "API Reference", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"API Reference\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "api-reference" - } - ] - } - }, - "response": [] - }, - { - "name": "Error Codes", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Error Codes\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "error-codes" - } - ] - } - }, - "response": [] - }, - { - "name": "SDKs", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"SDKs\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "sdks" - } - ] - } - }, - "response": [] - }, - { - "name": "Test mode (Sandbox)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Test mode (Sandbox)\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "testing" - } - ] - } - }, - "response": [] - }, - { - "name": "Client-side API", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Client-side API\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "client-side-api" - } - ] - } - }, - "response": [] - }, - { - "name": "Limits", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Limits\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "limits" - } - ] - } - }, - "response": [] - }, - { - "name": "Performance", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Performance\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "performance" - } - ] - } - }, - "response": [] - }, - { - "name": "API Version Upgrades", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"API Version Upgrades\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "api-version-upgrades" - } - ] - } - }, - "response": [] - }, - { - "name": "Troubleshooting", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Troubleshooting\",\n \"category\": \"639ba16d677235008f800447\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "troubleshooting" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Building Blocks", - "item": [ - { - "name": "Redemption", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Redemption\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "redemption" - } - ] - } - }, - "response": [] - }, - { - "name": "Customers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Customers\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "customers" - } - ] - } - }, - "response": [] - }, - { - "name": "Products", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Products\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "products" - } - ] - } - }, - "response": [] - }, - { - "name": "Orders", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Orders\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "orders" - } - ] - } - }, - "response": [] - }, - { - "name": "Validation Rules", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Validation Rules\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "validation-rules" - } - ] - } - }, - "response": [] - }, - { - "name": "Campaigns", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Campaigns\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "campaigns" - } - ] - } - }, - "response": [] - }, - { - "name": "Vouchers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Vouchers\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "vouchers" - } - ] - } - }, - "response": [] - }, - { - "name": "Promotion Tier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Promotion Tier\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 8\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "promotion-tier" - } - ] - } - }, - "response": [] - }, - { - "name": "Distribution", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Distribution\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 9\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "distribution" - } - ] - } - }, - "response": [] - }, - { - "name": "Earning Rules", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Earning Rules\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 10\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "earning-rules" - } - ] - } - }, - "response": [] - }, - { - "name": "Rewards", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Rewards\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 11\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "rewards" - } - ] - } - }, - "response": [] - }, - { - "name": "Webhooks", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Webhooks\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 12\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "webhooks" - } - ] - } - }, - "response": [] - }, - { - "name": "Metadata (custom fields)", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Metadata (custom fields)\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 13\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "metadata-custom-fields" - } - ] - } - }, - "response": [] - }, - { - "name": "Formula Builder", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Formula Builder\",\n \"category\": \"639ba16d677235008f800454\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 14\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "formula-builder" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Campaigns Recipes", - "item": [ - { - "name": "Qualification - Checking eligibility", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Qualification - Checking eligibility\",\n \"category\": \"639ba16d677235008f80045c\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "checking-eligibility" - } - ] - } - }, - "response": [] - }, - { - "name": "Locking Validation Session", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Locking Validation Session\",\n \"category\": \"639ba16d677235008f80045c\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "locking-validation-session" - } - ] - } - }, - "response": [] - }, - { - "name": "Referral Program", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Referral Program\",\n \"category\": \"639ba16d677235008f80045c\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "referral-program" - } - ] - } - }, - "response": [] - }, - { - "name": "Prepaid Gift Cards", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Prepaid Gift Cards\",\n \"category\": \"639ba16d677235008f80045c\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "prepaid-gift-cards" - } - ] - } - }, - "response": [] - }, - { - "name": "Loyalty Program", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Loyalty Program\",\n \"category\": \"639ba16d677235008f80045c\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "loyalty-program" - } - ] - } - }, - "response": [] - }, - { - "name": "Transfer Loyalty Points", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Transfer Loyalty Points\",\n \"category\": \"639ba16d677235008f80045c\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 6\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "transfer-loyalty-points" - } - ] - } - }, - "response": [] - }, - { - "name": "Stacking Promotion Tiers", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Stacking Promotion Tiers\",\n \"category\": \"639ba16d677235008f80045c\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 7\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "stacking-promotion-tiers" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Discounts Recipes", - "item": [ - { - "name": "Stackable discounts API", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Stackable discounts API\",\n \"category\": \"639ba16d677235008f80045e\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "manage-stackable-discounts" - } - ] - } - }, - "response": [] - }, - { - "name": "Discount Effects", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Discount Effects\",\n \"category\": \"639ba16d677235008f80045e\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "discount-effects" - } - ] - } - }, - "response": [] - }, - { - "name": "Product-specific discounts", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Product-specific discounts\",\n \"category\": \"639ba16d677235008f80045e\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "discount-for-particular-product" - } - ] - } - }, - "response": [] - }, - { - "name": "Free shipping discount", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Free shipping discount\",\n \"category\": \"639ba16d677235008f80045e\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "free-shipping-discount" - } - ] - } - }, - "response": [] - }, - { - "name": "Give item(s) for free - unit discount", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Give item(s) for free - unit discount\",\n \"category\": \"639ba16d677235008f80045e\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 5\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "give-item-for-free-unit-discount" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Distributions Recipes", - "item": [ - { - "name": "Geofencing", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Geofencing\",\n \"category\": \"639ba16d677235008f80045d\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "geofencing" - } - ] - } - }, - "response": [] - }, - { - "name": "CSV export with API", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"CSV export with API\",\n \"category\": \"639ba16d677235008f80045d\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "csv-export" - } - ] - } - }, - "response": [] - }, - { - "name": "Import legacy codes", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Import legacy codes\",\n \"category\": \"639ba16d677235008f80045d\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "import-codes" - } - ] - } - }, - "response": [] - }, - { - "name": "Messaging automation", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Messaging automation\",\n \"category\": \"639ba16d677235008f80045d\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 4\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "automatic-delivery" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "More", - "item": [ - { - "name": "Support", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Support\",\n \"category\": \"639ba16d677235008f800441\",\n \"type\": \"basic\",\n \"hidden\": false,\n \"order\": 1\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "support" - } - ] - } - }, - "response": [] - }, - { - "name": "Roadmap", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Roadmap\",\n \"category\": \"639ba16d677235008f800441\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 2\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "roadmap" - } - ] - } - }, - "response": [] - }, - { - "name": "Status", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - }, - { - "key": "x-readme-version", - "value": "{{x-readme-version}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"title\": \"Status\",\n \"category\": \"639ba16d677235008f800441\",\n \"type\": \"link\",\n \"hidden\": false,\n \"order\": 3\n}" - }, - "url": { - "raw": "{{baseUrl}}/v1/docs/:slug", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "docs", - ":slug" - ], - "variable": [ - { - "key": "slug", - "value": "status" - } - ] - } - }, - "response": [] - } - ] - } - ], - "auth": { - "type": "basic", - "basic": [ - { - "key": "username", - "value": "{{u}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "username", - "value": "", - "type": "string", - "disabled": true - }, - { - "key": "password", - "value": "", - "type": "string", - "disabled": true - }, - { - "key": "u", - "value": "", - "type": "string" - } - ] -} \ No newline at end of file diff --git a/docs/reference-docs/ASYNC-ACTIONS-API-Async-Action-Object.md b/docs/reference-docs/ASYNC-ACTIONS-API-Async-Action-Object.md index 6966970ea..e1d5b6e68 100644 --- a/docs/reference-docs/ASYNC-ACTIONS-API-Async-Action-Object.md +++ b/docs/reference-docs/ASYNC-ACTIONS-API-Async-Action-Object.md @@ -1,6 +1,6 @@ --- title: Async Action Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: async-actions-api slug: async-action-object @@ -8,18 +8,145 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |
Async action unique ID.
|aa_0adad13d6f057f088e
| -| type |Type of async action.
Available values: `CAMPAIGN.VOUCHERS_IMPORT`, `CAMPAIGN.VOUCHERS_IMPORT_CSV`, `CAMPAIGN.VOUCHERS_UPDATE`, `CAMPAIGN.VOUCHERS_DELETE`, `CAMPAIGN.VOUCHERS_GENERATE`, `CAMPAIGNS.METADATA_KEY_PURGE`, `CUSTOMERS.IMPORT_CSV`, `CUSTOMERS.BULK_UPDATE`, `CUSTOMERS.METADATA_UPDATE`, `CUSTOMERS.METADATA_KEY_PURGE`, `PRODUCTS.BULK_UPDATE`, `PRODUCTS.METADATA_UPDATE`, `PRODUCTS.METADATA_KEY_PURGE`, `PRODUCTS.IMPORT_CSV`, `SKUS.IMPORT_CSV`, `VOUCHERS.IMPORT`, `VOUCHERS.IMPORT_CSV`, `VOUCHERS.BULK_UPDATE`, `VOUCHERS.METADATA_UPDATE`, `VOUCHERS.METADATA_KEY_PURGE`, `ORDERS.IMPORT`, `ORDERS.METADATA_KEY_PURGE` | | -| status |Status of async action. Informs you whether the async action has already been completed.
Available values: `ENQUEUED`, `IN_PROGRESS`, `DONE`, `FAILED` | | -| result | Any of:Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | ||||||||||
failed | If any records failed during the process, this array shows the failure details. Array of:
| ||||||||||
done_count | Number of resources processed successfully. | ||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | |||||||||||||
failed | If any records failed during the process, this array shows the failure details. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. | |||||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources processed successfully. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources processed successfully. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources processed successfully. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources processed successfully. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | |||||||||||||
failed | If any records failed during the process, this array shows the failure details. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. | |||||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
results | An array of statuses for each record. Array of:
| |||||||||||||
done_count | Number or resources processed successfully. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
results | An array of statuses for each record. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources processed successfully. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
results | An array of statuses for each record. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
results | An array of statuses for each record. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. |
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | ||||||||||
failed | If any records failed during the process, this array shows the failure details. Array of:
| ||||||||||
done_count | Number of resources processed successfully. | ||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | 2 sku(s) imported successfully, 6 failed. | |||||||||
failed | If any records failed during the process, this array shows the failure details. Array of:
| ||||||||||
done_count | Number of resources processed successfully. | ||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources updated successfully. |
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | ||||||||||
failed | If any records failed during the process, this array shows the failure details.
| ||||||||||
done_count | Number of resources processed successfully. | ||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | |||||||||||||
failed | If any records failed during the process, this array shows the failure details. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. | |||||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
results | An array of statuses for each record. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
results | An array of statuses for each record. Array of:
| |||||||||||||
done_count | Number of resources processed successfully. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources processed successfully. |
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
message | A human-readable message providing a short description about the result. | ||||||||||
failed | If any records failed during the process, this array shows the failure details.
| ||||||||||
done_count | Number of resources processed successfully. | ||||||||||
failed_count | Number of resources failed to process. |
Attributes | Description | Example |
---|---|---|
message | A human-readable message providing a short description about the result. | |
done_count | Number of resources processed successfully. |
Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.
|2022-06-23T11:21:45.578Z
| -| updated_at |Timestamp representing the date and time when the async action was updated in ISO 8601 format.
|2022-06-23T11:21:46.795Z
| -| request_id |Unique request ID.
|v-0b45cee140c3c9b5ca
| -| processing_time |The length of time it took to process the request in milliseconds.
|1217
| -| progress |% progress to completion of the asynchronous action.
| | -| object |The type of object represented by JSON. This object stores information about the async_action
.
Async action unique ID.
**Example:**aa_0adad13d6f057f088e
| +| type`string` |Type of async action.
Available values: `CAMPAIGN.VOUCHERS_IMPORT`, `CAMPAIGN.VOUCHERS_IMPORT_CSV`, `CAMPAIGN.VOUCHERS_UPDATE`, `CAMPAIGN.VOUCHERS_DELETE`, `CAMPAIGN.VOUCHERS_GENERATE`, `CAMPAIGNS.METADATA_KEY_PURGE`, `CUSTOMERS.IMPORT_CSV`, `CUSTOMERS.BULK_UPDATE`, `CUSTOMERS.METADATA_UPDATE`, `CUSTOMERS.METADATA_KEY_PURGE`, `PRODUCTS.BULK_UPDATE`, `PRODUCTS.METADATA_UPDATE`, `PRODUCTS.METADATA_KEY_PURGE`, `PRODUCTS.IMPORT_CSV`, `SKUS.IMPORT_CSV`, `VOUCHERS.IMPORT`, `VOUCHERS.IMPORT_CSV`, `VOUCHERS.BULK_UPDATE`, `VOUCHERS.METADATA_UPDATE`, `VOUCHERS.METADATA_KEY_PURGE`, `ORDERS.IMPORT`, `ORDERS.METADATA_KEY_PURGE` | +| status`string` |Status of async action. Informs you whether the async action has already been completed.
Available values: `ENQUEUED`, `IN_PROGRESS`, `DONE`, `FAILED` | +| result | Any of: [CAMPAIGN.VOUCHERS_IMPORT](#campaign.vouchers_import), [CAMPAIGN.VOUCHERS_IMPORT_CSV](#campaign.vouchers_import_csv), [CAMPAIGN.VOUCHERS_UPDATE](#campaign.vouchers_update), [CAMPAIGN.VOUCHERS_DELETE](#campaign.vouchers_delete), [CAMPAIGN.VOUCHERS_GENERATE](#campaign.vouchers_generate), [CAMPAIGNS.METADATA_KEY_PURGE](#campaigns.metadata_key_purge), [CUSTOMERS.IMPORT_CSV](#customers.import_csv), [CUSTOMERS.BULK_UPDATE](#customers.bulk_update), [CUSTOMERS.METADATA_UPDATE](#customers.metadata_update), [CUSTOMERS.METADATA_KEY_PURGE](#customers.metadata_key_purge), [PRODUCTS.BULK_UPDATE](#products.bulk_update), [PRODUCTS.METADATA_UPDATE](#products.metadata_update), [PRODUCTS.IMPORT_CSV](#products.import_csv), [SKUS.IMPORT_CSV](#skus.import_csv), [PRODUCTS.METADATA_KEY_PURGE](#products.metadata_key_purge), [VOUCHERS.IMPORT](#vouchers.import), [VOUCHERS.IMPORT_CSV](#vouchers.import_csv), [VOUCHERS.BULK_UPDATE](#vouchers.bulk_update), [VOUCHERS.METADATA_UPDATE](#vouchers.metadata_update), [VOUCHERS.METADATA_KEY_PURGE](#vouchers.metadata_key_purge), [ORDERS.IMPORT](#orders.import), [ORDERS.METADATA_KEY_PURGE](#orders.metadata_key_purge) | +| created_at`string` |Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.
**Example:**2022-06-23T11:21:45.578Z
| +| updated_at`string` |Timestamp representing the date and time when the async action was updated in ISO 8601 format.
**Example:**2022-06-23T11:21:46.795Z
| +| request_id`string` |Unique request ID.
**Example:**v-0b45cee140c3c9b5ca
| +| processing_time`integer` |The length of time it took to process the request in milliseconds.
**Example:**1217
| +| progress`integer` |% progress to completion of the asynchronous action.
| +| object`string` |The type of object represented by JSON. This object stores information about the async_action
.
A human-readable message providing a short description about the result.
| +| failed`array` |If any records failed during the process, this array shows the failure details.
Array of:Attributes | Description |
---|---|
codestring | Unique voucher code. |
reasonstring | Detailed failure cause for the voucher code import. |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## CAMPAIGN.VOUCHERS_IMPORT_CSV +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| failed`array` |If any records failed during the process, this array shows the failure details.
Array of:Attributes | Description |
---|---|
codestring | Unique voucher code. |
rowinteger | The CSV file row number where the code definition is recorded. The row counter excludes the file headers row. |
reasonstring | Detailed failure cause for the voucher code import. |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## CAMPAIGN.VOUCHERS_UPDATE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources processed successfully.
| +## CAMPAIGN.VOUCHERS_DELETE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources processed successfully.
| +## CAMPAIGN.VOUCHERS_GENERATE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources processed successfully.
| +## CAMPAIGNS.METADATA_KEY_PURGE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources processed successfully.
| +## CUSTOMERS.IMPORT_CSV +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| failed`array` |If any records failed during the process, this array shows the failure details.
Array of:Attributes | Description |
---|---|
source_idstring | Unique customer ID from your inventory system as indicated in the CSV file. |
rowinteger | The CSV file row number where the customer is recorded. The row counter excludes the file headers row. |
reasonstring | Detailed failure cause for the customer import. |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## CUSTOMERS.BULK_UPDATE +| Attributes | Description | +|:-----|:--------| +| results`array` |An array of statuses for each record.
Array of:Attributes | Description |
---|---|
source_idstring | Unique customer |
updatedboolean | Indicates whether the record was updated. |
foundboolean | Indicates whether the record was found. |
Number or resources processed successfully.
| +## CUSTOMERS.METADATA_UPDATE +| Attributes | Description | +|:-----|:--------| +| results`array` |An array of statuses for each record.
Array of:Attributes | Description |
---|---|
source_idstring | Unique customer |
updatedboolean | Indicates whether the record was updated. |
foundboolean | Indicates whether the record was found. |
Number of resources processed successfully.
| +## CUSTOMERS.METADATA_KEY_PURGE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources processed successfully.
| +## PRODUCTS.BULK_UPDATE +| Attributes | Description | +|:-----|:--------| +| results`array` |An array of statuses for each record.
Array of:Attributes | Description |
---|---|
source_idstring | Unique product |
updatedboolean | Indicates whether the record was updated. |
foundboolean | Indicates whether the record was found. |
Number of resources processed successfully.
| +## PRODUCTS.METADATA_UPDATE +| Attributes | Description | +|:-----|:--------| +| results`array` |An array of statuses for each record.
Array of:Attributes | Description |
---|---|
source_idstring | Unique product |
updatedboolean | Indicates whether the record was updated. |
foundboolean | Indicates whether the record was found. |
Number of resources processed successfully.
| +## PRODUCTS.IMPORT_CSV +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| failed`array` |If any records failed during the process, this array shows the failure details.
Array of:Attributes | Description |
---|---|
rowinteger | The CSV file row number where the product definition is recorded. The row counter excludes the file headers row. |
reasonstring | Detailed failure cause for the product import. |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## SKUS.IMPORT_CSV +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
**Example:**2 sku(s) imported successfully, 6 failed.
| +| failed`array` |If any records failed during the process, this array shows the failure details.
Array of:Attributes | Description |
---|---|
rowinteger | The CSV file row number where the SKU definition is recorded. The row counter excludes the file headers row. Example:2 |
reasonstring | Detailed failure cause for the SKU import. Example:Resource sku with id size-small is in use by products with ids [prod_0b0e3441c2462eff2c] |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## PRODUCTS.METADATA_KEY_PURGE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources updated successfully.
| +## VOUCHERS.IMPORT +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| failed`object` |If any records failed during the process, this array shows the failure details.
Attributes | Description |
---|---|
codestring | Unique voucher code. |
reasonstring | Detailed failure cause for the voucher code import. |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## VOUCHERS.IMPORT_CSV +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| failed`array` |If any records failed during the process, this array shows the failure details.
Array of:Attributes | Description |
---|---|
codestring | Unique voucher code. |
rowinteger | The CSV file row number where the code definition is recorded. The row counter excludes the file headers row. |
reasonstring | Detailed failure cause for the voucher code import. |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## VOUCHERS.BULK_UPDATE +| Attributes | Description | +|:-----|:--------| +| results`array` |An array of statuses for each record.
Array of:Attributes | Description |
---|---|
codestring | Unique voucher code. |
updatedboolean | Indicates whether the record was updated. |
foundboolean | Indicates whether the record was found. |
Number of resources processed successfully.
| +## VOUCHERS.METADATA_UPDATE +| Attributes | Description | +|:-----|:--------| +| results`array` |An array of statuses for each record.
Array of:Attributes | Description |
---|---|
codestring | Unique voucher code. |
updatedboolean | Indicates whether the record was updated. |
foundboolean | Indicates whether the record was found. |
Number of resources processed successfully.
| +## VOUCHERS.METADATA_KEY_PURGE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources processed successfully.
| +## ORDERS.IMPORT +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| failed`object` |If any records failed during the process, this array shows the failure details.
Attributes | Description |
---|---|
source_idstring | Unique order source ID. |
reasonstring | Detailed failure cause for the voucher code import. |
Number of resources processed successfully.
| +| failed_count`integer` |Number of resources failed to process.
| +## ORDERS.METADATA_KEY_PURGE +| Attributes | Description | +|:-----|:--------| +| message`string` |A human-readable message providing a short description about the result.
| +| done_count`integer` |Number of resources processed successfully.
| [block:html] { diff --git a/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md b/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md index ab8faa8ba..665f31e60 100644 --- a/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md +++ b/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md @@ -1,6 +1,6 @@ --- title: Campaign Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: campaigns-api slug: campaign-object @@ -8,37 +8,198 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique campaign ID, assigned by Voucherify.
|camp_f7fBbQxUuTN7dI7tGOo5XMDA
| -| name |Campaign name.
| | -| description |An optional field to keep any extra textual information about the campaign such as a campaign description and details.
| | -| campaign_type |Type of campaign.
Available values: `LOYALTY_PROGRAM`, `GIFT_VOUCHERS`, `DISCOUNT_COUPONS`, `PROMOTION`, `REFERRAL_PROGRAM`, `LUCKY_DRAW` | | -| type |Defines whether the campaign can be updated with new vouchers after campaign creation.
AUTO_UPDATE
: the campaign is dynamic, i.e. vouchers will generate based on set criteriaSTATIC
: vouchers need to be manually publishedAttributes | Description | Example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | Type of voucher. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | Defines the voucher discount type and details. One of:Amount
Percentage
Fixed
Unit, single item
Unit, multiple items
Shipping
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redemption | Defines the redemption limits on vouchers.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
code_config | Defines code's pattern (prefix, suffix, length, charset, etc).
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_referral_code | Indicates whether the voucher is a referral code; this is |
Attributes | Description | Example | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | Type of voucher. | |||||||||||||||||||
gift | Defines the gift card details.
| |||||||||||||||||||
redemption | Defines the redemption limits on vouchers.
| |||||||||||||||||||
code_config | Defines code's pattern (prefix, suffix, length, charset, etc).
| |||||||||||||||||||
is_referral_code | Indicates whether the voucher is a referral code; this is |
Attributes | Description | Example | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | Type of voucher. | ||||||||||||||||||||||
loyalty_card | Defines the loyalty card details.
| ||||||||||||||||||||||
redemption | Defines the redemption limits on vouchers.
| ||||||||||||||||||||||
code_config | Defines code's pattern (prefix, suffix, length, charset, etc).
| ||||||||||||||||||||||
is_referral_code | Indicates whether the voucher is a referral code; this is |
Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
| | -| join_once |If this value is set to true
, customers will be able to join the campaign only once.
Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
| | -| validity_timeframe |Set recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description | Example |
---|---|---|
interval | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a campaign with an | |
duration | Defines the amount of time the campaign will be active in ISO 8601 format. For example, a campaign with a |
Integer array corresponding to the particular days of the week in which the campaign is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayDefines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a duration
of P24D
will be valid for a duration of 24 days.
Total number of unique vouchers in campaign.
| | -| start_date |Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
|2022-09-20T00:00:00.000Z
| -| expiration_date |Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
|2022-09-30T00:00:00.000Z
| -| active |A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active campaignfalse
indicates an inactive campaignThe metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
| | -| created_at |Timestamp representing the date and time when the campaign was created in ISO 8601 format.
|2021-12-01T08:00:50.038Z
| -| updated_at |Timestamp representing the date and time when the voucher was updated in ISO 8601 format.
|2022-09-20T09:18:19.623Z
| -| category |Unique category name.
| | -| creation_status |Indicates the status of the campaign creation.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT`, `MODIFYING` | | -| vouchers_generation_status |Indicates the status of the campaign's vouchers.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT` | | -| protected |Indicates whether the resource can be deleted.
| | -| category_id |Unique category ID that this campaign belongs to.
|cat_0b688929a2476386a7
| -| categories | | | -| object |The type of object represented by JSON. This object stores information about the campaign.
| | -| referral_program |Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM
.
Attributes | Description | Example | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
conversion_event_type | How a referral is triggered. Available values:redemption , custom_event | |||||||||||||||||||||||||
custom_event | Contains details about the custom event.
| |||||||||||||||||||||||||
referee_reward | Defines the referee reward.
|
Defines the expiration mechanism for loyalty tiers.
Any of:Attributes | Description | Example | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
qualification_type | Tier qualification.
BALANCE | |||||||||||||||||||||||||||||||||||||||||||
start_date | Defines the conditions for the start date of the tier.
| |||||||||||||||||||||||||||||||||||||||||||
expiration_date | Defines the conditions for the expiration date of a tier. Any of:Balance Drop
Custom
|
Attributes | Description | Example | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
qualification_type | Tier qualification.
POINTS_IN_PERIOD | |||||||||||
qualification_period | Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.
MONTH , QUARTER , HALF_YEAR , YEAR | |||||||||||
start_date | Defines the conditions for the start date of the tier.
| |||||||||||
expiration_date | Defines the conditions for the expiration date of a tier.
|
Unique campaign ID, assigned by Voucherify.
**Example:**camp_f7fBbQxUuTN7dI7tGOo5XMDA
| +| name`string` |Campaign name.
| +| description`string` |An optional field to keep any extra textual information about the campaign such as a campaign description and details.
| +| campaign_type`string` |Type of campaign.
Available values: `LOYALTY_PROGRAM`, `GIFT_VOUCHERS`, `DISCOUNT_COUPONS`, `PROMOTION`, `REFERRAL_PROGRAM`, `LUCKY_DRAW` | +| type`string` |Defines whether the campaign can be updated with new vouchers after campaign creation.
AUTO_UPDATE
: the campaign is dynamic, i.e. vouchers will generate based on set criteriaSTATIC
: vouchers need to be manually publishedIndicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
| +| join_once`boolean` |If this value is set to true
, customers will be able to join the campaign only once.
Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
| +| validity_timeframe`object` |Set recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description |
---|---|
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a campaign with an |
durationstring | Defines the amount of time the campaign will be active in ISO 8601 format. For example, a campaign with a |
Integer array corresponding to the particular days of the week in which the campaign is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayDefines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a duration
of P24D
will be valid for a duration of 24 days.
Total number of unique vouchers in campaign.
| +| start_date`string` |Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
**Example:**2022-09-20T00:00:00.000Z
| +| expiration_date`string` |Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
**Example:**2022-09-30T00:00:00.000Z
| +| active`boolean` |A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active campaignfalse
indicates an inactive campaignThe metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
| +| created_at`string` |Timestamp representing the date and time when the campaign was created in ISO 8601 format.
**Example:**2021-12-01T08:00:50.038Z
| +| updated_at`string` |Timestamp representing the date and time when the voucher was updated in ISO 8601 format.
**Example:**2022-09-20T09:18:19.623Z
| +| category`string` |Unique category name.
| +| creation_status`string` |Indicates the status of the campaign creation.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT`, `MODIFYING` | +| vouchers_generation_status`string` |Indicates the status of the campaign's vouchers.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT` | +| protected`boolean` |Indicates whether the resource can be deleted.
| +| category_id`string` |Unique category ID that this campaign belongs to.
**Example:**cat_0b688929a2476386a7
| +| categories | See: [Category Object](#category-object) | +| object`string` |The type of object represented by JSON. This object stores information about the campaign.
| +| referral_program`object` |Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM
.
Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
conversion_event_typestring | How a referral is triggered. Available values:redemption , custom_event | ||||||||||||||||
custom_eventobject | Contains details about the custom event.
| ||||||||||||||||
referee_rewardobject | Defines the referee reward.
|
Defines the expiration mechanism for loyalty tiers.
Any of: [Balance](#balance), [Points in Period](#points-in-period) | +## Discount Voucher +| Attributes | Description | +|:-----|:--------| +| type`string` |Type of voucher.
| +| discount |Defines the voucher discount type and details.
One of: [Amount](#amount), [Percentage](#percentage), [Fixed](#fixed), [Unit, single item](#unit-single-item), [Unit, multiple items](#unit-multiple-items), [Shipping](#shipping) | +| redemption`object` |Defines the redemption limits on vouchers.
Attributes | Description |
---|---|
quantityinteger | How many times a voucher can be redeemed. A |
Defines code's pattern (prefix, suffix, length, charset, etc).
Attributes | Description |
---|---|
lengthstring | Number of characters in a generated code (excluding prefix and postfix). |
charsetstring | Characters that can appear in the code. Examples:
|
prefixstring | A text appended before the code. |
postfixstring | A text appended after the code. |
patternstring | A pattern for codes where hashes (#) will be replaced with random characters. Overrides |
Indicates whether the voucher is a referral code; this is true
for campaign type REFERRAL_PROGRAM
.
Type of voucher.
| +| gift`object` |Defines the gift card details.
Attributes | Description |
---|---|
amountinteger | Initial gift card income to be applied to the gift card at voucher generation. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. |
effectstring | Defines how the credits are applied to the customer's order. Available values:APPLY_TO_ORDER , APPLY_TO_ITEMS |
Defines the redemption limits on vouchers.
Attributes | Description |
---|---|
quantityinteger | How many times a voucher can be redeemed. A |
Defines code's pattern (prefix, suffix, length, charset, etc).
Attributes | Description |
---|---|
lengthstring | Number of characters in a generated code (excluding prefix and postfix). |
charsetstring | Characters that can appear in the code. Examples:
|
prefixstring | A text appended before the code. |
postfixstring | A text appended after the code. |
patternstring | A pattern for codes where hashes (#) will be replaced with random characters. Overrides |
Indicates whether the voucher is a referral code; this is true
for campaign type REFERRAL_PROGRAM
.
Type of voucher.
| +| loyalty_card`object` |Defines the loyalty card details.
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
pointsinteger | Initial loyalty card income in points to be applied to the loyalty card at voucher generation. | ||||||||
expiration_rulesobject | Defines point expiration rules.
|
Defines the redemption limits on vouchers.
Attributes | Description |
---|---|
quantityinteger | How many times a voucher can be redeemed. A |
Defines code's pattern (prefix, suffix, length, charset, etc).
Attributes | Description |
---|---|
lengthstring | Number of characters in a generated code (excluding prefix and postfix). |
charsetstring | Characters that can appear in the code. Examples:
|
prefixstring | A text appended before the code. |
postfixstring | A text appended after the code. |
patternstring | A pattern for codes where hashes (#) will be replaced with random characters. Overrides |
Indicates whether the voucher is a referral code; this is true
for campaign type REFERRAL_PROGRAM
.
Unique category ID assigned by Voucherify.
| +| name`string` |Category name.
| +| hierarchy`integer` |Category hierarchy.
| +| created_at`string` |Timestamp representing the date and time when the category was created in ISO 8601 format.
**Example:**2022-07-14T10:45:13.156Z
| +| updated_at`string` |Timestamp representing the date and time when the category was updated in ISO 8601 format.
**Example:**2022-08-16T10:52:08.094Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the category.
| +## Promotion Tiers +| Attributes | Description | +|:-----|:--------| +| object`string` |The type of object represented by JSON. This object stores information about promotion tiers in a dictionary.
| +| data_ref`string` |Identifies the name of the attribute that contains the array of promotion tier objects.
| +| tiers`array` |Contains array of promotion tier objects.
Array of [Promotion Tier Object](#promotion-tier-object) | +| total`integer` |Total number of promotion tiers.
| +| has_more`boolean` |As query results are always limited (by the limit parameter), the has_more
flag indicates whether there are more records for given filter parameters. This let's you know if you are able to run another request (with a different page or a different start date filter) to get more records returned in the results.
Tier qualification.
BALANCE
: Points balance is based on the customer's current points balance. Customers qualify for the tier if their points balance is in the points range of the tier.
Defines the conditions for the start date of the tier.
Attributes | Description |
---|---|
typestring | What triggers the tier to be valid for a customer. IMMEDIATE |
Defines the conditions for the expiration date of a tier.
Any of: [Balance Drop](#balance-drop), [Custom](#custom) | +## Points in Period +| Attributes | Description | +|:-----|:--------| +| qualification_type`string` |Tier qualification.
POINTS_IN_PERIOD
: A customer qualifies for the tier only if the sum of the accumulated points in a defined time interval reaches the tier threshold.
Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.
Period | Definition |
---|---|
Calendar Month | Points collected in one calendar month January, February, March, etc. |
Calendar Quarter | Points collected in the quarter - January - March - April - June - July - September - October - December |
Calendar Half-year | Points collected in the half-year - January - June - July - December |
Calendar Year | Points collected in one calendar year January - December |
Defines the conditions for the start date of the tier.
Attributes | Description |
---|---|
typestring | What triggers the tier to be valid for a customer. IMMEDIATE , NEXT_PERIOD |
Defines the conditions for the expiration date of a tier.
Attributes | Description |
---|---|
typestring | What triggers the tier to expire for a customer. END_OF_PERIOD , END_OF_NEXT_PERIOD |
extendstring | Extend the expiration by adding extra months or days in ISO 8601 format. The tier will remain active even though it reaches its expiration time period. For example, a tier with a duration of |
Applies an amount discount.
| +| amount_off`integer` |Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the amount being calculated by the formula, i.e. the amount_off_formula
parameter is present in the amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the amount off.
100
| +| amount_off_formula`string` |Formula used to calculate the discount.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects:
APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Defines how the discount is applied to the customer's order. The discount effects are defined as follows:
APPLY_TO_ORDER
(discount applies to the total order amount)APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_PROPORTIONALLY
(split discount proportionally to amount)APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY
(split discount proportionally to quantity)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Applies a percentage discount.
| +| amount_limit`string` |Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. This value is definable for the APPLY_TO_ITEMS
discount effect. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600.
Percent taken off the subtotal amount. In case of the percent being calculated by the formula, i.e. the percent_off_formula
parameter is present in the percent definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the percent off.
Formula used to calculate the discount.
| +| effect`string` |Defines how the discount is applied to the customer's order.
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | +## Fixed +| Attributes | Description | +|:-----|:--------| +| type`string` |Sets a fixed total on cart or item(s) and then calculates the discount to apply.
| +| fixed_amount`integer` |Set a fixed valued for an order total or price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the fixed amount being calculated by the formula, i.e. the fixed_amount_formula
parameter is present in the fixed amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.
1000
| +| fixed_amount_formula`string` |Formula used to calculate the discounted price of an item or a new order total.
| +| effect`string` |Effect | Definition |
---|---|
APPLY_TO_ORDER | Sets the order total amount to the value of the fixed amount. The discount value is calculated dynamically during the redemption as it's a difference between the total amount of the customer's order and the fixed amount. For example, if the fixed amount is set to equal $10 and the order amount equals $25, then the calculated discount will be $15. |
APPLY_TO_ITEMS | Sets a new price on items. The total discount amount is dynamically calculated during the redemption and it's a difference between the initial item price and the fixed amount. During the redemption, prices for items will change only if the new price is lower than the original price. If the new product price you set is different from the product price in a collection, then the new product price will be passed during the redemption. If a prodct is in more than one collection, the price is always changed to the lowest price. The new price for products with several SKUs will force the price change for SKUs if their original price is higher than the new price. |
Applies a full value discount to item(s).
| +| unit_off`number` |Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the unit_off_formula
parameter is present in the unit definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the unit value.
1
| +| unit_off_formula`string` |Formula used to calculate the number of units.
| +| unit_type`string` |The product deemed as free, chosen from the product inventory (e.g. time, items).
**Example:**prod_f1r5Tpr0DuC7
| +| effect`string` |Defines how the unit is added to the customer's order.
Available values: `ADD_NEW_ITEMS`, `ADD_MISSING_ITEMS` | +## Unit, multiple items +| Attributes | Description | +|:-----|:--------| +| type`string` |Applies a full value discount to item(s).
| +| effect`string` |Defines the effect for adding multiple item types.
| +| units`array` |Array of objects defining items to be offered for free. Each item type can have a different discount effect assigned.
Array of:Attributes | Description |
---|---|
unit_offinteger | Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the 1 |
unit_off_formulastring | Formula used to calculate the number of units. |
unit_typestring | The product deemed as free, chosen from the product inventory (e.g. time, items). Example:prod_f1r5Tpr0DuC7 |
effectstring | Defines how the unit is added to the customer's order. Available values:ADD_NEW_ITEMS , ADD_MISSING_ITEMS |
Applies a full value discount to item(s).
| +| unit_off`number` |Subtracts 1 shipping item from the subtotal.
| +| unit_type`string` |The shipping product deemed as free.
| +| effect`string` |Defines how the unit is added to the customer's order.
| +## Promotion Tier Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique promotion tier ID.
**Example:**promo_63fYCt81Aw0h7lzyRkrGZh9p
| +| created_at`string` |Timestamp representing the date and time when the promotion tier was created in ISO 8601 format.
**Example:**2021-12-15T11:34:01.333Z
| +| updated_at`string` |Timestamp representing the date and time when the promotion tier was updated in ISO 8601 format.
**Example:**2022-02-09T09:20:05.603Z
| +| name`string` |Name of the promotion tier.
| +| banner`string` |Text to be displayed to your customers on your website.
| +| action`object` |Contains details about the discount applied by the promotion tier.
Attributes | Description |
---|---|
discount | The type of discount that will be applied to a customer's order. Any of: Amount, Percentage, Fixed, Unit, single item, Unit, multiple items, Shipping |
The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.
| +| hierarchy`integer` |The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.
| +| campaign`object` |Contains details about promotion tier's parent campaign.
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
idstring | Unique campaign ID. | ||||||
start_datestring | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. Example:2022-09-22T00:00:00.000Z | ||||||
expiration_datestring | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. Example:2022-09-30T00:00:00.000Z | ||||||
validity_timeframeobject | Recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.
| ||||||
validity_day_of_weekarray | Integer array corresponding to the particular days of the week in which the campaign is valid.
| ||||||
activeboolean | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the
| ||||||
category_idstring | Unique category ID that this campaign belongs to. Example:cat_0b688929a2476386a6 | ||||||
objectstring | The type of object represented by the campaign object. This object stores information about the campaign. |
Promotion tier's parent campaign's unique ID.
| +| active`boolean` |A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active promotion tierfalse
indicates an inactive promotion tierActivation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.
**Example:**2022-09-23T00:00:00.000Z
| +| expiration_date`string` |Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.
**Example:**2022-09-26T00:00:00.000Z
| +| validity_timeframe`object` |Set recurrent time periods when the promotion tier is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description |
---|---|
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a promotion tier with an |
durationstring | Defines the amount of time the promotion tier will be active in ISO 8601 format. For example, a promotion tier with a |
Integer array corresponding to the particular days of the week in which the promotion tier is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayContains statistics about promotion tier redemptions and orders.
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
redemptionsobject | Contains statistics about promotion tier redemptions.
| ||||||
ordersobject | Contains statistics about orders related to the promotion tier.
|
The type of object represented by JSON. This object stores information about the promotion tier.
| +| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| category_id`string` |Promotion tier category ID.
**Example:**cat_0c9da30e7116ba6bba
| +| categories |Details about the category assigned to the promotion tier.
See: [Category Object](#category-object) | +## Balance Drop +| Attributes | Description | +|:-----|:--------| +| type`string` |What triggers the tier to expire for a customer.BALANCE_DROP
: Tier expires when the points balance drops below the required range of the tier.
What triggers the tier to expire for a customer.CUSTOM
: Tier expires after a certain time period passes following the instance the points balance drops below the required range of the tier.
Defines the amount of time the tier will remain active in ISO 8601 format. The expiration date counter starts at the moment when the customer reaches the minimum required points that are required to be in the tier. For example, a tier with a duration of P3M will be valid for a duration of 3 months.
| +| rounding |Defines the rounding mechanism for tier expiration.
Any of: [Calendar Periods](#calendar-periods), [Specific Month](#specific-month) | +## Validation Rule Assignments +| Attributes | Description | +|:-----|:--------| +| object`string` |The type of object represented by JSON. This object stores information about validation rule assignments.
| +| data_ref`string` |Identifies the name of the JSON property that contains the array of validation rule assignments.
| +| data`array` |A dictionary that contains an array of validation rule assignments.
Array of [Validation Rule Assignment Object](#validation-rule-assignment-object) | +| total`integer` |Total number of validation rule assignments.
| +## Calendar Periods +| Attributes | Description | +|:-----|:--------| +| type`string` |Period to which the expiration will be rounded to.
MONTH
: The expiration date will be rounded to the end of the month.QUARTER
: The expiration date will be rounded to the end of the quarter.HALF_YEAR
: The expiration date will be rounded to the half year.YEAR
: The expiration date will be rounded to the end of the year.Which portion of the given period should the rounding be applied to.
Available values: `END` | +## Specific Month +| Attributes | Description | +|:-----|:--------| +| type`string` |This mechanism describes a custom rounding for the expiration date.
Available values: `CUSTOM` | +| strategy`string` |Which portion of the given period should the rounding be applied to.
Available values: `END` | +| unit`string` |Defines the type of unit of time in which the rounding period is counted.
Available values: `MONTH` | +| value`integer` |Value for the unit of time that the rounding applies to. Units for this parameter are defined by the rounding.unit
parameter.
0
: January1
: February2
: March3
: April4
: May5
: June6
: July7
: August8
: September9
: October10
: November11
: DecemberValidation rule assignment ID.
**Example:**asgm_74F7QZoYbUoljwQO
| +| rule_id`string` |Validation rule ID.
**Example:**val_4j7DCRm2IS59
| +| related_object_id`string` |The resource ID to which the validation rule was assigned.
**Example:**v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT
| +| related_object_type`string` |The type of resource to which the validation rule was assigned.
Available values: `voucher`, `campaign`, `earning_rule`, `reward_assignment`, `promotion_tier`, `distribution` | +| created_at`string` |Timestamp representing the date and time when the validation rule assignment was created in ISO 8601 format.
**Example:**2022-02-17T08:18:15.085Z
| +| object`string` |The type of object represented by the ID.
| [block:html] { diff --git a/docs/reference-docs/CATEGORIES-API-Category-Object.md b/docs/reference-docs/CATEGORIES-API-Category-Object.md index 86b87a53a..963b8f563 100644 --- a/docs/reference-docs/CATEGORIES-API-Category-Object.md +++ b/docs/reference-docs/CATEGORIES-API-Category-Object.md @@ -1,6 +1,6 @@ --- title: Category Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: categories-api slug: category-object @@ -8,14 +8,15 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique category ID assigned by Voucherify.
| | -| name |Category name.
| | -| hierarchy |Category hierarchy.
| | -| created_at |Timestamp representing the date and time when the category was created in ISO 8601 format.
|2022-07-14T10:45:13.156Z
| -| updated_at |Timestamp representing the date and time when the category was updated in ISO 8601 format.
|2022-08-16T10:52:08.094Z
| -| object |The type of object represented by the JSON. This object stores information about the category.
| | +## Category Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique category ID assigned by Voucherify.
| +| name`string` |Category name.
| +| hierarchy`integer` |Category hierarchy.
| +| created_at`string` |Timestamp representing the date and time when the category was created in ISO 8601 format.
**Example:**2022-07-14T10:45:13.156Z
| +| updated_at`string` |Timestamp representing the date and time when the category was updated in ISO 8601 format.
**Example:**2022-08-16T10:52:08.094Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the category.
| [block:html] { diff --git a/docs/reference-docs/CONSENTS-API-Consents-Object.md b/docs/reference-docs/CONSENTS-API-Consents-Object.md index fa6417fe2..84f55ab00 100644 --- a/docs/reference-docs/CONSENTS-API-Consents-Object.md +++ b/docs/reference-docs/CONSENTS-API-Consents-Object.md @@ -1,6 +1,6 @@ --- title: Consents Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: consents-api slug: consents-object @@ -8,10 +8,11 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| groups |Contains marketing permission groups' definitions.
Attributes | Description | Example | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
object | Stores information about marketing permission groups. | |||||||||||||||||||||||||
data_ref | Identifies the name of the attribute that contains the array of marketing permission groups. | |||||||||||||||||||||||||
data | An array of marketing permission groups. Array of:
| |||||||||||||||||||||||||
total | Total number of groups. |
Contains opt-in consents' definitions.
Attributes | Description | Example | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
object | Stores information about opt-in consents. | |||||||||||||||||||||||||
data_ref | Identifies the name of the attribute that contains the array of opt-in consents. | |||||||||||||||||||||||||
data | An array of consents. Array of:
| |||||||||||||||||||||||||
total | Total number of consents. |
Contains marketing permission groups' definitions.
Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
objectstring | Stores information about marketing permission groups. | ||||||||||||||||
data_refstring | Identifies the name of the attribute that contains the array of marketing permission groups. | ||||||||||||||||
dataarray | An array of marketing permission groups. Array of:
| ||||||||||||||||
totalinteger | Total number of groups. |
Contains opt-in consents' definitions.
Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
objectstring | Stores information about opt-in consents. | ||||||||||||||||
data_refstring | Identifies the name of the attribute that contains the array of opt-in consents. | ||||||||||||||||
dataarray | An array of consents. Array of:
| ||||||||||||||||
totalinteger | Total number of consents. |
Unique event ID, assigned by Voucherify.
|evcus_0c150c51730c6b60b1
| -| type |Event type.
Available values: `customer.confirmed`, `customer.created`, `customer.updated`, `customer.deleted`, `customer.referred`, `customer.custom_event`, `customer.segment_entered`, `customer.segment.left`, `customer.sms.sent`, `customer.sms.failed`, `customer.email.sent`, `customer.email.failed`, `customer.activecampaign.sent`, `customer.braze.sent`, `customer.mailchimp.sent`, `customer.intercom.sent`, `customer.intercom.failed`, `customer.rewarded`, `customer.rewarded.loyalty_points`, `customer.voucher.gift.balance_added`, `customer.voucher.loyalty_card.points_added`, `customer.voucher.loyalty_card.points_transferred`, `customer.publication.succeeded`, `customer.publication.failed`, `customer.redemption.succeeded`, `customer.redemption.failed`, `customer.redemption.rollback.succeeded`, `customer.redemption.rollback.failed`, `customer.consents.given`, `customer.consents.revoked` | | -| data |Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.
Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.
|2022-08-30T09:14:07.660Z
| +## Customer Activity Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique event ID, assigned by Voucherify.
**Example:**evcus_0c150c51730c6b60b1
| +| type`string` |Event type.
Available values: `customer.confirmed`, `customer.created`, `customer.updated`, `customer.deleted`, `customer.referred`, `customer.custom_event`, `customer.segment_entered`, `customer.segment.left`, `customer.sms.sent`, `customer.sms.failed`, `customer.email.sent`, `customer.email.failed`, `customer.activecampaign.sent`, `customer.braze.sent`, `customer.mailchimp.sent`, `customer.intercom.sent`, `customer.intercom.failed`, `customer.rewarded`, `customer.rewarded.loyalty_points`, `customer.voucher.gift.balance_added`, `customer.voucher.loyalty_card.points_added`, `customer.voucher.loyalty_card.points_transferred`, `customer.publication.succeeded`, `customer.publication.failed`, `customer.redemption.succeeded`, `customer.redemption.failed`, `customer.redemption.rollback.succeeded`, `customer.redemption.rollback.failed`, `customer.consents.given`, `customer.consents.revoked` | +| data`array` |Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.
Array of [Customer Activity Data Object](#customer-activity-data-object) | +| created_at`string` |Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.
**Example:**2022-08-30T09:14:07.660Z
| +## Customer Activity Data Object [block:html] { diff --git a/docs/reference-docs/CUSTOMERS-API-Customer-Object.md b/docs/reference-docs/CUSTOMERS-API-Customer-Object.md index 8d5ba4c79..98498ed94 100644 --- a/docs/reference-docs/CUSTOMERS-API-Customer-Object.md +++ b/docs/reference-docs/CUSTOMERS-API-Customer-Object.md @@ -1,6 +1,6 @@ --- title: Customer Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: customers-api slug: customer-object @@ -8,26 +8,27 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |The unique ID of a customer that is assigned by Voucherify.
|cust_CSnYd37MXmrbS19XCrghjBsv
| -| source_id |The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It is externally defined. It can be a customer ID from a CRM system, database or 3rd-party service.
| | -| name |Customer's first and last name.
| | -| description |An arbitrary string that you can attach to a customer object.
| | -| email |Customer's email address.
| | -| phone |Customer's phone number.
| | -| birthdate |Customer's birthdate.
| | -| birthday |Customer's birthday.
| | -| address |Customer's address.
Attributes | Description | Example |
---|---|---|
city | City | |
state | State | |
line_1 | First line of address. | |
line_2 | Second line of address. | |
country | Country. | |
postal_code | Postal code. |
Contains a summary of customer's redemption and order statistics.
Attributes | Description | Example | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
redemptions | Customer's redemptions statistics.
| ||||||||||||||||||||||||||||||||||||||||||||||
orders | Customer's order statistics.
|
Summary of customer's loyalty information.
Attributes | Description | Example | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
points | Sum of remaining available point balance across all loyalty cards. | |||||||||||||||||||
referred_customers | Total number of customers referred by the customer. | |||||||||||||||||||
campaigns | Contains campaigns with details about point balances and how many customers were referred by the customer.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Attributes | Description | Example | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
total | Total number of times this customer received a referral, i.e. was referred by another customer. | |||||||||||||||||||
campaigns | Contains an array of campaigns that served as the source of a referral for the customer. Array of:
|
A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.
| | -| system_metadata |Object used to store system metadata information.
Attributes | Description | Example | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
consents | Stores a list of consent ID's along with the timestamp and decision on accepting or rejecting a marketing permission.
| ||||||||||||||||
source | Takes on the name of the source of the integration if the customer was created through an integration, i.e. |
Timestamp representing the date and time when the customer was created in ISO 8601 format.
|2022-08-30T06:32:07.380Z
| -| updated_at |Timestamp representing the date and time when the customer was updated in ISO 8601 format.
|2022-08-31T06:32:07.380Z
| -| assets |Contains information about the customer's cockpit.
Attributes | Description | Example |
---|---|---|
cockpit_url | Customer's cockpit URL address. |
The type of object represented by the JSON. This object stores information about the customer.
| | +## Customer Object +| Attributes | Description | +|:-----|:--------| +| id`string` |The unique ID of a customer that is assigned by Voucherify.
**Example:**cust_CSnYd37MXmrbS19XCrghjBsv
| +| source_id`string` |The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It is externally defined. It can be a customer ID from a CRM system, database or 3rd-party service.
| +| name`string` |Customer's first and last name.
| +| description`string` |An arbitrary string that you can attach to a customer object.
| +| email`string` |Customer's email address.
| +| phone`string` |Customer's phone number.
| +| birthdate`string` |Customer's birthdate.
| +| birthday`string` |Customer's birthday.
| +| address`object` |Customer's address.
Attributes | Description |
---|---|
citystring | City |
statestring | State |
line_1string | First line of address. |
line_2string | Second line of address. |
countrystring | Country. |
postal_codestring | Postal code. |
Contains a summary of customer's redemption and order statistics.
Attributes | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
redemptionsobject | Customer's redemptions statistics.
| ||||||||||||||||||||||||||||||
ordersobject | Customer's order statistics.
|
Summary of customer's loyalty information.
Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pointsinteger | Sum of remaining available point balance across all loyalty cards. | ||||||||||||
referred_customersinteger | Total number of customers referred by the customer. | ||||||||||||
campaignsobject | Contains campaigns with details about point balances and how many customers were referred by the customer.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalinteger | Total number of times this customer received a referral, i.e. was referred by another customer. | ||||||||||||
campaignsarray | Contains an array of campaigns that served as the source of a referral for the customer. Array of:
|
A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.
| +| system_metadata`object` |Object used to store system metadata information.
Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
consentsobject | Stores a list of consent ID's along with the timestamp and decision on accepting or rejecting a marketing permission.
| ||||||||||
sourcestring | Takes on the name of the source of the integration if the customer was created through an integration, i.e. |
Timestamp representing the date and time when the customer was created in ISO 8601 format.
**Example:**2022-08-30T06:32:07.380Z
| +| updated_at`string` |Timestamp representing the date and time when the customer was updated in ISO 8601 format.
**Example:**2022-08-31T06:32:07.380Z
| +| assets`object` |Contains information about the customer's cockpit.
Attributes | Description |
---|---|
cockpit_urlstring | Customer's cockpit URL address. |
The type of object represented by the JSON. This object stores information about the customer.
| [block:html] { diff --git a/docs/reference-docs/EXPORTS-API-Export-Object.md b/docs/reference-docs/EXPORTS-API-Export-Object.md index 141979252..d47228bf2 100644 --- a/docs/reference-docs/EXPORTS-API-Export-Object.md +++ b/docs/reference-docs/EXPORTS-API-Export-Object.md @@ -1,6 +1,6 @@ --- title: Export Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: exports-api slug: export-object @@ -8,17 +8,182 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique export ID.
|exp_FFfp9o7daWuJqJCKp5xqqli4
| -| object |The type of object being represented. This object stores information about the export
.
Timestamp representing the date and time when the export was scheduled in ISO 8601 format.
|2022-04-28T11:23:20.922Z
| -| status |Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.
Available values: `SCHEDULED`, `IN_PROGRESS`, `DONE`, `ERROR` | | -| channel |The channel through which the export was triggered.
Available values: `API`, `WEBSITE` | | -| exported_object |The type of exported object.
Available values: `order`, `voucher`, `publication`, `redemption`, `customer`, `points_expiration`, `voucher_transactions` | | -| parameters | Any of:Attributes | Description | Example | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash -created_at , created_at , updated_at , -updated_at , status , -status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:
id,source_id,created_at,updated_at,status,amount,discount_amount,items_discount_amount,total_discount_amount,total_amount,customer_id,referrer_id,metadata | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters | Any of: Filter by status
Filter by order source ID
Filter by order amount
Filter by order total amount
Filter by order discount amount
Filter by order total discount amount
Filter by order items discount amount
|
Attributes | Description | Example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash created_at , -created_at , updated_at , -updated_at , code , -code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
code,voucher_type,value,discount_type,campaign,category,start_date,expiration_date,gift_balance,loyalty_balance,redemption_quantity,redemption_count,active,qr_code,bar_code,id,is_referral_code,created_at,updated_at,validity_timeframe_interval,validity_timeframe_duration,validity_day_of_week,discount_amount_limit,campaign_id,additional_info,customer_id,discount_unit_type,discount_unit_effect,customer_source_id,metadata | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters | Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
|
Attributes | Description | Example | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash id , -id , voucher_code , -voucher_code , tracking_id , -tracking_id , customer_id , -customer_id , created_at , -created_at , channel , -channel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
voucher_code,customer_id,customer_source_id,date,channel,campaign,is_winner,metadata | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters | Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
Filter by failure code
Filter by result
Filter by customer ID
Filter by campaign name
Filter by voucher type
Filter if the code is a referral code
Filter by parent object ID
Filter by related object ID
Filter by publication source ID
|
Attributes | Description | Example | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash id , -id , voucher_code , -voucher_code , tracking_id , -tracking_id , customer_id , -customer_id , created_at , -created_at | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
id,object,date,voucher_code,campaign,promotion_tier_id,customer_id,customer_source_id,customer_name,tracking_id,order_amount,gift_amount,loyalty_points,result,failure_code,failure_message,metadata | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters | Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
|
Attributes | Description | Example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash name , -name , id , -id , email , -email , source_id , -source_id , created_at , -created_at , updated_at , -updated_at | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fields | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
name,id,description,email,source_id,created_at,address_city,address_state,address_line_1,address_line_2,address_country,address_postal_code,redemptions_total_redeemed,redemptions_total_failed,redemptions_total_succeeded,redemptions_total_rolled_back,redemptions_total_rollback_failed,redemptions_total_rollback_succeeded,orders_total_amount,orders_total_count,orders_average_amount,orders_last_order_amount,orders_last_order_date,loyalty_points,loyalty_referred_customers,updated_at,phone,birthday,metadata,birthdate | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters | Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
|
Attributes | Description | Example | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash expires_at , -expires_at | ||||||||||||||||||||||
fields | Array of strings containing the data that was exported. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
id,campaign_id,voucher_id,status,expires_at,points | ||||||||||||||||||||||
filters | Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
Filter by campaign ID
Filter by voucher ID
|
Attributes | Description | Example | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash -created_at , created_at | |||||||||||||||||||||||||||||||||||||
fields | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:
id,type,source_id,reason,balance,amount,created_at,voucher_id,campaign_id,source,details | |||||||||||||||||||||||||||||||||||||
filters |
Attributes | Description | Example | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order | How the export is filtered, where the dash -created_at , created_at | ||||||||||||||||||||||||||||||||||||||||
fields | Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:
id,type,source_id,reason,balance,amount,created_at,voucher_id,campaign_id,details,related_transaction_id | ||||||||||||||||||||||||||||||||||||||||
filters |
Contains the URL of the CSV file.
Attributes | Description | Example |
---|---|---|
url | URL of the CSV file location. It contains the |
Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel
value is WEBSITE
.
user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH
| +## Export Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique export ID.
**Example:**exp_FFfp9o7daWuJqJCKp5xqqli4
| +| object`string` |The type of object being represented. This object stores information about the export
.
Timestamp representing the date and time when the export was scheduled in ISO 8601 format.
**Example:**2022-04-28T11:23:20.922Z
| +| status`string` |Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.
Available values: `SCHEDULED`, `IN_PROGRESS`, `DONE`, `ERROR` | +| channel`string` |The channel through which the export was triggered.
Available values: `API`, `WEBSITE` | +| exported_object`string` |The type of exported object.
Available values: `order`, `voucher`, `publication`, `redemption`, `customer`, `points_expiration`, `voucher_transactions` | +| parameters | Any of: [order](#order), [voucher](#voucher), [publication](#publication), [redemption](#redemption), [customer](#customer), [points expiration](#points-expiration), [gift card transactions](#gift-card-transactions), [loyalty card transactions](#loyalty-card-transactions) | +| result`object` |Contains the URL of the CSV file.
Attributes | Description |
---|---|
urlstring | URL of the CSV file location. It contains the |
Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel
value is WEBSITE
.
user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH
| +## order +| Attributes | Description | +|:-----|:--------| +| order`string` |How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
id | Unique order ID. | ord_A69RIxEdRsPuC6i8gFGVHUft |
source_id | Unique order source ID. | 8638 |
created_at | Timestamp in ISO 8601 format representing the date and time when the order was created. | 2022-03-09T09:16:32.521Z |
updated_at | Timestamp in ISO 8601 format representing the date and time when the order was last updated. | 2022-03-09T09:16:33.331Z |
status | Order status. | PAID , CREATED , FULFILLED , CANCELED |
amount | Total amount of order items. | 7700 |
discount_amount | Represents total amount of the discount applied to whole cart. | 500 |
items_discount_amount | Represents total amount of the discount applied to order line items. | 100 |
total_discount_amount | All discounts applied to the order including discounts applied to particular order line items and discounts applied to the whole cart. | 600 |
total_amount | Total order amount after applying all discounts. | 7100 |
customer_id | Customer unique ID. | cust_2G4fUQdCXUqp35nXNleav7bO |
referrer_id | Referrer unique ID. | cust_IkrTR674vvQvr9a4rDMiqglY |
metadata | Returns all order metadata. | Response will include all order metadata. |
metadata.X | Where X is the name of a particular order metadata property. | The returned value will depend on the type of data defined in the Dashboard > Project Settings > Metdata Schemas > Order. Read more here. |
How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
id | Unique voucher ID. | v_HSnGD2vNIHYighTQxwcB4dtVAv8VOmZD |
code | Unique voucher code. | WELCOME100 |
voucher_type | Type of voucher. | DISCOUNT_VOUCHER , GIFT_VOUCHER , LOYALTY_CARD |
value | Value of voucher. | DISCOUNT_VOUCHER : amount, percent, unitGIFT_VOUCHER : amount left to spendLOYALTY_CARD : available usable points |
discount_type | The type of discount for a DISCOUNT_VOUCHER . | AMOUNT , PERCENT , UNIT , FIXED |
campaign | Unique campaign name. | Summer Discounts 20% off |
category | Tag defining the category that this voucher belongs to. | |
start_date | Start date defines when the code starts to be active. Activation timestamp in ISO 8601 format. Voucher is inactive before this date. | 2020-12-10T23:00:00.000Z |
expiration_date | Expiration date defines when the code expires. Expiration timestamp in ISO 8601 format. Voucher is inactive after this date. | 2023-12-31T23:00:00.000Z |
gift_balance | Amount left to spend. | 1000 |
loyalty_balance | Available usable points. | 2000 |
redemption_quantity | Maximum number of times a voucher can be redeemed. | 2 |
redemption_count | Total redemptions. | 59 |
active | Boolean indicating whether the voucher is available for use. | true , false |
qr_code | URL to QR representation of encrypted code. | |
bar_code | URL to barcode representation of encrypted code. | |
is_referral_code | Boolean indicating whether the voucher is a referral code. | true , false |
created_at | Timestamp in ISO 8601 format representing the date and time when the voucher was created. | 2022-04-14T09:55:46.814Z |
updated_at | Timestamp in ISO 8601 format representing the date and time when the voucher was last updated. | 2022-04-14T10:02:18.036Z |
validity_timeframe_interval | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an interval of P2D will be active every other day. | P2D |
validity_timeframe_duration | Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a duration of PT1H will be valid for a duration of one hour. | PT1H |
validity_day_of_week | Array corresponding to the particular days of the week in which the voucher is valid. | "1,2,3,4,5" |
discount_amount_limit | For PERCENT discount type, this is the maximum threshold allowed to be deducted. | 50 |
campaign_id | Parent campaign ID. | camp_7s3uXI44aKfIk5IhmeOPr6ic |
additional_info | An optional field to keep any extra textual information about the code such as a code description and details. | |
customer_id | Unique customer ID of the assigned owner to whom the voucher was published. | cust_7iUa6ICKyU6gH40dBU25kQU1 |
discount_unit_type | For UNIT discount type, either a shipping or product ID for a UNIT discount with one product. | prod_5h1pp1ng, prod_0a9f9aeddb019a42db |
discount_unit_effect | UNIT discount effect. | ADD_MANY_ITEMS , ADD_MISSING_ITEMS ,ADD_NEW_ITEMS |
customer_source_id | Unique customer source id of the assigned owner to whom the voucher was published. | name.lastname@email.com |
metadata | Returns all voucher metadata. | Response will include all voucher metadata. |
metadata.X | Where X is the name of a particular voucher metadata property. | The returned value will depend on the type of data defined in the Dashboard > Project Settings > Metdata Schemas > Voucher. Read more here. |
Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
categories
vouchers
type
holder_id
is_referral_code
published_for_customer_id
validity_timeframe
category_ids
How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
voucher_code | Unique voucher code. | WELCOME100 |
customer_id | Customer unique ID. | cust_7iUa6ICKyU6gH40dBU25kQU1 |
customer_source_id | Unique customer source id of the assigned owner to whom the voucher was published. | name.lastname@email.com |
date | Timestamp in ISO 8601 format representing the date and time when the voucher was published. | 2022-04-28T10:19:30.792Z |
channel | Publication channel. | voucherify-website |
campaign | Unique campaign name. | Summer Discounts 20% off |
is_winner | ||
metadata | Returns all publication metadata. | Response will include all publication metadata. |
metadata.X | Where X is the name of a particular publication metadata property. | The returned value will depend on the type of data defined in the Dashboard > Project Settings > Metdata Schemas > Publication. Read more here |
Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
failure_code
result
customer_id
campaign_name
voucher_type
is_referral_code
parent_object_id
related_object_id
source_id
How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
id | Unique redemption ID. | r_0acf3a6dae00e679c8, rf_0acf3a495740e679b8 |
object | Object being exported; by default redemption . | redemption |
date | Timestamp in ISO 8601 format representing the date and time when the voucher was redeemed. | 2022-03-23T08:52:24.867Z |
voucher_code | Unique voucher code redeemed. | WELCOME100 |
campaign | Parent campaign name of voucher if applicable. | Summer Discounts 20% off |
promotion_tier_id | promo_Mwy9XpA0TLctSGriM5kum0qp | |
customer_id | Unique customer ID of redeeming customer. | cust_nk0N1uNQ1YnupAoJGOgvsODC |
customer_source_id | Unique source ID of redeeming customer. | name.lastname@email.com |
customer_name | Customer name. | John Smith |
tracking_id | track_Pw6r3ejnml43kIwNS4Zj09KZ67xOfLUy | |
order_amount | Total order amount before applying all discounts. | 1000 |
gift_amount | Gift credits used for redemption. | 10 |
loyalty_points | 12 | |
result | Tells you whether the redemption succeeded. | SUCCESS , FAILURE |
failure_code | Internal Voucherify code for reason why redemption failed. | invalid_customer |
failure_message | A human-readable message providing a short description explaining why the redemption failed. | Customer must be a holder of a loyalty card. |
metadata | Returns all redemption metadata. | Response will include all redemption metadata. |
metadata.X | Where X is the name of a particular redemption metadata property. | The returned value will depend on the type of data defined in the Dashboard > Project Settings > Metdata Schemas > Redemption. Read more here |
Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
voucher_code
related_object_id
related_object_parent_id
parent_redemption_id
failure_code
result
object
customer_id
campaign_name
user_login
How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
name | Customer name. | John Smith |
id | Unique customer ID. | cust_J1CDUdbqn5Exva8ASWk1Fq0j |
description | An arbitrary string that you can attach to a customer object. | Customer requesting to be added to VIP tier. |
Customer's email. | name.lastname@email.com | |
source_id | Unique custom customer identifier. | name.lastname@email.com |
created_at | Timestamp in ISO 8601 format representing the date and time when the customer was created. | 2022-02-03T13:10:11.928Z |
address_city | City | Houston |
address_state | State | TX |
address_line_1 | First line of customer's address. | 72738 Main St |
address_line_2 | Second line of customer's address. | Bld 2, Apt 4 |
address_country | Country | United States of America |
address_postal_code | Postal code (ZIP code) | 77042-4143 |
redemptions_total_redeemed | Total customer redemptions. | 5 |
redemptions_total_failed | Total customer failed redemptions. | 2 |
redemptions_total_succeeded | Total customer succeeded redemptions. | 3 |
redemptions_total_rolled_back | Total customer redemptions that were rolled back. | 3 |
redemptions_total_rollback_failed | Total customer redemptions that were unsuccessfully rolled back. | 2 |
redemptions_total_rollback_succeeded | Total customer redemptions that were successfully rolled back. | 1 |
orders_total_amount | Total sum of order amounts over customer lifetime. Value is multiplied by 100 to precisely represent 2 decimal places. | 10000 (represents $100) |
orders_total_count | Total number of customer orders. Value is multiplied by 100 to precisely represent 2 decimal places. | 2 |
orders_average_amount | Average amount spent on orders. Value is multiplied by 100 to precisely represent 2 decimal places. | 50 |
orders_last_order_amount | How much did the customer spend on their last order. Value is multiplied by 100 to precisely represent 2 decimal places. | 50 |
orders_last_order_date | When was the last customer order; timestamp in ISO 8601 format representing the date and time. | 2022-02-03T13:17:30.630Z |
loyalty_points | Sum of customer's loyalty points to go across all loyalty cards. | |
loyalty_referred_customers | How many customers were referred by this customer. | |
updated_at | Timestamp in ISO 8601 format representing the date and time when the customer was updated. | 2022-02-14T14:10:14.305Z |
phone | Customer's phone number. | +1 (294) 752-1846 |
birthday | Customer's birthday. | 2022-01-01 |
birthdate | Customer's birthdate. | 2022-04-29 |
metadata | Returns all customer metadata. | Response will include all customer metadata. |
metadata.X | Where X is the name of a particular customer metadata property. | The returned value will depend on the type of data defined in the Dashboard > Project Settings > Metdata Schemas > Customer. Read more here |
Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
name
(string)
email
(string)
phone
(string)
metadata
(json)
metadata.X
(?)
address
(json)
address.state
(string)
address.country
(string)
address.postal_code
(string)
birthday
(string - date-time)
birthdate
(string date-time)
created_at
(date)
source_id
(string)
system.metadata
(json)
system.metadata.source
(string)
system.metadata.consents.unsubscribed
(boolean)
loyalty_points
(json)
loyalty
(json)
summary.orders.total_amount
(json)
summary.orders.last_order_date
(date)
summary.orders.last_order_amount
(json)
summary.redemptions.gift.redeemed_amount
(integer)
summary.redemptions.total_succeeded
(integer)
events.cart_abandoned.last_occurred
(integer)
events.newsletter_subscribed.count
(integer)
events.sign_up.last_occurred
(integer)
How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data that was exported. These fields define the headers in the CSV file.
The array can be a combintation of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
id | Loyalty points bucket ID. | lopb_Wl1o3EjJIHSNjvO5BDLy4z1n |
campaign_id | Campaign ID of the parent loyalty campaign. | camp_7s3uXI44aKfIk5IhmeOPr6ic |
voucher_id | Voucher ID of the parent loyalty card. | v_YLn0WVWXSXbUfDvxgrgUbtfJ3SQIY655 |
status | Status of the loyalty points bucket. | ACTIVE or INACTIVE |
expires_at | Timestamp in ISO 8601 format representing the date when the points expire. | 2022-06-30 |
points | Number of points. | 1000 |
Data filters used to narrow the data records to be returned in the export. You can filter the following parameters:
campaign_id
voucher_id
How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
id | Unique transaction ID. | vtx_0cb7811f1c07765800 |
type | Transaction type. | - CREDITS_REMOVAL - CREDITS_ADDITION - CREDITS_REFUND - CREDITS_REDEMPTION |
source_id | Unique transaction source ID. | 8638 |
reason | Contains the reason for the transaction if one was included originally. | |
balance | The gift card balance after the transaction. | |
amount | The amount of gift card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |
created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |
voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |
campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |
source | Channel through which the transaction was initiated. | API |
details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |
How the export is filtered, where the dash -
preceding a sorting option means sorting in a descending order.
Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:
Field | Definition | Example Export |
---|---|---|
id | Unique transaction ID assigned by Voucherify. | vtx_0cb7811f1c07765800 |
type | Transaction type. | - POINTS_EXPIRATION - POINTS_ADDITION - POINTS_REMOVAL - POINTS_TRANSFER_OUT - POINTS_ACCRUAL - POINTS_REFUND - POINTS_REDEMPTION |
source_id | Custom source ID of the transaction if one was included originally. | source_id_custom |
reason | Contains the reason for the transaction if one was included originally. | |
balance | The loyalty card balance after the transaction. | |
amount | The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |
created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |
voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |
campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |
source | Channel through which the transaction was initiated. | - API - voucherify-web-ui - Automation |
details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |
related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |
Data filters used to narrow the data records to be returned in the result.
Attributes | Description |
---|---|
$inarray | Array of resource values that should be included in the results. (multiple values) |
$not_inarray | Array of resource values that should be included in the results. (multiple values) |
$isstring | Value is exactly this value. (single value) |
$is_notstring | Results omit this value. (single value) |
$has_valuestring | Value is NOT null. The value for this parameter is an empty string. |
$is_unknownstring | Value is null. The value for this parameter is an empty string. |
$starts_withstring | Value starts with the specified string. |
$ends_withstring | Value ends with the specified string. |
Filter by conditions set on the junction
parameter indicating how the conditions
should be accounted for in the query. An AND
is an all-inclusive logical operator, meaning the AND
operator displays a record if ALL the conditions separated by AND are TRUE, while an OR
operator displays a record if ANY of the conditions separated by OR is TRUE.
Data filters used to narrow the data records to be returned in the result.
Attributes | Description |
---|---|
$inarray | Array of resource values that should be included in the results. (multiple values) |
$not_inarray | Array of resource values that should be included in the results. (multiple values) |
$isinteger | Value is exactly this value. (single value) |
$is_notinteger | Results omit this value. (single value) |
$has_valuestring | Value is NOT null. The value for this parameter is an empty string. |
$is_unknownstring | Value is null. The value for this parameter is an empty string. |
$more_thaninteger | Value is more than the specified number. |
$more_than_equalinteger | Value is more than or equal to the specified number. |
$less_thaninteger | Value is less than the specified number. |
$less_than_equalinteger | Value is less than or equal to the specified number. |
Data filters used to narrow the data records to be returned in the result.
Attributes | Description |
---|---|
$isstring | Value is exactly this value. (single value) |
$is_notstring | Results omit this value. (single value) |
$has_valuestring | Value is NOT null. The value for this parameter is an empty string. |
$is_unknownstring | Value is null. The value for this parameter is an empty string. |
Unique campaign ID, assigned by Voucherify.
|camp_f7fBbQxUuTN7dI7tGOo5XMDA
| -| name |Loyalty campaign name.
| | -| campaign_type |Type of campaign.
Available values: `LOYALTY_PROGRAM` | | -| type |Defines whether the campaign can be updated with new vouchers after campaign creation.
AUTO_UPDATE
: the campaign is dynamic, i.e. vouchers will generate based on set criteriaSTATIC
: vouchers need to be manually publishedIndicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
| | -| join_once |If this value is set to true
, customers will be able to join the campaign only once.
Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
| | -| start_date |Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
|2022-09-20T00:00:00.000Z
| -| expiration_date |Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
|2022-09-30T00:00:00.000Z
| -| validity_timeframe |Set recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description | Example |
---|---|---|
interval | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a campaign with an | |
duration | Defines the amount of time the campaign will be active in ISO 8601 format. For example, a campaign with a |
Integer array corresponding to the particular days of the week in which the campaign is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayDefines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a duration
of P24D
will be valid for a duration of 24 days.
An optional field to keep any extra textual information about the campaign such as a campaign description and details.
| | -| vouchers_count |Total number of unique vouchers in campaign.
| | -| active |A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active campaignfalse
indicates an inactive campaignThe metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
| | -| created_at |Timestamp representing the date and time when the campaign was created in ISO 8601 format.
|2021-12-01T08:00:50.038Z
| -| updated_at |Timestamp representing the date and time when the voucher was updated in ISO 8601 format.
|2022-09-20T09:18:19.623Z
| -| creation_status |Indicates the status of the campaign creation.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT`, `MODIFYING` | | -| vouchers_generation_status |Indicates the status of the campaign's vouchers.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT` | | -| protected |Indicates whether the resource can be deleted.
| | -| category_id |Unique category ID that this campaign belongs to.
|cat_0b688929a2476386a7
| -| categories | | | -| loyalty_tiers_expiration |Defines the expiration mechanism for loyalty tiers.
Any of:Attributes | Description | Example | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
qualification_type | Tier qualification.
BALANCE | |||||||||||||||||||||||||||||||||||||||||||
start_date | Defines the conditions for the start date of the tier.
| |||||||||||||||||||||||||||||||||||||||||||
expiration_date | Defines the conditions for the expiration date of a tier. Any of:Balance Drop
Custom
|
Attributes | Description | Example | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
qualification_type | Tier qualification.
POINTS_IN_PERIOD | |||||||||||
qualification_period | Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.
MONTH , QUARTER , HALF_YEAR , YEAR | |||||||||||
start_date | Defines the conditions for the start date of the tier.
| |||||||||||
expiration_date | Defines the conditions for the expiration date of a tier.
|
The type of object represented by JSON. This object stores information about the campaign.
| | +## Loyalty Campaign Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique campaign ID, assigned by Voucherify.
**Example:**camp_f7fBbQxUuTN7dI7tGOo5XMDA
| +| name`string` |Loyalty campaign name.
| +| campaign_type`string` |Type of campaign.
Available values: `LOYALTY_PROGRAM` | +| type`string` |Defines whether the campaign can be updated with new vouchers after campaign creation.
AUTO_UPDATE
: the campaign is dynamic, i.e. vouchers will generate based on set criteriaSTATIC
: vouchers need to be manually publishedIndicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
| +| join_once`boolean` |If this value is set to true
, customers will be able to join the campaign only once.
Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
| +| start_date`string` |Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
**Example:**2022-09-20T00:00:00.000Z
| +| expiration_date`string` |Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
**Example:**2022-09-30T00:00:00.000Z
| +| validity_timeframe`object` |Set recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description |
---|---|
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a campaign with an |
durationstring | Defines the amount of time the campaign will be active in ISO 8601 format. For example, a campaign with a |
Integer array corresponding to the particular days of the week in which the campaign is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayDefines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a duration
of P24D
will be valid for a duration of 24 days.
An optional field to keep any extra textual information about the campaign such as a campaign description and details.
| +| vouchers_count`integer` |Total number of unique vouchers in campaign.
| +| active`boolean` |A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active campaignfalse
indicates an inactive campaignThe metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
| +| created_at`string` |Timestamp representing the date and time when the campaign was created in ISO 8601 format.
**Example:**2021-12-01T08:00:50.038Z
| +| updated_at`string` |Timestamp representing the date and time when the voucher was updated in ISO 8601 format.
**Example:**2022-09-20T09:18:19.623Z
| +| creation_status`string` |Indicates the status of the campaign creation.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT`, `MODIFYING` | +| vouchers_generation_status`string` |Indicates the status of the campaign's vouchers.
Available values: `DONE`, `IN_PROGRESS`, `FAILED`, `DRAFT` | +| protected`boolean` |Indicates whether the resource can be deleted.
| +| category_id`string` |Unique category ID that this campaign belongs to.
**Example:**cat_0b688929a2476386a7
| +| categories | See: [Category Object](#category-object) | +| loyalty_tiers_expiration`object` |Defines the expiration mechanism for loyalty tiers.
Any of: [Balance](#balance), [Points in Period](#points-in-period) | +| object`string` |The type of object represented by JSON. This object stores information about the campaign.
| +## Loyalty Card +| Attributes | Description | +|:-----|:--------| +| type`string` |Type of voucher.
| +| loyalty_card`object` |Defines the loyalty card details.
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
pointsinteger | Initial loyalty card income in points to be applied to the loyalty card at voucher generation. | ||||||||
expiration_rulesobject | Defines point expiration rules.
|
Defines the redemption limits on vouchers.
Attributes | Description |
---|---|
quantityinteger | How many times a voucher can be redeemed. A |
Defines code's pattern (prefix, suffix, length, charset, etc).
Attributes | Description |
---|---|
lengthstring | Number of characters in a generated code (excluding prefix and postfix). |
charsetstring | Characters that can appear in the code. Examples:
|
prefixstring | A text appended before the code. |
postfixstring | A text appended after the code. |
patternstring | A pattern for codes where hashes (#) will be replaced with random characters. Overrides |
Indicates whether the voucher is a referral code; this is true
for campaign type REFERRAL_PROGRAM
.
Unique category ID assigned by Voucherify.
| +| name`string` |Category name.
| +| hierarchy`integer` |Category hierarchy.
| +| created_at`string` |Timestamp representing the date and time when the category was created in ISO 8601 format.
**Example:**2022-07-14T10:45:13.156Z
| +| updated_at`string` |Timestamp representing the date and time when the category was updated in ISO 8601 format.
**Example:**2022-08-16T10:52:08.094Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the category.
| +## Balance +| Attributes | Description | +|:-----|:--------| +| qualification_type`string` |Tier qualification.
BALANCE
: Points balance is based on the customer's current points balance. Customers qualify for the tier if their points balance is in the points range of the tier.
Defines the conditions for the start date of the tier.
Attributes | Description |
---|---|
typestring | What triggers the tier to be valid for a customer. IMMEDIATE |
Defines the conditions for the expiration date of a tier.
Any of: [Balance Drop](#balance-drop), [Custom](#custom) | +## Points in Period +| Attributes | Description | +|:-----|:--------| +| qualification_type`string` |Tier qualification.
POINTS_IN_PERIOD
: A customer qualifies for the tier only if the sum of the accumulated points in a defined time interval reaches the tier threshold.
Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.
Period | Definition |
---|---|
Calendar Month | Points collected in one calendar month January, February, March, etc. |
Calendar Quarter | Points collected in the quarter - January - March - April - June - July - September - October - December |
Calendar Half-year | Points collected in the half-year - January - June - July - December |
Calendar Year | Points collected in one calendar year January - December |
Defines the conditions for the start date of the tier.
Attributes | Description |
---|---|
typestring | What triggers the tier to be valid for a customer. IMMEDIATE , NEXT_PERIOD |
Defines the conditions for the expiration date of a tier.
Attributes | Description |
---|---|
typestring | What triggers the tier to expire for a customer. END_OF_PERIOD , END_OF_NEXT_PERIOD |
extendstring | Extend the expiration by adding extra months or days in ISO 8601 format. The tier will remain active even though it reaches its expiration time period. For example, a tier with a duration of |
What triggers the tier to expire for a customer.BALANCE_DROP
: Tier expires when the points balance drops below the required range of the tier.
What triggers the tier to expire for a customer.CUSTOM
: Tier expires after a certain time period passes following the instance the points balance drops below the required range of the tier.
Defines the amount of time the tier will remain active in ISO 8601 format. The expiration date counter starts at the moment when the customer reaches the minimum required points that are required to be in the tier. For example, a tier with a duration of P3M will be valid for a duration of 3 months.
| +| rounding |Defines the rounding mechanism for tier expiration.
Any of: [Calendar Periods](#calendar-periods), [Specific Month](#specific-month) | +## Calendar Periods +| Attributes | Description | +|:-----|:--------| +| type`string` |Period to which the expiration will be rounded to.
MONTH
: The expiration date will be rounded to the end of the month.QUARTER
: The expiration date will be rounded to the end of the quarter.HALF_YEAR
: The expiration date will be rounded to the half year.YEAR
: The expiration date will be rounded to the end of the year.Which portion of the given period should the rounding be applied to.
Available values: `END` | +## Specific Month +| Attributes | Description | +|:-----|:--------| +| type`string` |This mechanism describes a custom rounding for the expiration date.
Available values: `CUSTOM` | +| strategy`string` |Which portion of the given period should the rounding be applied to.
Available values: `END` | +| unit`string` |Defines the type of unit of time in which the rounding period is counted.
Available values: `MONTH` | +| value`integer` |Value for the unit of time that the rounding applies to. Units for this parameter are defined by the rounding.unit
parameter.
0
: January1
: February2
: March3
: April4
: May5
: June6
: July7
: August8
: September9
: October10
: November11
: DecemberAssigned by the Voucherify API, identifies the voucher.
|v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV
| -| code |A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
|WVPblOYX
| -| campaign |A unique campaign name, identifies the voucher's parent campaign.
|Loyalty Card Campaign
| -| campaign_id |Assigned by the Voucherify API, identifies the voucher's parent campaign.
|camp_FNYR4jhqZBM9xTptxDGgeNBV
| -| category |Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
| | -| category_id |Unique category ID assigned by Voucherify.
|cat_0bb343dee3cdb5ec0c
| -| categories |Empty array.
| | -| type |Defines the type of voucher.
Available values: `LOYALTY_CARD` | | -| discount |Object representing discount parameters. Child attributes are present only if type
is DISCOUNT_VOUCHER
. Defaults to null
.
Object representing gift parameters. Child attributes are present only if type
is GIFT_VOUCHER
. Defaults to null
.
Object representing loyalty card parameters. Child attributes are present only if type
is LOYALTY_CARD
.
Attributes | Description | Example |
---|---|---|
points | Total points incurred over lifespan of loyalty card. | 7000 |
balance | Points available for reward redemption. | 6970 |
next_expiration_date | The next closest date when the next set of points are due to expire. | 2023-05-30 |
next_expiration_points | The amount of points that are set to expire next. |
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
|2021-12-01T00:00:00.000Z
| -| expiration_date |Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
|2021-12-31T00:00:00.000Z
| -| validity_timeframe |Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description | Example |
---|---|---|
duration | Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a | PT1H |
interval | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an | P2D |
Integer array corresponding to the particular days of the week in which the voucher is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayA flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active voucherfalse
indicates an inactive voucherAn optional field to keep any extra textual information about the code such as a code description and details.
| | -| metadata |The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
| | -| assets |Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
qr | Stores Quick Response (QR) representation of encrypted code.
| ||||||||||
barcode | Stores barcode representation of encrypted code.
|
Flag indicating whether this voucher is a referral code.
| | -| created_at |Timestamp representing the date and time when the voucher was created in ISO 8601 format.
|2021-12-22T10:13:06.487Z
| -| updated_at |Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
|2021-12-22T10:14:45.316Z
| -| holder_id |Unique customer ID of voucher owner.
|cust_eWgXlBBiY6THFRJwX45Iakv4
| -| redemption |Stores a summary of redemptions that have been applied to the voucher.
Attributes | Description | Example |
---|---|---|
quantity | How many times a voucher can be redeemed. A | |
redeemed_quantity | How many times a voucher has already been redeemed. | 1 |
redeemed_points | Total loyalty points redeemed. | 100000 |
object | The type of object represented is by default | |
url | The endpoint where this list of redemptions can be accessed using a GET method. | /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or publish voucher API method.
Required | Optional |
---|---|
type :LOYALTY_CARD | type :DISCOUNT_VOUCHER |
is_referral_code :true | type :GIFT_VOUCHER |
Attributes | Description | Example |
---|---|---|
object | The type of object represented is by default | |
count | Publication events counter. | 0 |
url | The endpoint where this list of publications can be accessed using a GET method. | /v1/vouchers/WVPblOYX/publications?page=1&limit=10 |
The type of object represented by JSON. Default is voucher
.
Assigned by the Voucherify API, identifies the voucher.
**Example:**v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV
| +| code`string` |A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
**Example:**WVPblOYX
| +| campaign`string` |A unique campaign name, identifies the voucher's parent campaign.
**Example:**Loyalty Card Campaign
| +| campaign_id`string` |Assigned by the Voucherify API, identifies the voucher's parent campaign.
**Example:**camp_FNYR4jhqZBM9xTptxDGgeNBV
| +| category`string` |Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
| +| category_id`string` |Unique category ID assigned by Voucherify.
**Example:**cat_0bb343dee3cdb5ec0c
| +| categories`array` |Contains details about the category.
Array of [Category Object](#category-object) | +| type`string` |Defines the type of voucher.
Available values: `LOYALTY_CARD` | +| discount`null` |Object representing discount parameters. Child attributes are present only if type
is DISCOUNT_VOUCHER
. Defaults to null
.
Object representing gift parameters. Child attributes are present only if type
is GIFT_VOUCHER
. Defaults to null
.
Object representing loyalty card parameters. Child attributes are present only if type
is LOYALTY_CARD
.
Attributes | Description |
---|---|
pointsinteger | Total points incurred over lifespan of loyalty card. Example:7000 |
balanceinteger | Points available for reward redemption. Example:6970 |
next_expiration_datestring | The next closest date when the next set of points are due to expire. Example:2023-05-30 |
next_expiration_pointsinteger | The amount of points that are set to expire next. |
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
**Example:**2021-12-01T00:00:00.000Z
| +| expiration_date`string` |Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
**Example:**2021-12-31T00:00:00.000Z
| +| validity_timeframe`object` |Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description |
---|---|
durationstring | Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a PT1H |
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an P2D |
Integer array corresponding to the particular days of the week in which the voucher is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayA flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active voucherfalse
indicates an inactive voucherAn optional field to keep any extra textual information about the code such as a code description and details.
| +| metadata`object` |The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
| +| assets`object` |Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
qrobject | Stores Quick Response (QR) representation of encrypted code.
| ||||||
barcodeobject | Stores barcode representation of encrypted code.
|
Flag indicating whether this voucher is a referral code.
| +| created_at`string` |Timestamp representing the date and time when the voucher was created in ISO 8601 format.
**Example:**2021-12-22T10:13:06.487Z
| +| updated_at`string` |Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
**Example:**2021-12-22T10:14:45.316Z
| +| holder_id`string` |Unique customer ID of voucher owner.
**Example:**cust_eWgXlBBiY6THFRJwX45Iakv4
| +| redemption`object` |Stores a summary of redemptions that have been applied to the voucher.
Attributes | Description |
---|---|
quantityinteger | How many times a voucher can be redeemed. A |
redeemed_quantityinteger | How many times a voucher has already been redeemed. Example:1 |
redeemed_pointsinteger | Total loyalty points redeemed. Example:100000 |
objectstring | The type of object represented is by default |
urlstring | The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or publish voucher API method.
Required | Optional |
---|---|
type :LOYALTY_CARD | type :DISCOUNT_VOUCHER |
is_referral_code :true | type :GIFT_VOUCHER |
Attributes | Description |
---|---|
objectstring | The type of object represented is by default |
countinteger | Publication events counter. Example:0 |
urlstring | The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/WVPblOYX/publications?page=1&limit=10 |
The type of object represented by JSON. Default is voucher
.
Unique category ID assigned by Voucherify.
| +| name`string` |Category name.
| +| hierarchy`integer` |Category hierarchy.
| +| created_at`string` |Timestamp representing the date and time when the category was created in ISO 8601 format.
**Example:**2022-07-14T10:45:13.156Z
| +| updated_at`string` |Timestamp representing the date and time when the category was updated in ISO 8601 format.
**Example:**2022-08-16T10:52:08.094Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the category.
| [block:html] { diff --git a/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md b/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md index cac33a389..3d1d65827 100644 --- a/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md +++ b/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md @@ -1,6 +1,6 @@ --- title: Loyalty Tier Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: loyalties-api slug: loyalty-tier-object @@ -8,19 +8,30 @@ hidden: false order: 3 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique loyalty tier ID.
|ltr_30KHciA0UG8B71Fo51GZqwgN
| -| name |Loyalty Tier name.
| | -| campaign_id |Unique parent campaign ID.
|camp_fkZ28pe7DUAEmmabofkxHI8N
| -| metadata |The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.
| | -| created_at |Timestamp representing the date and time when the loyalty tier was created in ISO 8601 format.
|2022-11-10T12:20:52.755Z
| -| updated_at |Timestamp representing the date and time when the loyalty tier was updated in ISO 8601 format.
|2022-11-25T10:59:43.231Z
| -| earning_rules |Contains a list of earning rule IDs and their points mapping for the given earning rule.
Attributes | Description | Example | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
unique_earning_rule_ID | ern_95aq3JaE5A8xzHjoJPYNRqXZ Any of:Multiply Points
Fixed Points
|
Contains a list of reward IDs and their points mapping for the given reward.
Attributes | Description | Example | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
unique_reward_ID | rewa_t88DnSdNnE0IzQX6gqH3jHGQ Any of:Multiply Points
Fixed Points
|
Defines loyalty tier range in points.
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
points | Defines range of loyalty tier in points.
|
Defines range of loyalty tier in points.
Attributes | Description | Example |
---|---|---|
from | Bottom points threshold value. | |
to | Top points threshold value. |
The type of object represented by JSON. This object stores information about the loyalty.
| | +## Loyalty Tier Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique loyalty tier ID.
**Example:**ltr_30KHciA0UG8B71Fo51GZqwgN
| +| name`string` |Loyalty Tier name.
| +| campaign_id`string` |Unique parent campaign ID.
**Example:**camp_fkZ28pe7DUAEmmabofkxHI8N
| +| metadata`object` |The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.
| +| created_at`string` |Timestamp representing the date and time when the loyalty tier was created in ISO 8601 format.
**Example:**2022-11-10T12:20:52.755Z
| +| updated_at`string` |Timestamp representing the date and time when the loyalty tier was updated in ISO 8601 format.
**Example:**2022-11-25T10:59:43.231Z
| +| earning_rules`object` |Contains a list of earning rule IDs and their points mapping for the given earning rule.
Attributes | Description |
---|---|
unique_earning_rule_ID | ern_95aq3JaE5A8xzHjoJPYNRqXZ Any of: Multiply Points, Fixed Points |
Contains a list of reward IDs and their points mapping for the given reward.
Attributes | Description |
---|---|
unique_reward_ID | rewa_t88DnSdNnE0IzQX6gqH3jHGQ Any of: Multiply Points, Fixed Points |
Defines loyalty tier range in points.
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
pointsobject | Defines range of loyalty tier in points.
|
Defines range of loyalty tier in points.
Attributes | Description |
---|---|
frominteger | Bottom points threshold value. |
tointeger | Top points threshold value. |
The type of object represented by JSON. This object stores information about the loyalty.
| +## Multiply Points +| Attributes | Description | +|:-----|:--------| +| type`string` |Type of calculation.
Available values: `MULTIPLY` | +| multiplier`integer` |Multiplication factor used to multiply the points to obtain the mapped points.
| +## Fixed Points +| Attributes | Description | +|:-----|:--------| +| type`string` |Type of calculation.
Available values: `CUSTOM` | +| points`integer` |Fixed number of points to be applied.
| [block:html] { diff --git a/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md b/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md index 5612cda31..491cb029a 100644 --- a/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md +++ b/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md @@ -1,6 +1,6 @@ --- title: Metadata Schema Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: metadata-schemas-api slug: metadata-schema-object @@ -8,15 +8,16 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique metadata schema ID.
|ms_OF36L2rk4EqhdxvZs56IW9iE
| -| related_object |The resource type. There is an infinite number of possibilities for the resource type because you can define custom metadata schemas. Some examples are included here to show you the standard metadata schema resource types.
Available values: `campaign`, `customer`, `earning_rule`, `loyalty_tier`, `order`, `order_item`, `product`, `promotion_tier`, `publication`, `redemption`, `reward`, `voucher` | | -| properties |Contains the metadata definitions. There can be many properties within this object.
Any of:Attributes | Description | Example | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
custom_property_name | Custom property name. This is defined in Project Settings > Metadata Schema in the Dashboard.
|
Restricts the creation of metadata fields when set to true
. In other words, it indicates whether or not you are allowed to create new metadata definitions; for example, in the campaign manager or publication manager. If it is set to true, then only the defined fields will be available for assigning values.
Timestamp representing the date and time when the metadata schema was created in ISO 8601 format.
|2021-12-03T13:33:44.556Z
| -| updated_at |Timestamp representing the date and time when the metadata schema was updated in ISO 8601 format.
|2022-08-11T08:05:30.695Z
| -| object |The type of object represented by the JSON. This object stores information about the metadata schema.
| | +## Metadata Schema Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique metadata schema ID.
**Example:**ms_OF36L2rk4EqhdxvZs56IW9iE
| +| related_object`string` |The resource type. There is an infinite number of possibilities for the resource type because you can define custom metadata schemas. Some examples are included here to show you the standard metadata schema resource types.
Available values: `campaign`, `customer`, `earning_rule`, `loyalty_tier`, `order`, `order_item`, `product`, `promotion_tier`, `publication`, `redemption`, `reward`, `voucher` | +| properties`object` |Contains the metadata definitions. There can be many properties within this object.
Any of:Attributes | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
custom_property_nameobject | Custom property name. This is defined in Project Settings > Metadata Schema in the Dashboard.
|
Restricts the creation of metadata fields when set to true
. In other words, it indicates whether or not you are allowed to create new metadata definitions; for example, in the campaign manager or publication manager. If it is set to true, then only the defined fields will be available for assigning values.
Timestamp representing the date and time when the metadata schema was created in ISO 8601 format.
**Example:**2021-12-03T13:33:44.556Z
| +| updated_at`string` |Timestamp representing the date and time when the metadata schema was updated in ISO 8601 format.
**Example:**2022-08-11T08:05:30.695Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the metadata schema.
| [block:html] { diff --git a/docs/reference-docs/ORDERS-API-Order-Object.md b/docs/reference-docs/ORDERS-API-Order-Object.md index 9bec16d73..dfefedfab 100644 --- a/docs/reference-docs/ORDERS-API-Order-Object.md +++ b/docs/reference-docs/ORDERS-API-Order-Object.md @@ -1,6 +1,6 @@ --- title: Order Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: orders-api slug: order-object @@ -8,26 +8,35 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique order ID, assigned by Voucherify.
|ord_GFDbbv2I0wnO0sFUBOOOXPj2
| -| source_id |The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service.
| | -| created_at |Timestamp representing the date and time when the order was created in ISO 8601 format.
|2022-03-09T11:19:04.819Z
| -| updated_at |Timestamp representing the date and time when the order was updated in ISO 8601 format.
|2022-08-12T13:34:10.681Z
| -| status |Order status.
Available values: `CREATED`, `PAID`, `CANCELED`, `FULFILLED` | | -| amount |Order amount before applying any discount.
| | -| discount_amount |Sum of all order-level discounts applied to the order.
| | -| items_discount_amount |Sum of all product-specific discounts applied to the order.sum(items, i => i.discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order.total_discount_amount
= discount_amount
+ items_discount_amount
Order amount after applying all the discounts.total_amount
= amount
- total_discount_amount
Array of order items that have been applied to the order. Each order item can show the effects of particular discounts on the item-level.
Array of:Attributes | Description | Example | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
object | The type of object represented by JSON. This object stores information about the | ||||||||||||||||
product_id | A unique identifier that represents the product and is assigned by Voucherify. | prod_5h0wc453_1 | |||||||||||||||
sku_id | A unique identifier that represents the SKU and is assigned by Voucherify. | sku_prod_5h0wc453_1_1 | |||||||||||||||
quantity | Quantity of the item in the cart. | ||||||||||||||||
amount | Represents a total pre-discount amount of order item ( | ||||||||||||||||
discount_amount | The item-level discount applied to the item. | ||||||||||||||||
price | Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000. | ||||||||||||||||
subtotal_amount | Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the | ||||||||||||||||
product | This object stores more information about the related product.
| ||||||||||||||||
sku | This object stores more information about the related SKU.
|
The metadata object stores all custom attributes assigned to the order. A set of key/value pairs that are attached to an order object. Stores additional information about the order in a structured format.
| | -| customer |Object containing information about the customer that is making the purchase.
Attributes | Description | Example |
---|---|---|
id | Unique customer ID of the customer making the purchase. | cust_7iUa6ICKyU6gH40dBU25kQU1 |
object | Type of object represented by the |
Object containing information about the referrer.
Attributes | Description | Example |
---|---|---|
id | Unique referrer ID, who referred the customer making the purchase. | cust_7iUa6ICKyU6gH40dBU25kQU1 |
object | Type of object represented by the referrer object. |
Unique customer ID of the customer making the purchase.
|cust_7iUa6ICKyU6gH40dBU25kQU1
| -| referrer_id |Unique referrer ID.
|cust_nM4jqPiaXUvQdVSA6vTRUnix
| -| object |The type of object represented by JSON. This object stores information about the order
.
Attributes | Description | Example | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
redemption_ID | The property name is the unique redemption ID; i.e.
|
Attributes | Description | Example | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
redemption_ID | The property name is the unique parent redemption ID; i.e.
|
Unique order ID, assigned by Voucherify.
**Example:**ord_GFDbbv2I0wnO0sFUBOOOXPj2
| +| source_id`string` |The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service.
| +| created_at`string` |Timestamp representing the date and time when the order was created in ISO 8601 format.
**Example:**2022-03-09T11:19:04.819Z
| +| updated_at`string` |Timestamp representing the date and time when the order was updated in ISO 8601 format.
**Example:**2022-08-12T13:34:10.681Z
| +| status`string` |Order status.
Available values: `CREATED`, `PAID`, `CANCELED`, `FULFILLED` | +| amount`integer` |Order amount before applying any discount.
| +| discount_amount`integer` |Sum of all order-level discounts applied to the order.
| +| items_discount_amount`integer` |Sum of all product-specific discounts applied to the order.sum(items, i => i.discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order.total_discount_amount
= discount_amount
+ items_discount_amount
Order amount after applying all the discounts.total_amount
= amount
- total_discount_amount
Array of order items that have been applied to the order. Each order item can show the effects of particular discounts on the item-level.
Array of:Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
objectstring | The type of object represented by JSON. This object stores information about the | ||||||||||
product_idstring | A unique identifier that represents the product and is assigned by Voucherify. Example:prod_5h0wc453_1 | ||||||||||
sku_idstring | A unique identifier that represents the SKU and is assigned by Voucherify. Example:sku_prod_5h0wc453_1_1 | ||||||||||
quantityinteger | Quantity of the item in the cart. | ||||||||||
amountinteger | Represents a total pre-discount amount of order item ( | ||||||||||
discount_amountinteger | The item-level discount applied to the item. | ||||||||||
priceinteger | Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000. | ||||||||||
subtotal_amountinteger | Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the | ||||||||||
productobject | This object stores more information about the related product.
| ||||||||||
skuobject | This object stores more information about the related SKU.
|
The metadata object stores all custom attributes assigned to the order. A set of key/value pairs that are attached to an order object. Stores additional information about the order in a structured format.
| +| customer`object` |Object containing information about the customer that is making the purchase.
Attributes | Description |
---|---|
idstring | Unique customer ID of the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 |
objectstring | Type of object represented by the |
Object containing information about the referrer.
Attributes | Description |
---|---|
idstring | Unique referrer ID, who referred the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 |
objectstring | Type of object represented by the referrer object. |
Unique customer ID of the customer making the purchase.
**Example:**cust_7iUa6ICKyU6gH40dBU25kQU1
| +| referrer_id`string` |Unique referrer ID.
**Example:**cust_nM4jqPiaXUvQdVSA6vTRUnix
| +| object`string` |The type of object represented by JSON. This object stores information about the order
.
The property name is the unique redemption ID; i.e. r_0ba186c4824e4881e1
. This object contains information about the redemption of an incentive.
Attributes | Description |
---|---|
datestring | Timestamp representing the date and time when the redemption was created in ISO 8601 format. Example:2022-09-02T17:06:56.649Z |
related_object_typestring | The source of the incentive. Available values:voucher , promotion_tier |
related_object_idstring | Unique ID of the related object that defines the incentive. |
related_object_parent_idstring | Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign. |
The property name is the unique parent redemption ID; i.e. r_0ba186c4824e4881e1
. This object contains information about the redemption of multiple incentives.
Attributes | Description |
---|---|
datestring | Timestamp representing the date and time when the redemption was created in ISO 8601 format. Example:2022-09-02T17:06:56.649Z |
related_object_typestring | The source of the incentive. |
related_object_idstring | Unique ID of the parent redemption. Example:r_0ba186c4824e4881e1 |
stackedarray | Contains a list of unique IDs of child redemptions, which belong to the stacked incentives. |
Unique product ID assigned by Voucherify.
|prod_0b1da8105693710357
| -| source_id |Unique product source ID from your inventory system.
|productSourceID16
| -| name |Unique user-defined product name.
|T-shirt
| -| price |Product unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
| | -| attributes |A list of product attributes whose values you can customize for given SKUs: ["color","size","ranking"]
. Each child SKU can have a unique value for a given attribute.
The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
| | -| image_url |The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
|https://images.com/original.jpg
| -| created_at |Timestamp representing the date and time when the product was created in ISO 8601 format.
|2022-05-23T06:52:55.008Z
| -| updated_at |Timestamp representing the date and time when the product was updated in ISO 8601 format.
|2022-05-23T09:24:07.405Z
| -| object |The type of object represented by JSON. This object stores information about the product
.
Unique product ID assigned by Voucherify.
**Example:**prod_0b1da8105693710357
| +| source_id`string` |Unique product source ID from your inventory system.
**Example:**productSourceID16
| +| name`string` |Unique user-defined product name.
**Example:**T-shirt
| +| price`integer` |Product unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
| +| attributes`array` |A list of product attributes whose values you can customize for given SKUs: ["color","size","ranking"]
. Each child SKU can have a unique value for a given attribute.
The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
| +| image_url`string` |The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
**Example:**https://images.com/original.jpg
| +| created_at`string` |Timestamp representing the date and time when the product was created in ISO 8601 format.
**Example:**2022-05-23T06:52:55.008Z
| +| updated_at`string` |Timestamp representing the date and time when the product was updated in ISO 8601 format.
**Example:**2022-05-23T09:24:07.405Z
| +| object`string` |The type of object represented by JSON. This object stores information about the product
.
The type of object represented by JSON. This object stores information about SKUs.
| +| data_ref`string` |Identifies the name of the JSON property that contains the array of SKUs.
| +| data`array` |A dictionary that contains an array of SKUs.
Array of [SKU Object](#sku-object) | +| total`integer` |Total number of SKUs in the product.
| +## SKU Object +| Attributes | Description | +|:-----|:--------| +| id`string` |A unique identifier that represents the SKU and is assigned by Voucherify.
**Example:**sku_0b1621b319d248b79f
| +| source_id`string` |A unique SKU identifier from your inventory system.
**Example:**sku_source_id_4
| +| product_id`string` |The parent product's unique ID.
**Example:**prod_0b15f6b9f650c16990
| +| sku`string` |Unique user-defined SKU name.
**Example:**Large Pink Shirt
| +| price`integer` |SKU unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
| +| currency`string` |SKU price currency.
**Example:**USD
| +| attributes`object` |The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.
| +| image_url`string` |The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
| +| metadata`object` |The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
| +| created_at`string` |Timestamp representing the date and time when the SKU was created in ISO 8601 format.
**Example:**2022-05-17T10:36:30.187Z
| +| updated_at`string` |Timestamp representing the date and time when the SKU was updated in ISO 8601 format.
**Example:**2022-05-17T10:55:09.137Z
| +| object`string` |The type of object represented by JSON. This object stores information about the SKU
.
A unique identifier that represents the SKU and is assigned by Voucherify.
|sku_0b1621b319d248b79f
| -| source_id |A unique SKU identifier from your inventory system.
|sku_source_id_4
| -| product_id |The parent product's unique ID.
|prod_0b15f6b9f650c16990
| -| sku |Unique user-defined SKU name.
|Large Pink Shirt
| -| price |SKU unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
| | -| currency |SKU price currency.
|USD
| -| attributes |The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.
| | -| image_url |The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
| | -| metadata |The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
| | -| created_at |Timestamp representing the date and time when the SKU was created in ISO 8601 format.
|2022-05-17T10:36:30.187Z
| -| updated_at |Timestamp representing the date and time when the SKU was updated in ISO 8601 format.
|2022-05-17T10:55:09.137Z
| -| object |The type of object represented by JSON. This object stores information about the SKU
.
A unique identifier that represents the SKU and is assigned by Voucherify.
**Example:**sku_0b1621b319d248b79f
| +| source_id`string` |A unique SKU identifier from your inventory system.
**Example:**sku_source_id_4
| +| product_id`string` |The parent product's unique ID.
**Example:**prod_0b15f6b9f650c16990
| +| sku`string` |Unique user-defined SKU name.
**Example:**Large Pink Shirt
| +| price`integer` |SKU unit price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
| +| currency`string` |SKU price currency.
**Example:**USD
| +| attributes`object` |The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.
| +| image_url`string` |The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
| +| metadata`object` |The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
| +| created_at`string` |Timestamp representing the date and time when the SKU was created in ISO 8601 format.
**Example:**2022-05-17T10:36:30.187Z
| +| updated_at`string` |Timestamp representing the date and time when the SKU was updated in ISO 8601 format.
**Example:**2022-05-17T10:55:09.137Z
| +| object`string` |The type of object represented by JSON. This object stores information about the SKU
.
Unique promotion tier ID.
|promo_63fYCt81Aw0h7lzyRkrGZh9p
| -| created_at |Timestamp representing the date and time when the promotion tier was created in ISO 8601 format.
|2021-12-15T11:34:01.333Z
| -| updated_at |Timestamp representing the date and time when the promotion tier was updated in ISO 8601 format.
|2022-02-09T09:20:05.603Z
| -| name |Name of the promotion tier.
| | -| banner |Text to be displayed to your customers on your website.
| | -| action |Contains details about the discount applied by the promotion tier.
Attributes | Description | Example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
discount | The type of discount that will be applied to a customer's order. Any of:Amount
Percentage
Fixed
Unit, single item
Unit, multiple items
Shipping
|
The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.
| | -| hierarchy |The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.
| | -| campaign |Contains details about promotion tier's parent campaign.
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id | Unique campaign ID. | ||||||||||
start_date | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. | 2022-09-22T00:00:00.000Z | |||||||||
expiration_date | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. | 2022-09-30T00:00:00.000Z | |||||||||
validity_timeframe | Recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.
| ||||||||||
validity_day_of_week | Integer array corresponding to the particular days of the week in which the campaign is valid.
| ||||||||||
active | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the
| ||||||||||
category_id | Unique category ID that this campaign belongs to. | cat_0b688929a2476386a6 | |||||||||
object | The type of object represented by the campaign object. This object stores information about the campaign. |
Promotion tier's parent campaign's unique ID.
| | -| active |A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active promotion tierfalse
indicates an inactive promotion tierActivation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.
|2022-09-23T00:00:00.000Z
| -| expiration_date |Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.
|2022-09-26T00:00:00.000Z
| -| validity_timeframe |Set recurrent time periods when the promotion tier is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description | Example |
---|---|---|
interval | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a promotion tier with an | |
duration | Defines the amount of time the promotion tier will be active in ISO 8601 format. For example, a promotion tier with a |
Integer array corresponding to the particular days of the week in which the promotion tier is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayContains statistics about promotion tier redemptions and orders.
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
redemptions | Contains statistics about promotion tier redemptions.
| ||||||||||
orders | Contains statistics about orders related to the promotion tier.
|
The type of object represented by JSON. This object stores information about the promotion tier.
| | -| validation_rule_assignments | | | -| category_id |Promotion tier category ID.
|cat_0c9da30e7116ba6bba
| -| categories |Details about the category assigned to the promotion tier.
| | +## Promotion Tier Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique promotion tier ID.
**Example:**promo_63fYCt81Aw0h7lzyRkrGZh9p
| +| created_at`string` |Timestamp representing the date and time when the promotion tier was created in ISO 8601 format.
**Example:**2021-12-15T11:34:01.333Z
| +| updated_at`string` |Timestamp representing the date and time when the promotion tier was updated in ISO 8601 format.
**Example:**2022-02-09T09:20:05.603Z
| +| name`string` |Name of the promotion tier.
| +| banner`string` |Text to be displayed to your customers on your website.
| +| action`object` |Contains details about the discount applied by the promotion tier.
Attributes | Description |
---|---|
discount | The type of discount that will be applied to a customer's order. Any of: Amount, Percentage, Fixed, Unit, single item, Unit, multiple items, Shipping |
The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.
| +| hierarchy`integer` |The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.
| +| campaign`object` |Contains details about promotion tier's parent campaign.
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
idstring | Unique campaign ID. | ||||||
start_datestring | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. Example:2022-09-22T00:00:00.000Z | ||||||
expiration_datestring | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. Example:2022-09-30T00:00:00.000Z | ||||||
validity_timeframeobject | Recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.
| ||||||
validity_day_of_weekarray | Integer array corresponding to the particular days of the week in which the campaign is valid.
| ||||||
activeboolean | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the
| ||||||
category_idstring | Unique category ID that this campaign belongs to. Example:cat_0b688929a2476386a6 | ||||||
objectstring | The type of object represented by the campaign object. This object stores information about the campaign. |
Promotion tier's parent campaign's unique ID.
| +| active`boolean` |A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active promotion tierfalse
indicates an inactive promotion tierActivation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.
**Example:**2022-09-23T00:00:00.000Z
| +| expiration_date`string` |Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.
**Example:**2022-09-26T00:00:00.000Z
| +| validity_timeframe`object` |Set recurrent time periods when the promotion tier is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description |
---|---|
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a promotion tier with an |
durationstring | Defines the amount of time the promotion tier will be active in ISO 8601 format. For example, a promotion tier with a |
Integer array corresponding to the particular days of the week in which the promotion tier is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayContains statistics about promotion tier redemptions and orders.
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
redemptionsobject | Contains statistics about promotion tier redemptions.
| ||||||
ordersobject | Contains statistics about orders related to the promotion tier.
|
The type of object represented by JSON. This object stores information about the promotion tier.
| +| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| category_id`string` |Promotion tier category ID.
**Example:**cat_0c9da30e7116ba6bba
| +| categories |Details about the category assigned to the promotion tier.
See: [Category Object](#category-object) | +## Amount +| Attributes | Description | +|:-----|:--------| +| type`string` |Applies an amount discount.
| +| amount_off`integer` |Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the amount being calculated by the formula, i.e. the amount_off_formula
parameter is present in the amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the amount off.
100
| +| amount_off_formula`string` |Formula used to calculate the discount.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects:
APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Defines how the discount is applied to the customer's order. The discount effects are defined as follows:
APPLY_TO_ORDER
(discount applies to the total order amount)APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_PROPORTIONALLY
(split discount proportionally to amount)APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY
(split discount proportionally to quantity)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Applies a percentage discount.
| +| amount_limit`string` |Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. This value is definable for the APPLY_TO_ITEMS
discount effect. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600.
Percent taken off the subtotal amount. In case of the percent being calculated by the formula, i.e. the percent_off_formula
parameter is present in the percent definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the percent off.
Formula used to calculate the discount.
| +| effect`string` |Defines how the discount is applied to the customer's order.
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | +## Fixed +| Attributes | Description | +|:-----|:--------| +| type`string` |Sets a fixed total on cart or item(s) and then calculates the discount to apply.
| +| fixed_amount`integer` |Set a fixed valued for an order total or price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the fixed amount being calculated by the formula, i.e. the fixed_amount_formula
parameter is present in the fixed amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.
1000
| +| fixed_amount_formula`string` |Formula used to calculate the discounted price of an item or a new order total.
| +| effect`string` |Effect | Definition |
---|---|
APPLY_TO_ORDER | Sets the order total amount to the value of the fixed amount. The discount value is calculated dynamically during the redemption as it's a difference between the total amount of the customer's order and the fixed amount. For example, if the fixed amount is set to equal $10 and the order amount equals $25, then the calculated discount will be $15. |
APPLY_TO_ITEMS | Sets a new price on items. The total discount amount is dynamically calculated during the redemption and it's a difference between the initial item price and the fixed amount. During the redemption, prices for items will change only if the new price is lower than the original price. If the new product price you set is different from the product price in a collection, then the new product price will be passed during the redemption. If a prodct is in more than one collection, the price is always changed to the lowest price. The new price for products with several SKUs will force the price change for SKUs if their original price is higher than the new price. |
Applies a full value discount to item(s).
| +| unit_off`number` |Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the unit_off_formula
parameter is present in the unit definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the unit value.
1
| +| unit_off_formula`string` |Formula used to calculate the number of units.
| +| unit_type`string` |The product deemed as free, chosen from the product inventory (e.g. time, items).
**Example:**prod_f1r5Tpr0DuC7
| +| effect`string` |Defines how the unit is added to the customer's order.
Available values: `ADD_NEW_ITEMS`, `ADD_MISSING_ITEMS` | +## Unit, multiple items +| Attributes | Description | +|:-----|:--------| +| type`string` |Applies a full value discount to item(s).
| +| effect`string` |Defines the effect for adding multiple item types.
| +| units`array` |Array of objects defining items to be offered for free. Each item type can have a different discount effect assigned.
Array of:Attributes | Description |
---|---|
unit_offinteger | Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the 1 |
unit_off_formulastring | Formula used to calculate the number of units. |
unit_typestring | The product deemed as free, chosen from the product inventory (e.g. time, items). Example:prod_f1r5Tpr0DuC7 |
effectstring | Defines how the unit is added to the customer's order. Available values:ADD_NEW_ITEMS , ADD_MISSING_ITEMS |
Applies a full value discount to item(s).
| +| unit_off`number` |Subtracts 1 shipping item from the subtotal.
| +| unit_type`string` |The shipping product deemed as free.
| +| effect`string` |Defines how the unit is added to the customer's order.
| +## Validation Rule Assignments +| Attributes | Description | +|:-----|:--------| +| object`string` |The type of object represented by JSON. This object stores information about validation rule assignments.
| +| data_ref`string` |Identifies the name of the JSON property that contains the array of validation rule assignments.
| +| data`array` |A dictionary that contains an array of validation rule assignments.
Array of [Validation Rule Assignment Object](#validation-rule-assignment-object) | +| total`integer` |Total number of validation rule assignments.
| +## Category Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique category ID assigned by Voucherify.
| +| name`string` |Category name.
| +| hierarchy`integer` |Category hierarchy.
| +| created_at`string` |Timestamp representing the date and time when the category was created in ISO 8601 format.
**Example:**2022-07-14T10:45:13.156Z
| +| updated_at`string` |Timestamp representing the date and time when the category was updated in ISO 8601 format.
**Example:**2022-08-16T10:52:08.094Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the category.
| +## Validation Rule Assignment Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Validation rule assignment ID.
**Example:**asgm_74F7QZoYbUoljwQO
| +| rule_id`string` |Validation rule ID.
**Example:**val_4j7DCRm2IS59
| +| related_object_id`string` |The resource ID to which the validation rule was assigned.
**Example:**v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT
| +| related_object_type`string` |The type of resource to which the validation rule was assigned.
Available values: `voucher`, `campaign`, `earning_rule`, `reward_assignment`, `promotion_tier`, `distribution` | +| created_at`string` |Timestamp representing the date and time when the validation rule assignment was created in ISO 8601 format.
**Example:**2022-02-17T08:18:15.085Z
| +| object`string` |The type of object represented by the ID.
| [block:html] { diff --git a/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md b/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md index 95a3872c8..61326f329 100644 --- a/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md +++ b/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md @@ -1,6 +1,6 @@ --- title: Publication Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: publications-api slug: publication-object @@ -8,20 +8,90 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique publication ID, assigned by Voucherify.
|pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp
| -| object |The type of object represented by the JSON. This object stores information about the publication.
| | -| created_at |Timestamp representing the date and time when the publication was created in ISO 8601 format.
|2022-09-23T09:57:00.434Z
| -| customer_id |Unique customer ID of the customer receiving the publication.
|cust_eWgXlBBiY6THFRJwX45Iakv4
| -| tracking_id |Customer's source_id
.
The metadata object stores all custom attributes assigned to the publication. A set of key/value pairs that you can attach to a publication object. It can be useful for storing additional information about the publication in a structured format.
| | -| channel |How the publication was originated. It can be your own custom channel or an example value provided here.
Available values: `voucherify-website`, `Dashboard`, `Automation`, `API`, `Braze`, `Reward`, `SMS`, `Email`, `Activecampaign`, `Webhook`, `Intercom`, `Mailchimp`, `Shopify` | | -| source_id |The merchant’s publication ID if it is different from the Voucherify publication ID. It's an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service.
| | -| result |Status of the publication attempt.
Available values: `SUCCESS`, `FAILURE` | | -| customer |Contains information about the customer to whom the publication was directed.
Attributes | Description | Example |
---|---|---|
id | Unique customer ID, assigned by Voucherify. | cust_eWgXlBBiY6THFRJwX45Iakv4 |
name | Customer's name. | |
Customer's email. | ||
source_id | The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service. | |
metadata | A set of custom key/value pairs attached to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. | |
object | The type of object represented by the JSON. This object stores information about the customer. |
Contains information about the voucher being published.
Any of:Attributes | Description | Example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
code | Voucher code. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | The type of object represented by the JSON. This object stores information about the voucher. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign | Name of voucher's parent campaign. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | Any of: Amount
Percentage
Fixed
Unit, single item
Unit, multiple items
Shipping
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_referral_code | Whether this voucher is a referral code. |
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
code | Voucher code. | ||||||||||
object | The type of object represented by the JSON. This object stores information about the voucher. | ||||||||||
campaign | Name of voucher's parent campaign. | ||||||||||
loyalty_card | Contains information about the loyalty card being published.
| ||||||||||
is_referral_code | Whether this voucher is a referral code. |
Attributes | Description | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
code | Voucher code. | |||||||||||||
object | The type of object represented by the JSON. This object stores information about the voucher. | |||||||||||||
campaign | Name of voucher's parent campaign. | |||||||||||||
gift | Contains information about the gift card being published.
| |||||||||||||
is_referral_code | Whether this voucher is a referral code. |
Contains the unique internal voucher ID that was assigned by Voucherify.
| | +## Publication Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique publication ID, assigned by Voucherify.
**Example:**pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp
| +| object`string` |The type of object represented by the JSON. This object stores information about the publication.
| +| created_at`string` |Timestamp representing the date and time when the publication was created in ISO 8601 format.
**Example:**2022-09-23T09:57:00.434Z
| +| customer_id`string` |Unique customer ID of the customer receiving the publication.
**Example:**cust_eWgXlBBiY6THFRJwX45Iakv4
| +| tracking_id`string` |Customer's source_id
.
The metadata object stores all custom attributes assigned to the publication. A set of key/value pairs that you can attach to a publication object. It can be useful for storing additional information about the publication in a structured format.
| +| channel`string` |How the publication was originated. It can be your own custom channel or an example value provided here.
Available values: `voucherify-website`, `Dashboard`, `Automation`, `API`, `Braze`, `Reward`, `SMS`, `Email`, `Activecampaign`, `Webhook`, `Intercom`, `Mailchimp`, `Shopify` | +| source_id`string` |The merchant’s publication ID if it is different from the Voucherify publication ID. It's an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service.
| +| result`string` |Status of the publication attempt.
Available values: `SUCCESS`, `FAILURE` | +| customer`object` |Contains information about the customer to whom the publication was directed.
Attributes | Description |
---|---|
idstring | Unique customer ID, assigned by Voucherify. Example:cust_eWgXlBBiY6THFRJwX45Iakv4 |
namestring | Customer's name. |
emailstring | Customer's email. |
source_idstring | The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service. |
metadataobject | A set of custom key/value pairs attached to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. |
objectstring | The type of object represented by the JSON. This object stores information about the customer. |
Contains information about the voucher being published.
Any of: [Discount Voucher](#discount-voucher), [Loyalty Card](#loyalty-card), [Gift Card](#gift-card) | +| vouchers_id`array` |Contains the unique internal voucher ID that was assigned by Voucherify.
| +## Discount Voucher +| Attributes | Description | +|:-----|:--------| +| code`string` |Voucher code.
| +| object`string` |The type of object represented by the JSON. This object stores information about the voucher.
| +| campaign`string` |Name of voucher's parent campaign.
| +| discount | Any of: [Amount](#amount), [Percentage](#percentage), [Fixed](#fixed), [Unit, single item](#unit-single-item), [Unit, multiple items](#unit-multiple-items), [Shipping](#shipping) | +| is_referral_code`boolean` |Whether this voucher is a referral code.
| +## Loyalty Card +| Attributes | Description | +|:-----|:--------| +| code`string` |Voucher code.
| +| object`string` |The type of object represented by the JSON. This object stores information about the voucher.
| +| campaign`string` |Name of voucher's parent campaign.
| +| loyalty_card`object` |Contains information about the loyalty card being published.
Attributes | Description |
---|---|
pointsinteger | The incremental points to be added to the loyalty card as the initial balance on the card. |
balanceinteger | The points balance after the incremental points are added to the loyalty card. |
Whether this voucher is a referral code.
| +## Gift Card +| Attributes | Description | +|:-----|:--------| +| code`string` |Voucher code.
| +| object`string` |The type of object represented by the JSON. This object stores information about the voucher.
| +| campaign`string` |Name of voucher's parent campaign.
| +| gift`object` |Contains information about the gift card being published.
Attributes | Description |
---|---|
amountinteger | The incremental amount to be added as the initial balance on the gift card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. |
balanceinteger | The credit balance on the gift card after the initial incremental amount is added to the gift card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. |
effectstring | How the credits are applied to the customer's order. Available values:APPLY_TO_ORDER , APPLY_TO_ITEMS |
Whether this voucher is a referral code.
| +## Amount +| Attributes | Description | +|:-----|:--------| +| type`string` |Applies an amount discount.
| +| amount_off`integer` |Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the amount being calculated by the formula, i.e. the amount_off_formula
parameter is present in the amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the amount off.
100
| +| amount_off_formula`string` |Formula used to calculate the discount.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects:
APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Defines how the discount is applied to the customer's order. The discount effects are defined as follows:
APPLY_TO_ORDER
(discount applies to the total order amount)APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_PROPORTIONALLY
(split discount proportionally to amount)APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY
(split discount proportionally to quantity)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Applies a percentage discount.
| +| amount_limit`string` |Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. This value is definable for the APPLY_TO_ITEMS
discount effect. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600.
Percent taken off the subtotal amount. In case of the percent being calculated by the formula, i.e. the percent_off_formula
parameter is present in the percent definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the percent off.
Formula used to calculate the discount.
| +| effect`string` |Defines how the discount is applied to the customer's order.
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | +## Fixed +| Attributes | Description | +|:-----|:--------| +| type`string` |Sets a fixed total on cart or item(s) and then calculates the discount to apply.
| +| fixed_amount`integer` |Set a fixed valued for an order total or price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the fixed amount being calculated by the formula, i.e. the fixed_amount_formula
parameter is present in the fixed amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.
1000
| +| fixed_amount_formula`string` |Formula used to calculate the discounted price of an item or a new order total.
| +| effect`string` |Effect | Definition |
---|---|
APPLY_TO_ORDER | Sets the order total amount to the value of the fixed amount. The discount value is calculated dynamically during the redemption as it's a difference between the total amount of the customer's order and the fixed amount. For example, if the fixed amount is set to equal $10 and the order amount equals $25, then the calculated discount will be $15. |
APPLY_TO_ITEMS | Sets a new price on items. The total discount amount is dynamically calculated during the redemption and it's a difference between the initial item price and the fixed amount. During the redemption, prices for items will change only if the new price is lower than the original price. If the new product price you set is different from the product price in a collection, then the new product price will be passed during the redemption. If a prodct is in more than one collection, the price is always changed to the lowest price. The new price for products with several SKUs will force the price change for SKUs if their original price is higher than the new price. |
Applies a full value discount to item(s).
| +| unit_off`number` |Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the unit_off_formula
parameter is present in the unit definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the unit value.
1
| +| unit_off_formula`string` |Formula used to calculate the number of units.
| +| unit_type`string` |The product deemed as free, chosen from the product inventory (e.g. time, items).
**Example:**prod_f1r5Tpr0DuC7
| +| effect`string` |Defines how the unit is added to the customer's order.
Available values: `ADD_NEW_ITEMS`, `ADD_MISSING_ITEMS` | +## Unit, multiple items +| Attributes | Description | +|:-----|:--------| +| type`string` |Applies a full value discount to item(s).
| +| effect`string` |Defines the effect for adding multiple item types.
| +| units`array` |Array of objects defining items to be offered for free. Each item type can have a different discount effect assigned.
Array of:Attributes | Description |
---|---|
unit_offinteger | Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the 1 |
unit_off_formulastring | Formula used to calculate the number of units. |
unit_typestring | The product deemed as free, chosen from the product inventory (e.g. time, items). Example:prod_f1r5Tpr0DuC7 |
effectstring | Defines how the unit is added to the customer's order. Available values:ADD_NEW_ITEMS , ADD_MISSING_ITEMS |
Applies a full value discount to item(s).
| +| unit_off`number` |Subtracts 1 shipping item from the subtotal.
| +| unit_type`string` |The shipping product deemed as free.
| +| effect`string` |Defines how the unit is added to the customer's order.
| [block:html] { diff --git a/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility-Client-Side.md b/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility-Client-Side.md index 97eac4b21..8e25b6d3c 100644 --- a/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility-Client-Side.md +++ b/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility-Client-Side.md @@ -1,5 +1,5 @@ --- -title: Check Eligibility (client-side) [Beta] +title: Check Eligibility (client-side) type: endpoint categorySlug: voucherify-api parentDocSlug: qualifications-api @@ -10,6 +10,6 @@ order: 3 [block:html] { - "html": "" + "html": "" } [/block] diff --git a/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility.md b/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility.md index 28b8fbb94..5d37bca38 100644 --- a/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility.md +++ b/docs/reference-docs/QUALIFICATIONS-API-Check-Eligibility.md @@ -1,5 +1,5 @@ --- -title: Check Eligibility [Beta] +title: Check Eligibility type: endpoint categorySlug: voucherify-api parentDocSlug: qualifications-api @@ -10,6 +10,6 @@ order: 2 [block:html] { - "html": "" + "html": "" } [/block] diff --git a/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md b/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md index 1e40adadb..429a710a0 100644 --- a/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md +++ b/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md @@ -1,6 +1,6 @@ --- -title: Qualification Object [Beta] -type: endpoint +title: Qualification Object +type: basic categorySlug: voucherify-api parentDocSlug: qualifications-api slug: qualification-object @@ -8,8 +8,49 @@ hidden: false order: 1 --- +## Qualification object +| Attributes | Description | +|:-----|:--------| +| redeemables | See: [Redeemables](#redeemables) | +| tracking_id`string` |This identifier is generated during voucher qualification based on your internal id (e.g., email, database ID). This is a hashed customer source ID.
| +| order`object` |The order object sent in the request.
See: [Order object](#order-object) | +| stacking_rules | See: [Examine Qualification Stacking Rules](#examine-qualification-stacking-rules) | +## Redeemables +| Attributes | Description | +|:-----|:--------| +| object`string` |The type of object represented by JSON. Default is list
.
Identifies the name of the attribute that contains the array of qualified redeemables.
| +| data`array` |Array of qualified redeemables.
| +| total`integer` |The number of redeemables returned in the API request.
**Example:**5
| +| has_more`boolean` |As results are always limited, the has_more
flag indicates whether there are more records for given parameters. This let's you know if you are able to run another request (with different options) to get more records returned in the results.
Unique order ID, assigned by Voucherify.
**Example:**ord_GFDbbv2I0wnO0sFUBOOOXPj2
| +| source_id`string` |The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service.
| +| created_at`string` |Timestamp representing the date and time when the order was created in ISO 8601 format.
**Example:**2022-03-09T11:19:04.819Z
| +| updated_at`string` |Timestamp representing the date and time when the order was updated in ISO 8601 format.
**Example:**2022-08-12T13:34:10.681Z
| +| status`string` |Order status.
Available values: `CREATED`, `PAID`, `CANCELED`, `FULFILLED` | +| amount`integer` |Order amount before applying any discount.
| +| discount_amount`integer` |Sum of all order-level discounts applied to the order.
| +| items_discount_amount`integer` |Sum of all product-specific discounts applied to the order.sum(items, i => i.discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order.total_discount_amount
= discount_amount
+ items_discount_amount
Order amount after applying all the discounts.total_amount
= amount
- total_discount_amount
Array of order items that have been applied to the order. Each order item can show the effects of particular discounts on the item-level.
Array of:Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
objectstring | The type of object represented by JSON. This object stores information about the | ||||||||||
product_idstring | A unique identifier that represents the product and is assigned by Voucherify. Example:prod_5h0wc453_1 | ||||||||||
sku_idstring | A unique identifier that represents the SKU and is assigned by Voucherify. Example:sku_prod_5h0wc453_1_1 | ||||||||||
quantityinteger | Quantity of the item in the cart. | ||||||||||
amountinteger | Represents a total pre-discount amount of order item ( | ||||||||||
discount_amountinteger | The item-level discount applied to the item. | ||||||||||
priceinteger | Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000. | ||||||||||
subtotal_amountinteger | Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the | ||||||||||
productobject | This object stores more information about the related product.
| ||||||||||
skuobject | This object stores more information about the related SKU.
|
The metadata object stores all custom attributes assigned to the order. A set of key/value pairs that are attached to an order object. Stores additional information about the order in a structured format.
| +| customer`object` |Object containing information about the customer that is making the purchase.
Attributes | Description |
---|---|
idstring | Unique customer ID of the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 |
objectstring | Type of object represented by the |
Object containing information about the referrer.
Attributes | Description |
---|---|
idstring | Unique referrer ID, who referred the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 |
objectstring | Type of object represented by the referrer object. |
Unique customer ID of the customer making the purchase.
**Example:**cust_7iUa6ICKyU6gH40dBU25kQU1
| +| referrer_id`string` |Unique referrer ID.
**Example:**cust_nM4jqPiaXUvQdVSA6vTRUnix
| +| object`string` |The type of object represented by JSON. This object stores information about the order
.
Defines how many redeemables can be sent with one stacking request. We have extended the maximum value from 5 to 30 (comment: but more redeemables means more processing time!). Default limit is 30
.
Defines how many of sent redeemables will be actually applied to the order (e.g. user can select 30 discounts but only 5 will be applied to the order, the remaining will be marked as SKIPPED). Default limit is 5
.
Unique reward assignment ID, assigned by Voucherify.
|rewa_PbIRoMXpwe5QhobW4JKu0VjH
| -| reward_id |Associated reward ID.
|rew_C7wS9eHFDN4CIbXI5PpLSkGY
| -| related_object_id |Related object ID to which the reward was assigned.
|camp_wciTvaOfYmAa3EmIIW3QpXXZ
| -| related_object_type |Related object type to which the reward was assigned.
|campaign
| -| parameters |Defines the cost of the reward.
Attributes | Description | Example | ||||||
---|---|---|---|---|---|---|---|---|
loyalty | Defines the equivalent points value of the reward.
|
Timestamp representing the date and time when the reward assignment was created in ISO 8601 format.
|2022-08-11T14:49:22.586Z
| -| updated_at |Timestamp representing the date and time when the reward assignment was updated in ISO 8601 format.
|2022-08-11T16:01:34.885Z
| -| object |The type of object represented by the JSON. This object stores information about the reward assignment.
| | +## Reward Assignment Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique reward assignment ID, assigned by Voucherify.
**Example:**rewa_PbIRoMXpwe5QhobW4JKu0VjH
| +| reward_id`string` |Associated reward ID.
**Example:**rew_C7wS9eHFDN4CIbXI5PpLSkGY
| +| related_object_id`string` |Related object ID to which the reward was assigned.
**Example:**camp_wciTvaOfYmAa3EmIIW3QpXXZ
| +| related_object_type`string` |Related object type to which the reward was assigned.
**Example:**campaign
| +| parameters`object` |Defines the cost of the reward.
Attributes | Description | ||||
---|---|---|---|---|---|
loyaltyobject | Defines the equivalent points value of the reward.
|
Timestamp representing the date and time when the reward assignment was created in ISO 8601 format.
**Example:**2022-08-11T14:49:22.586Z
| +| updated_at`string` |Timestamp representing the date and time when the reward assignment was updated in ISO 8601 format.
**Example:**2022-08-11T16:01:34.885Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the reward assignment.
| [block:html] { diff --git a/docs/reference-docs/REWARDS-API-Reward-Object.md b/docs/reference-docs/REWARDS-API-Reward-Object.md index d9adb7b30..6b618a738 100644 --- a/docs/reference-docs/REWARDS-API-Reward-Object.md +++ b/docs/reference-docs/REWARDS-API-Reward-Object.md @@ -1,6 +1,6 @@ --- title: Reward Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: rewards-api slug: reward-object @@ -8,19 +8,49 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique reward ID, assigned by Voucherify.
|rew_nIy4gHpQHle2c3pNMwuj7G6j
| -| name |Reward name.
| | -| type |Reward type.
Available values: `CAMPAIGN`, `COIN`, `MATERIAL` | | -| parameters |Defines how the reward is generated.
One of:Attributes | Description | Example | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
campaign | Objects stores information about the campaign related to the reward. Any of:Discount Coupons
Gift Vouchers
Points on loyalty card
|
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
coin | Defines the ratio by mapping the number of loyalty points in
|
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
product | Contains information about the product given as a reward.
|
Configurable for material rewards. The number of units of the product that you want to share as reward.
| | -| redeemed |Defines the number of already invoked (successful) reward redemptions.
| | -| attributes |These properties are configurable for material rewards.
Attributes | Description | Example |
---|---|---|
image_url | The HTTPS URL pointing to the .png or .jpg file. | |
description | An arbitrary string that you can attach to a material reward. |
Timestamp representing the date and time when the reward was created in ISO 8601 format.
|2022-08-11T14:49:22.586Z
| -| updated_at |Timestamp representing the date and time when the reward was updated in ISO 8601 format.
|2022-08-11T16:01:34.885Z
| -| metadata |The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format.
| | -| object |The type of object represented by the JSON. This object stores information about the reward.
| | +## Reward Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique reward ID, assigned by Voucherify.
**Example:**rew_nIy4gHpQHle2c3pNMwuj7G6j
| +| name`string` |Reward name.
| +| type`string` |Reward type.
Available values: `CAMPAIGN`, `COIN`, `MATERIAL` | +| parameters |Defines how the reward is generated.
One of: [Digital](#digital), [Pay with Points](#pay-with-points), [Material](#material) | +| stock`integer` |Configurable for material rewards. The number of units of the product that you want to share as reward.
| +| redeemed`integer` |Defines the number of already invoked (successful) reward redemptions.
| +| attributes`object` |These properties are configurable for material rewards.
Attributes | Description |
---|---|
image_urlstring | The HTTPS URL pointing to the .png or .jpg file. |
descriptionstring | An arbitrary string that you can attach to a material reward. |
Timestamp representing the date and time when the reward was created in ISO 8601 format.
**Example:**2022-08-11T14:49:22.586Z
| +| updated_at`string,null` |Timestamp representing the date and time when the reward was updated in ISO 8601 format.
**Example:**2022-08-11T16:01:34.885Z
| +| metadata`object` |The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format.
| +| object`string` |The type of object represented by the JSON. This object stores information about the reward.
| +## Digital +| Attributes | Description | +|:-----|:--------| +| campaign |Objects stores information about the campaign related to the reward.
Any of: [Discount Coupons](#discount-coupons), [Gift Vouchers](#gift-vouchers), [Points on loyalty card](#points-on-loyalty-card) | +## Pay with Points +| Attributes | Description | +|:-----|:--------| +| coin`object` |Defines the ratio by mapping the number of loyalty points in points_ratio
to a predefined cash amount in exchange_ratio
.
Attributes | Description |
---|---|
exchange_ratiointeger | The cash equivalent of the points defined in the |
points_ratiointeger | The number of loyalty points that will map to the predefined cash amount defined by the |
Contains information about the product given as a reward.
Attributes | Description |
---|---|
idstring | Unique product ID, assigned by Voucherify. Example:prod_0b7d7dfb05cbe5c616 |
sku_idstring,null | Unique SKU ID, assigned by Voucherify, of the SKU given as a reward. Example:sku_0b7d7dfb090be5c619 |
Unique campaign ID, assigned by Voucherify.
**Example:**camp_13BbZ0kQsNinhqsX3wUts2UP
| +| type`string` |Campaign type.
| +## Gift Vouchers +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique campaign ID, assigned by Voucherify.
**Example:**camp_13BbZ0kQsNinhqsX3wUts2UP
| +| balance`integer` |The incremental amout to be added to the current balance on the gift card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
| +| type`string` |Campaign type.
| +## Points on loyalty card +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique campaign ID, assigned by Voucherify.
**Example:**camp_13BbZ0kQsNinhqsX3wUts2UP
| +| balance`integer` |The incremental points to be added to the current balance on the loyalty card.
| +| type`string` |Campaign type.
| [block:html] { diff --git a/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md b/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md index b34373045..ff18ee0c0 100644 --- a/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md +++ b/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md @@ -1,6 +1,6 @@ --- title: Customer Segment Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: segments-api slug: customer-segment-object @@ -8,16 +8,16 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique segment ID.
|seg_1wc52c5z6r1kQ81brO8j9Hk2
| -| name |Segment name.
| | -| created_at |Timestamp representing the date and time when the segment was created in ISO 8601 format.
|2022-05-12T13:01:56.896Z
| -| type |Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers).
Available values: `auto-update`, `static` | | -| filter |Defines a set of criteria for an auto-update
segment type.
The type of object represented by JSON. This object stores information about the customer segment.
| | - +## Customer Segment Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique segment ID.
**Example:**seg_1wc52c5z6r1kQ81brO8j9Hk2
| +| name`string` |Segment name.
| +| created_at`string` |Timestamp representing the date and time when the segment was created in ISO 8601 format.
**Example:**2022-05-12T13:01:56.896Z
| +| type`string` |Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers).
Available values: `auto-update`, `static` | +| filter`object,null` |Defines a set of criteria for an auto-update
segment type.
The type of object represented by JSON. This object stores information about the customer segment.
| [block:html] { diff --git a/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md b/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md index 6d9f14863..bbd79fbee 100644 --- a/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md +++ b/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md @@ -1,6 +1,6 @@ --- title: Stackable Redemptions Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: stackable-discounts-api slug: stackable-redemptions-object @@ -8,11 +8,40 @@ hidden: false order: 3 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| redemptions | | | -| parent_redemption |This is an object representing a stacked redemption.
Attributes | Description | Example | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Unique redemption ID. | r_0bc92f81a6801f9bca | |||||||||||||||||||||
object | The type of object represented by the JSON. This object stores information about the | ||||||||||||||||||||||
date | Timestamp in ISO 8601 format indicating when the redemption occured. | 2022-10-03T12:24:58.008Z | |||||||||||||||||||||
customer_id | Unique customer ID of the redeeming customer. | cust_i8t5Tt6eiKG5K79KQlJ0Vs64 | |||||||||||||||||||||
tracking_id | Hashed customer source ID. | track_fxEMFiLowFHg== | |||||||||||||||||||||
metadata | The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption. | ||||||||||||||||||||||
result | Redemption result. Available values:SUCCESS , FAILURE | ||||||||||||||||||||||
order | Defines the details of the order that is related to the redemption. | ||||||||||||||||||||||
customer | Defines the customer making the stacked redemption.
| ||||||||||||||||||||||
related_object_type | Defines the related object. Available values:redemption | ||||||||||||||||||||||
related_object_id | Unique related object ID assigned by Voucherify, i.e. r_0c5d07222e08a34ace for a redemption. | ||||||||||||||||||||||
voucher |
Contains the order details associated with the redemption.
| | +## Stackable Redemptions Response Body +| Attributes | Description | +|:-----|:--------| +| redemptions`array` | | +| parent_redemption`object` |This is an object representing a stacked redemption.
Attributes | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
idstring | Unique redemption ID. Example:r_0bc92f81a6801f9bca | ||||||||||||||
objectstring | The type of object represented by the JSON. This object stores information about the | ||||||||||||||
datestring | Timestamp in ISO 8601 format indicating when the redemption occured. Example:2022-10-03T12:24:58.008Z | ||||||||||||||
customer_idstring | Unique customer ID of the redeeming customer. Example:cust_i8t5Tt6eiKG5K79KQlJ0Vs64 | ||||||||||||||
tracking_idstring | Hashed customer source ID. Example:track_fxEMFiLowFHg== | ||||||||||||||
metadataobject | The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption. | ||||||||||||||
resultstring | Redemption result. Available values:SUCCESS , FAILURE | ||||||||||||||
order | Defines the details of the order that is related to the redemption. See: Order | ||||||||||||||
customerobject | Defines the customer making the stacked redemption.
| ||||||||||||||
related_object_typestring | Defines the related object. Available values:redemption | ||||||||||||||
related_object_idstring | Unique related object ID assigned by Voucherify, i.e. r_0c5d07222e08a34ace for a redemption. | ||||||||||||||
vouchernull |
Contains the order details associated with the redemption.
See: [Order](#order) | +## Order +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique order ID, assigned by Voucherify.
**Example:**ord_OLWs41pBk7VFn6ZTyX9U6keh
| +| source_id`string` |The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service.
| +| created_at`string` |Timestamp representing the date and time when the order was created in ISO 8601 format.
**Example:**2022-10-06T11:40:48.705Z
| +| updated_at`string` |Timestamp representing the date and time when the order was updated in ISO 8601 format.
**Example:**2022-10-06T11:47:20.760Z
| +| status`string` |Order status.
Available values: `CREATED`, `PAID`, `CANCELED`, `FULFILLED` | +| amount`integer` |Order amount before applying any discount.
| +| discount_amount`integer` |Sum of all order-level discounts applied to the order.
| +| items_discount_amount`integer` |Sum of all product-specific discounts applied to the order.sum(items, i => i.discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order.total_discount_amount
= discount_amount
+ items_discount_amount
Order amount after applying all the discounts.total_amount
= amount
- total_discount_amount
This field shows the sum of all order-level discounts applied.
| +| items_applied_discount_amount`integer` |Sum of all product-specific discounts applied.sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order.total_applied_discount_amount
= applied_discount_amount
+ items_applied_discount_amount
Array of order items that have been applied to the order. Each order item can show the effects of particular discounts on the item-level.
Array of:Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
objectstring | The type of object represented by JSON. This object stores information about the | ||||||||||
product_idstring | A unique identifier that represents the product and is assigned by Voucherify. Example:prod_5h0wc453_1 | ||||||||||
sku_idstring | A unique identifier that represents the SKU and is assigned by Voucherify. Example:sku_prod_5h0wc453_1_1 | ||||||||||
quantityinteger | Quantity of the item in the cart. | ||||||||||
amountinteger | Represents a total pre-discount amount of order item ( | ||||||||||
discount_amountinteger | The item-level discount applied to the item. | ||||||||||
applied_discount_amountinteger | The item-level discount applied to the item. | ||||||||||
priceinteger | Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000. | ||||||||||
subtotal_amountinteger | Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the | ||||||||||
productobject | This object stores more information about the related product.
| ||||||||||
skuobject | This object stores more information about the related SKU.
|
The metadata object stores all custom attributes assigned to the order. A set of key/value pairs that are att to an order object. Stores additional information about the order in a structured format.
| +| customer`object` |Object containing information about the customer that is making the purchase.
Attributes | Description |
---|---|
idstring | Unique customer ID of the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 |
objectstring | Type of object represented by the |
Object containing information about the referrer.
Attributes | Description |
---|---|
idstring | Unique referrer ID, who referred the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 |
objectstring | Type of object represented by the |
Unique customer ID of the customer making the purchase.
**Example:**cust_7iUa6ICKyU6gH40dBU25kQU1
| +| referrer_id`string` |Unique referrer ID.
**Example:**cust_nM4jqPiaXUvQdVSA6vTRUnix
| +| object`string` |The type of object represented by JSON. This object stores information about the order
.
Lists details related to the redemption
See: [Stacked Redemption](#stacked-redemption) | +## Stacked Redemption +| Attributes | Description | +|:-----|:--------| +| redemption_ID`object` |The property name is the unique parent redemption ID; i.e. r_0ba186c4824e4881e1
. This object contains information about the redemption of multiple incentives.
Attributes | Description |
---|---|
datestring | Timestamp representing the date and time when the redemption was created in ISO 8601 format. Example:2022-09-02T17:06:56.649Z |
related_object_typestring | The source of the incentive. |
related_object_idstring | Unique ID of the parent redemption. Example:r_0ba186c4824e4881e1 |
stackedarray | Contains a list of unique IDs of child redemptions, which belong to the stacked incentives. |
Validation rule assignment ID.
|asgm_74F7QZoYbUoljwQO
| -| rule_id |Validation rule ID.
|val_4j7DCRm2IS59
| -| related_object_id |The resource ID to which the validation rule was assigned.
|v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT
| -| related_object_type |The type of resource to which the validation rule was assigned.
Available values: `voucher`, `campaign`, `earning_rule`, `reward_assignment`, `promotion_tier`, `distribution` | | -| created_at |Timestamp representing the date and time when the validation rule assignment was created in ISO 8601 format.
|2022-02-17T08:18:15.085Z
| -| object |The type of object represented by the ID.
| | +## Validation Rule Assignment Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Validation rule assignment ID.
**Example:**asgm_74F7QZoYbUoljwQO
| +| rule_id`string` |Validation rule ID.
**Example:**val_4j7DCRm2IS59
| +| related_object_id`string` |The resource ID to which the validation rule was assigned.
**Example:**v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT
| +| related_object_type`string` |The type of resource to which the validation rule was assigned.
Available values: `voucher`, `campaign`, `earning_rule`, `reward_assignment`, `promotion_tier`, `distribution` | +| created_at`string` |Timestamp representing the date and time when the validation rule assignment was created in ISO 8601 format.
**Example:**2022-02-17T08:18:15.085Z
| +| object`string` |The type of object represented by the ID.
| [block:html] { diff --git a/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md b/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md index 931d6a277..703c3ad51 100644 --- a/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md +++ b/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md @@ -1,6 +1,6 @@ --- title: Validation Rule Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: validation-rules-api slug: validation-rule-object @@ -8,18 +8,19 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Unique validation rule ID.
|val_eR1c41hu0vUU
| -| name |Custom, unique name for set of validation rules.
|Business Validation Rule
| -| rules |Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consequtively beginning from 1
. The values are objects containing the rule conditions.
Attributes | Description | Example | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Defines the rule.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logic | Defines the logic between the rules. | (1 and 2) and (3) |
Contains the error message returned from API when validation / redemption fails to meet requirements of defined rules.
Attributes | Description | Example |
---|---|---|
message | The error message returned from API when validation / redemption fails to meet requirements of defined rules. |
Attributes | Description | Example | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
excluded | Defines which items are excluded from a discount. Array of:
| ||||||||||||||||||||||
included | Defines which items are included in a discount. Array of:
| ||||||||||||||||||||||
included_all | Indicates whether all items are included in the discount. |
Timestamp representing the date and time when the validation rule was created in ISO 8601 format.
|2022-03-23T07:44:00.444Z
| -| updated_at |Timestamp representing the date and time when the validation rule was updated in ISO 8601 format.
|2022-04-26T08:35:54.960Z
| -| type |Type of validation rule.
Available values: `basic`, `advanced`, `complex` | | -| context_type |Validation rule context type.
Context Type | Definition |
---|---|
earning_rule.order.paid | |
earning_rule.custom_event | |
earning_rule.customer.segment.entered | |
campaign.discount_coupons | |
campaign.discount_coupons.discount.apply_to_order | |
campaign.discount_coupons.discount.apply_to_items | |
campaign.discount_coupons.discount.apply_to_items_proportionally | |
campaign.discount_coupons.discount.apply_to_items_proportionally_by_quantity | |
campaign.discount_coupons.discount.fixed.apply_to_items | |
campaign.gift_vouchers | |
campaign.gift_vouchers.gift.apply_to_order | |
campaign.gift_vouchers.gift.apply_to_items | |
campaign.referral_program | |
campaign.referral_program.discount.apply_to_order | |
campaign.referral_program.discount.apply_to_items | |
campaign.referral_program.discount.apply_to_items_proportionally | |
campaign.referral_program.discount.apply_to_items_proportionally_by_quantity | |
campaign.referral_program.discount.fixed.apply_to_items | |
campaign.promotion | |
campaign.promotion.discount.apply_to_order | |
campaign.promotion.discount.apply_to_items | |
campaign.promotion.discount.apply_to_items_proportionally | |
campaign.promotion.discount.apply_to_items_proportionally_by_quantity | |
campaign.promotion.discount.fixed.apply_to_items | |
campaign.loyalty_program | |
campaign.lucky_draw | |
voucher.discount_voucher | |
voucher.discount_voucher.discount.apply_to_order | |
voucher.discount_voucher.discount.apply_to_items | |
voucher.discount_voucher.discount.apply_to_items_proportionally | |
voucher.discount_voucher.discount.apply_to_items_proportionally_by_quantity | |
voucher.discount_voucher.discount.fixed.apply_to_items | |
voucher.gift_voucher | |
voucher.gift_voucher.gift.apply_to_order | |
voucher.gift_voucher.gift.apply_to_items | |
voucher.loyalty_card | |
voucher.lucky_draw_code | |
distribution.custom_event | |
reward_assignment.pay_with_points | |
global |
The type of object represented by JSON. This object stores information about the validation rule.
| | +## Validation Rule Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Unique validation rule ID.
**Example:**val_eR1c41hu0vUU
| +| name`string` |Custom, unique name for set of validation rules.
**Example:**Business Validation Rule
| +| rules`object` |Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consequtively beginning from 1
. The values are objects containing the rule conditions.
Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1object | Defines the rule.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logicstring | Defines the logic between the rules. Example:(1 and 2) and (3) |
Contains the error message returned from API when validation / redemption fails to meet requirements of defined rules.
Attributes | Description |
---|---|
messagestring | The error message returned from API when validation / redemption fails to meet requirements of defined rules. |
Attributes | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
excludedarray | Defines which items are excluded from a discount. Array of:
| ||||||||||||||
includedarray | Defines which items are included in a discount. Array of:
| ||||||||||||||
included_allboolean | Indicates whether all items are included in the discount. |
Timestamp representing the date and time when the validation rule was created in ISO 8601 format.
**Example:**2022-03-23T07:44:00.444Z
| +| updated_at`string` |Timestamp representing the date and time when the validation rule was updated in ISO 8601 format.
**Example:**2022-04-26T08:35:54.960Z
| +| type`string` |Type of validation rule.
Available values: `basic`, `advanced`, `complex` | +| context_type`string` |Validation rule context type.
Context Type | Definition |
---|---|
earning_rule.order.paid | |
earning_rule.custom_event | |
earning_rule.customer.segment.entered | |
campaign.discount_coupons | |
campaign.discount_coupons.discount.apply_to_order | |
campaign.discount_coupons.discount.apply_to_items | |
campaign.discount_coupons.discount.apply_to_items_proportionally | |
campaign.discount_coupons.discount.apply_to_items_proportionally_by_quantity | |
campaign.discount_coupons.discount.fixed.apply_to_items | |
campaign.gift_vouchers | |
campaign.gift_vouchers.gift.apply_to_order | |
campaign.gift_vouchers.gift.apply_to_items | |
campaign.referral_program | |
campaign.referral_program.discount.apply_to_order | |
campaign.referral_program.discount.apply_to_items | |
campaign.referral_program.discount.apply_to_items_proportionally | |
campaign.referral_program.discount.apply_to_items_proportionally_by_quantity | |
campaign.referral_program.discount.fixed.apply_to_items | |
campaign.promotion | |
campaign.promotion.discount.apply_to_order | |
campaign.promotion.discount.apply_to_items | |
campaign.promotion.discount.apply_to_items_proportionally | |
campaign.promotion.discount.apply_to_items_proportionally_by_quantity | |
campaign.promotion.discount.fixed.apply_to_items | |
campaign.loyalty_program | |
campaign.lucky_draw | |
voucher.discount_voucher | |
voucher.discount_voucher.discount.apply_to_order | |
voucher.discount_voucher.discount.apply_to_items | |
voucher.discount_voucher.discount.apply_to_items_proportionally | |
voucher.discount_voucher.discount.apply_to_items_proportionally_by_quantity | |
voucher.discount_voucher.discount.fixed.apply_to_items | |
voucher.gift_voucher | |
voucher.gift_voucher.gift.apply_to_order | |
voucher.gift_voucher.gift.apply_to_items | |
voucher.loyalty_card | |
voucher.lucky_draw_code | |
distribution.custom_event | |
reward_assignment.pay_with_points | |
global |
The type of object represented by JSON. This object stores information about the validation rule.
| [block:html] { diff --git a/docs/reference-docs/VOUCHERS-API-Voucher-Object.md b/docs/reference-docs/VOUCHERS-API-Voucher-Object.md index 7bf9ecaab..d6165b67d 100644 --- a/docs/reference-docs/VOUCHERS-API-Voucher-Object.md +++ b/docs/reference-docs/VOUCHERS-API-Voucher-Object.md @@ -1,6 +1,6 @@ --- title: Voucher Object -type: endpoint +type: basic categorySlug: voucherify-api parentDocSlug: vouchers-api slug: voucher-object @@ -8,78 +8,90 @@ hidden: false order: 1 --- -| Attributes | Description | Example | -|:-----|:--------|------:| -| id |Assigned by the Voucherify API, identifies the voucher.
|v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV
| -| code |A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
|WVPblOYX
| -| campaign |A unique campaign name, identifies the voucher's parent campaign.
|Gift Card Campaign
| -| campaign_id |Assigned by the Voucherify API, identifies the voucher's parent campaign.
|camp_FNYR4jhqZBM9xTptxDGgeNBV
| -| category |Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
| | -| category_id |Unique category ID assigned by Voucherify.
|cat_0bb343dee3cdb5ec0c
| -| categories |Contains details about the category.
[object Object]
| | -| type |Defines the type of voucher.
Available values: `GIFT_VOUCHER`, `DISCOUNT_VOUCHER`, `LOYALTY_CARD` | | -| discount | One of: Reference to [1_obj_voucher_object_discount_amount](#amount) Reference to [1_obj_voucher_object_discount_percentage](#percentage) Reference to [1_obj_voucher_object_discount_fixed](#fixed) Reference to [1_obj_voucher_object_discount_unit_one](#unit, single item) Reference to [1_obj_voucher_object_discount_unit_multiple](#unit, multiple items) Reference to [1_obj_voucher_object_discount_shipping](#shipping) | | -| gift |Object representing gift parameters. Child attributes are present only if type
is GIFT_VOUCHER
. Defaults to null
.
Attributes | Description | Example |
---|---|---|
amount | Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | 10000 |
balance | Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | 500 |
effect | Defines how the credits are applied to the customer's order. Available values:APPLY_TO_ORDER , APPLY_TO_ITEMS |
Object representing loyalty card parameters. Child attributes are present only if type
is LOYALTY_CARD
. Defaults to null
.
Attributes | Description | Example |
---|---|---|
points | Total points incurred over lifespan of loyalty card. | 7000 |
balance | Points available for reward redemption. | 6970 |
next_expiration_date | The next closest date when the next set of points are due to expire. | 2023-05-30 |
next_expiration_points | The amount of points that are set to expire next. |
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
|2021-12-01T00:00:00.000Z
| -| expiration_date |Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
|2021-12-31T00:00:00.000Z
| -| validity_timeframe |Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description | Example |
---|---|---|
duration | Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a | PT1H |
interval | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an | P2D |
Integer array corresponding to the particular days of the week in which the voucher is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayA flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active voucherfalse
indicates an inactive voucherAn optional field to keep any extra textual information about the code such as a code description and details.
| | -| metadata |The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
| | -| assets |Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Attributes | Description | Example | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
qr | Stores Quick Response (QR) representation of encrypted code.
| ||||||||||
barcode | Stores barcode representation of encrypted code.
|
Flag indicating whether this voucher is a referral code.
| | -| created_at |Timestamp representing the date and time when the voucher was created in ISO 8601 format.
|2021-12-22T10:13:06.487Z
| -| updated_at |Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
|2021-12-22T10:14:45.316Z
| -| holder_id |Unique customer ID of voucher owner.
|cust_eWgXlBBiY6THFRJwX45Iakv4
| -| validation_rules_assignments |Stores information about validation rules assigned to the voucher.
Attributes | Description | Example | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
object | The type of object represented is by default | ||||||||||||||||||||||
data_ref | Identifies the name of the attribute that contains the array of validation rule assignments. | ||||||||||||||||||||||
data | Array of validation rule assignment objects. Each validation rule assignment object contains details about the rule. Array of:
| ||||||||||||||||||||||
total | Total number of validation rules assigned to the voucher. |
Stores a summary of redemptions that have been applied to the voucher.
Attributes | Description | Example |
---|---|---|
quantity | How many times a voucher can be redeemed. A | |
redeemed_quantity | How many times a voucher has already been redeemed. | 1 |
redeemed_amount | Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000. | 100000 |
redeemed_points | Total loyalty points redeemed. | 100000 |
object | The type of object represented is by default | |
url | The endpoint where this list of redemptions can be accessed using a GET method. | /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or publish voucher API method.
Required | Optional |
---|---|
type :LOYALTY_CARD | type :DISCOUNT_VOUCHER |
is_referral_code :true | type :GIFT_VOUCHER |
Attributes | Description | Example |
---|---|---|
object | The type of object represented is by default | |
count | Publication events counter. | 0 |
url | The endpoint where this list of publications can be accessed using a GET method. | /v1/vouchers/WVPblOYX/publications?page=1&limit=10 |
The type of object represented by JSON. Default is voucher
.
Applies an amount discount.
| | -| amount_off |Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the amount being calculated by the formula, i.e. the amount_off_formula
parameter is present in the amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the amount off.
100
| -| amount_off_formula |Formula used to calculate the discount.
| | -| effect |Defines how the discount is applied to the customer's order
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS`, `APPLY_TO_ITEMS_PROPORTIONALLY`, `APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY`, `APPLY_TO_ITEMS_BY_QUANTITY` | | -# Percentage -| Attributes | Description | Example | -|:-----|:--------|------:| -| type |Applies a percentage discount.
| | -| amount_limit |Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
| | -| percent_off |Percent taken off the subtotal amount. In case of the percent being calculated by the formula, i.e. the percent_off_formula
parameter is present in the percent definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the percent off.
Formula used to calculate the discount.
| | -| effect |Defines how the discount is applied to the customer's order.
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | | -# Fixed -| Attributes | Description | Example | -|:-----|:--------|------:| -| type |Sets a fixed total on cart or item(s) and then calculates the discount to apply.
| | -| fixed_amount |Set a fixed valued for an order total or price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the fixed amount being calculated by the formula, i.e. the fixed_amount_formula
parameter is present in the fixed amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.
1000
| -| fixed_amount_formula |Formula used to calculate the discounted price of an item or a new order total.
| | -| effect |Effect | Definition |
---|---|
APPLY_TO_ORDER | Sets the order total amount to the value of the fixed amount. The discount value is calculated dynamically during the redemption as it's a difference between the total amount of the customer's order and the fixed amount. For example, if the fixed amount is set to equal $10 and the order amount equals $25, then the calculated discount will be $15. |
APPLY_TO_ITEMS | Sets a new price on items. The total discount amount is dynamically calculated during the redemption and it's a difference between the initial item price and the fixed amount. During the redemption, prices for items will change only if the new price is lower than the original price. If the new product price you set is different from the product price in a collection, then the new product price will be passed during the redemption. If a prodct is in more than one collection, the price is always changed to the lowest price. The new price for products with several SKUs will force the price change for SKUs if their original price is higher than the new price. |
Applies a full value discount to item(s).
| | -| unit_off |Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the unit_off_formula
parameter is present in the unit definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the unit value.
1
| -| unit_off_formula |Formula used to calculate the number of units.
| | -| unit_type |The product deemed as free, chosen from the product inventory (e.g. time, items).
|prod_f1r5Tpr0DuC7
| -| effect |Defines how the unit is added to the customer's order.
Available values: `ADD_NEW_ITEMS`, `ADD_MISSING_ITEMS` | | -# Unit, multiple items -| Attributes | Description | Example | -|:-----|:--------|------:| -| type |Applies a full value discount to item(s).
| | -| effect |Defines the effect for adding multiple item types.
| | -| units |Array of objects defining items to be offered for free. Each item type can have a different discount effect assigned.
Array of:Attributes | Description | Example |
---|---|---|
unit_off | Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the | 1 |
unit_off_formula | Formula used to calculate the number of units. | |
unit_type | The product deemed as free, chosen from the product inventory (e.g. time, items). | prod_f1r5Tpr0DuC7 |
effect | Defines how the unit is added to the customer's order. Available values:ADD_NEW_ITEMS , ADD_MISSING_ITEMS |
Applies a full value discount to item(s).
| | -| unit_off |Subtracts 1 shipping item from the subtotal.
| | -| unit_type |The shipping product deemed as free.
| | -| effect |Defines how the unit is added to the customer's order.
| | +## Voucher Object +| Attributes | Description | +|:-----|:--------| +| id`string` |Assigned by the Voucherify API, identifies the voucher.
**Example:**v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV
| +| code`string` |A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
**Example:**WVPblOYX
| +| campaign`string` |A unique campaign name, identifies the voucher's parent campaign.
**Example:**Gift Card Campaign
| +| campaign_id`string` |Assigned by the Voucherify API, identifies the voucher's parent campaign.
**Example:**camp_FNYR4jhqZBM9xTptxDGgeNBV
| +| category`string` |Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
| +| category_id`string` |Unique category ID assigned by Voucherify.
**Example:**cat_0bb343dee3cdb5ec0c
| +| categories`array` |Contains details about the category.
Array of [Category Object](#category-object) | +| type`string` |Defines the type of voucher.
Available values: `GIFT_VOUCHER`, `DISCOUNT_VOUCHER`, `LOYALTY_CARD` | +| discount | One of: [Amount](#amount), [Percentage](#percentage), [Fixed](#fixed), [Unit, single item](#unit-single-item), [Unit, multiple items](#unit-multiple-items), [Shipping](#shipping) | +| gift`object` |Object representing gift parameters. Child attributes are present only if type
is GIFT_VOUCHER
. Defaults to null
.
Attributes | Description |
---|---|
amountinteger | Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. Example:10000 |
balanceinteger | Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. Example:500 |
effectstring | Defines how the credits are applied to the customer's order. Available values:APPLY_TO_ORDER , APPLY_TO_ITEMS |
Object representing loyalty card parameters. Child attributes are present only if type
is LOYALTY_CARD
. Defaults to null
.
Attributes | Description |
---|---|
pointsinteger | Total points incurred over lifespan of loyalty card. Example:7000 |
balanceinteger | Points available for reward redemption. Example:6970 |
next_expiration_datestring | The next closest date when the next set of points are due to expire. Example:2023-05-30 |
next_expiration_pointsinteger | The amount of points that are set to expire next. |
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
**Example:**2021-12-01T00:00:00.000Z
| +| expiration_date`string` |Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
**Example:**2021-12-31T00:00:00.000Z
| +| validity_timeframe`object` |Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day.start_date
required when including the validity_timeframe
.
Attributes | Description |
---|---|
durationstring | Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a PT1H |
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an P2D |
Integer array corresponding to the particular days of the week in which the voucher is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
SaturdayA flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date
and expiration_date
.
true
indicates an active voucherfalse
indicates an inactive voucherAn optional field to keep any extra textual information about the code such as a code description and details.
| +| metadata`object` |The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
| +| assets`object` |Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
qrobject | Stores Quick Response (QR) representation of encrypted code.
| ||||||
barcodeobject | Stores barcode representation of encrypted code.
|
Flag indicating whether this voucher is a referral code.
| +| created_at`string` |Timestamp representing the date and time when the voucher was created in ISO 8601 format.
**Example:**2021-12-22T10:13:06.487Z
| +| updated_at`string` |Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
**Example:**2021-12-22T10:14:45.316Z
| +| holder_id`string` |Unique customer ID of voucher owner.
**Example:**cust_eWgXlBBiY6THFRJwX45Iakv4
| +| validation_rules_assignments`object` |Stores information about validation rules assigned to the voucher.
Attributes | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
objectstring | The type of object represented is by default | ||||||||||||||
data_refstring | Identifies the name of the attribute that contains the array of validation rule assignments. | ||||||||||||||
dataarray | Array of validation rule assignment objects. Each validation rule assignment object contains details about the rule. Array of:
| ||||||||||||||
totalinteger | Total number of validation rules assigned to the voucher. |
Stores a summary of redemptions that have been applied to the voucher.
Attributes | Description |
---|---|
quantityinteger | How many times a voucher can be redeemed. A |
redeemed_quantityinteger | How many times a voucher has already been redeemed. Example:1 |
redeemed_amountinteger | Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000. Example:100000 |
redeemed_pointsinteger | Total loyalty points redeemed. Example:100000 |
objectstring | The type of object represented is by default |
urlstring | The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or publish voucher API method.
Required | Optional |
---|---|
type :LOYALTY_CARD | type :DISCOUNT_VOUCHER |
is_referral_code :true | type :GIFT_VOUCHER |
Attributes | Description |
---|---|
objectstring | The type of object represented is by default |
countinteger | Publication events counter. Example:0 |
urlstring | The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/WVPblOYX/publications?page=1&limit=10 |
The type of object represented by JSON. Default is voucher
.
Unique category ID assigned by Voucherify.
| +| name`string` |Category name.
| +| hierarchy`integer` |Category hierarchy.
| +| created_at`string` |Timestamp representing the date and time when the category was created in ISO 8601 format.
**Example:**2022-07-14T10:45:13.156Z
| +| updated_at`string` |Timestamp representing the date and time when the category was updated in ISO 8601 format.
**Example:**2022-08-16T10:52:08.094Z
| +| object`string` |The type of object represented by the JSON. This object stores information about the category.
| +## Amount +| Attributes | Description | +|:-----|:--------| +| type`string` |Applies an amount discount.
| +| amount_off`integer` |Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the amount being calculated by the formula, i.e. the amount_off_formula
parameter is present in the amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the amount off.
100
| +| amount_off_formula`string` |Formula used to calculate the discount.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects:
APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Defines how the discount is applied to the customer's order. The discount effects are defined as follows:
APPLY_TO_ORDER
(discount applies to the total order amount)APPLY_TO_ITEMS
(each item subtotal is discounted equally)APPLY_TO_ITEMS_PROPORTIONALLY
(split discount proportionally to amount)APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY
(split discount proportionally to quantity)APPLY_TO_ITEMS_BY_QUANTITY
(each unit of matched products has the same discount value)Applies a percentage discount.
| +| amount_limit`string` |Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
| +| aggregated_amount_limit`integer` |Maximum discount amount per order. This value is definable for the APPLY_TO_ITEMS
discount effect. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600.
Percent taken off the subtotal amount. In case of the percent being calculated by the formula, i.e. the percent_off_formula
parameter is present in the percent definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the percent off.
Formula used to calculate the discount.
| +| effect`string` |Defines how the discount is applied to the customer's order.
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | +## Fixed +| Attributes | Description | +|:-----|:--------| +| type`string` |Sets a fixed total on cart or item(s) and then calculates the discount to apply.
| +| fixed_amount`integer` |Set a fixed valued for an order total or price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the fixed amount being calculated by the formula, i.e. the fixed_amount_formula
parameter is present in the fixed amount definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.
1000
| +| fixed_amount_formula`string` |Formula used to calculate the discounted price of an item or a new order total.
| +| effect`string` |Effect | Definition |
---|---|
APPLY_TO_ORDER | Sets the order total amount to the value of the fixed amount. The discount value is calculated dynamically during the redemption as it's a difference between the total amount of the customer's order and the fixed amount. For example, if the fixed amount is set to equal $10 and the order amount equals $25, then the calculated discount will be $15. |
APPLY_TO_ITEMS | Sets a new price on items. The total discount amount is dynamically calculated during the redemption and it's a difference between the initial item price and the fixed amount. During the redemption, prices for items will change only if the new price is lower than the original price. If the new product price you set is different from the product price in a collection, then the new product price will be passed during the redemption. If a prodct is in more than one collection, the price is always changed to the lowest price. The new price for products with several SKUs will force the price change for SKUs if their original price is higher than the new price. |
Applies a full value discount to item(s).
| +| unit_off`number` |Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the unit_off_formula
parameter is present in the unit definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the unit value.
1
| +| unit_off_formula`string` |Formula used to calculate the number of units.
| +| unit_type`string` |The product deemed as free, chosen from the product inventory (e.g. time, items).
**Example:**prod_f1r5Tpr0DuC7
| +| effect`string` |Defines how the unit is added to the customer's order.
Available values: `ADD_NEW_ITEMS`, `ADD_MISSING_ITEMS` | +## Unit, multiple items +| Attributes | Description | +|:-----|:--------| +| type`string` |Applies a full value discount to item(s).
| +| effect`string` |Defines the effect for adding multiple item types.
| +| units`array` |Array of objects defining items to be offered for free. Each item type can have a different discount effect assigned.
Array of:Attributes | Description |
---|---|
unit_offinteger | Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the 1 |
unit_off_formulastring | Formula used to calculate the number of units. |
unit_typestring | The product deemed as free, chosen from the product inventory (e.g. time, items). Example:prod_f1r5Tpr0DuC7 |
effectstring | Defines how the unit is added to the customer's order. Available values:ADD_NEW_ITEMS , ADD_MISSING_ITEMS |
Applies a full value discount to item(s).
| +| unit_off`number` |Subtracts 1 shipping item from the subtotal.
| +| unit_type`string` |The shipping product deemed as free.
| +| effect`string` |Defines how the unit is added to the customer's order.
| [block:html] { diff --git a/docs/script/package-lock.json b/docs/script/package-lock.json deleted file mode 100644 index 05e70fa30..000000000 --- a/docs/script/package-lock.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "name": "script", - "version": "1.0.0", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "version": "1.0.0" - } - } -} diff --git a/docs/script/package.json b/docs/script/package.json deleted file mode 100644 index 48c48a1ab..000000000 --- a/docs/script/package.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "version": "1.0.0", - "scripts": { - "start": "node index.js" - } -} diff --git a/package-lock.json b/package-lock.json index fab15b32a..89e83ad65 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,8 +8,114 @@ "version": "1.0.0", "dependencies": { "dotenv": "^16.3.1", + "markdown-it": "^13.0.2", "minimist": "^1.2.8", - "node-fetch": "^2.7.0" + "node-fetch": "^2.7.0", + "ts-node": "^10.9.1", + "yup": "^1.1.1" + }, + "devDependencies": { + "@types/node": "^20.7.0" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.1.tgz", + "integrity": "sha512-dSYZh7HhCDtCKm4QakX0xFpsRDqjjtZf/kjI/v3T3Nwt5r8/qz/M19F9ySyOqU94SXBmeG9ttTul+YnR4LOxFA==", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.15", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", + "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, + "node_modules/@tsconfig/node10": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz", + "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==" + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==" + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==" + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz", + "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==" + }, + "node_modules/@types/node": { + "version": "20.7.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.7.0.tgz", + "integrity": "sha512-zI22/pJW2wUZOVyguFaUL1HABdmSVxpXrzIqkjsHmyUjNhPoWM1CKfvVuXfetHhIok4RY573cqS0mZ1SJEnoTg==" + }, + "node_modules/acorn": { + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.10.0.tgz", + "integrity": "sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", + "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" + }, + "node_modules/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==" + }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "engines": { + "node": ">=0.3.1" } }, "node_modules/dotenv": { @@ -23,6 +129,50 @@ "url": "https://github.com/motdotla/dotenv?sponsor=1" } }, + "node_modules/entities": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz", + "integrity": "sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/linkify-it": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-4.0.1.tgz", + "integrity": "sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==", + "dependencies": { + "uc.micro": "^1.0.1" + } + }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==" + }, + "node_modules/markdown-it": { + "version": "13.0.2", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-13.0.2.tgz", + "integrity": "sha512-FtwnEuuK+2yVU7goGn/MJ0WBZMM9ZPgU9spqlFs7/A/pDIUNSOQZhUgOqYCficIuR2QaFnrt8LHqBWsbTAoI5w==", + "dependencies": { + "argparse": "^2.0.1", + "entities": "~3.0.1", + "linkify-it": "^4.0.1", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + }, + "bin": { + "markdown-it": "bin/markdown-it.js" + } + }, + "node_modules/mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==" + }, "node_modules/minimist": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", @@ -50,6 +200,97 @@ } } }, + "node_modules/property-expr": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/property-expr/-/property-expr-2.0.5.tgz", + "integrity": "sha512-IJUkICM5dP5znhCckHSv30Q4b5/JA5enCtkRHYaOVOAocnH/1BQEYTC5NMfT3AVl/iXKdr3aqQbQn9DxyWknwA==" + }, + "node_modules/tiny-case": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/tiny-case/-/tiny-case-1.0.3.tgz", + "integrity": "sha512-Eet/eeMhkO6TX8mnUteS9zgPbUMQa4I6Kkp5ORiBD5476/m+PIRiumP5tmh5ioJpH7k51Kehawy2UDfsnxxY8Q==" + }, + "node_modules/toposort": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/toposort/-/toposort-2.0.2.tgz", + "integrity": "sha512-0a5EOkAUp8D4moMi2W8ZF8jcga7BgZd91O/yabJCFY8az+XSzeGyTKs0Aoo897iV1Nj6guFq8orWDS96z91oGg==" + }, + "node_modules/ts-node": { + "version": "10.9.1", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", + "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", + "dependencies": { + "@cspotcode/source-map-support": "^0.8.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/type-fest": { + "version": "2.19.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", + "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typescript": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", + "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==", + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/uc.micro": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", + "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==" + }, + "node_modules/v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==" + }, "node_modules/whatwg-url": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", @@ -68,6 +309,25 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==" + }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "engines": { + "node": ">=6" + } + }, + "node_modules/yup": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/yup/-/yup-1.3.1.tgz", + "integrity": "sha512-2stNyEF96SnPUxzRL99kt1bEHWytnvC2stwmTTqjoFXZRf63JtYK2pQt2AJvWcQvkrAzr/pcXvc6c5vrqsBzDg==", + "dependencies": { + "property-expr": "^2.0.5", + "tiny-case": "^1.0.3", + "toposort": "^2.0.2", + "type-fest": "^2.19.0" + } } } } diff --git a/package.json b/package.json index fd1ed732c..665b78342 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,20 @@ { "version": "1.0.0", "scripts": { - "re-order": "npm run start --prefix docs/script" + "update-md-tables-in-doc": "ts-node ./scripts/update-md-tables-in-doc.ts", + "build-md-tables-from-openapi": "ts-node ./scripts/build-md-tables-from-openapi.ts", + "readme-fix-docs-order": "ts-node ./scripts/readme-fix-docs-order.ts", + "remove-stoplight-tags-from-openapi": "ts-node ./scripts/remove-stoplight-tags-from-openapi.ts" }, "dependencies": { "dotenv": "^16.3.1", + "markdown-it": "^13.0.2", "minimist": "^1.2.8", - "node-fetch": "^2.7.0" + "node-fetch": "^2.7.0", + "ts-node": "^10.9.1", + "yup": "^1.1.1" + }, + "devDependencies": { + "@types/node": "^20.7.0" } } diff --git a/reference/OpenAPI.json b/reference/OpenAPI.json index 5dc02037e..457763af0 100644 --- a/reference/OpenAPI.json +++ b/reference/OpenAPI.json @@ -366,8 +366,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - ] + "anyOf": [] }, "description": "A filter.", "style": "deepObject", @@ -38706,43 +38705,43 @@ } }, "22_filter_updated_at": { - "type": "object", - "title": "Updated at", - "properties": { - "updated_at": { - "$ref": "#/components/schemas/16_filter_conditions_date_time" - } - }, + "type": "object", + "title": "Updated at", + "properties": { + "updated_at": { + "$ref": "#/components/schemas/16_filter_conditions_date_time" + } + }, "description": "A filter on the list based on the object `updated_at` field. The value is a dictionary with the following options: `before`, `after`. A date value must be presented in ISO 8601 format (`2016-11-16T14:14:31Z` or `2016-11-16`). An example: `[updated_at][before]=2017-09-08T13:52:18.227Z`" }, "22_filter_created_at": { - "type": "object", - "title": "Created at", - "properties": { - "created_at": { - "$ref": "#/components/schemas/16_filter_conditions_date_time" - } - }, + "type": "object", + "title": "Created at", + "properties": { + "created_at": { + "$ref": "#/components/schemas/16_filter_conditions_date_time" + } + }, "description": "A filter on the list based on the object `created_at` field. The value is a dictionary with the following options: `before`, `after`. A date value must be presented in ISO 8601 format (`2016-11-16T14:14:31Z` or `2016-11-16`). An example: `[created_at][before]=2017-09-08T13:52:18.227Z`" }, "22_filter_name": { - "type": "object", - "title": "Name", - "properties": { - "name": { - "$ref": "#/components/schemas/16_filter_conditions_string" - } - }, + "type": "object", + "title": "Name", + "properties": { + "name": { + "$ref": "#/components/schemas/16_filter_conditions_string" + } + }, "description": "A filter on the list based on the name field." }, "22_filter_id": { - "type": "object", - "title": "ID", - "properties": { - "id": { - "$ref": "#/components/schemas/16_filter_conditions_string" - } - }, + "type": "object", + "title": "ID", + "properties": { + "id": { + "$ref": "#/components/schemas/16_filter_conditions_string" + } + }, "description": "A filter on the list based on the id of the location." }, "23_obj_qualification_object": { @@ -38977,6 +38976,7 @@ }, "23_obj_qualification_object_stacking_rules": { "type": "object", + "title": "Examine Qualification Stacking Rules", "description": "Defines stacking rules for the redeemables.", "properties": { "redeemables_limit": { @@ -49928,42 +49928,42 @@ } } }, - "404": { - "description": "Returns an error if a resource is not found.", + "403": { + "description": "Returns an error if you don't have a specific credentials set up. Navigate to the **Dashboard** → **Project Settings** → **General** → **Integration Keys** to set up a pair of API keys and use them to send the request.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/e_404_not_found" + "$ref": "#/components/schemas/e_integration_key" }, "examples": { - "Resource not found": { + "Example": { "value": { - "code": 404, - "key": "not_found", - "message": "Resource not found", - "details": "Cannot find customer with id cust_xqA7DGj5eYPHg6PHVKwYRWiA", - "request_id": "v-0c8b6b35294af6f192", - "resource_id": "cust_xqA7DGj5eYPHg6PHVKwYRWiA", - "resource_type": "customer" + "code": 403, + "message": "Forbidden", + "key": "integration_api_key_required" } } } } } }, - "403": { - "description": "Returns an error if you don't have a specific credentials set up. Navigate to the **Dashboard** → **Project Settings** → **General** → **Integration Keys** to set up a pair of API keys and use them to send the request.", + "404": { + "description": "Returns an error if a resource is not found.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/e_integration_key" + "$ref": "#/components/schemas/e_404_not_found" }, "examples": { - "Example": { + "Resource not found": { "value": { - "code": 403, - "message": "Forbidden", - "key": "integration_api_key_required" + "code": 404, + "key": "not_found", + "message": "Resource not found", + "details": "Cannot find customer with id cust_xqA7DGj5eYPHg6PHVKwYRWiA", + "request_id": "v-0c8b6b35294af6f192", + "resource_id": "cust_xqA7DGj5eYPHg6PHVKwYRWiA", + "resource_type": "customer" } } } @@ -80893,7 +80893,7 @@ "tags": [ "QUALIFICATIONS API" ], - "summary": "Qualification Object [Beta]", + "summary": "Qualification Object", "description": "Data model description", "responses": { "200": { @@ -80915,7 +80915,7 @@ "tags": [ "QUALIFICATIONS API" ], - "summary": "Check Eligibility [Beta]", + "summary": "Check Eligibility", "description": "Generate a list of redeemables that are applicable in the context of the customer and order.\n\nThe new qualifications method is an improved version of [Campaign Qualifications](ref:examine-campaigns-qualification), [Voucher Qualifications](ref:examine-vouchers-qualification), and [Promotions Validation](ref:validate-promotions) API requests. The new qualification method introduces the following improvements:\n\n- Qualification results are returned faster\n- No limit on the number of returned redeemables\n- Introduces new qualification scenarios, not available in the previous version\n\n## Paging \n\nThe Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the `starting_after` cursor.\n\nTo process of paging the redeemables works in the following manner:\n\n- You send the first API request for Qualifications without the `starting_after` parameter.\n- The response will contain a parameter named `has_more`. If the parameter's value is set to `true`, then more redeemables are available.\n- Get the value of the `created_at` parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables.\n- Send another API request for Qualification with the `starting_after` parameter set to the value taken from the `created_at` parameter from the last returned redeemable.\n- Voucherify will return the next page of redeemables.\n- If the `has_more` parameter is set to `true`, apply steps 3-5 to get the next page of redeemables.", "parameters": [], "security": [ @@ -80954,7 +80954,7 @@ "tags": [ "QUALIFICATIONS API" ], - "summary": "Check Eligibility (client-side) [Beta]", + "summary": "Check Eligibility (client-side)", "description": "Generate a list of redeemables that are applicable in the context of the customer and order.\n\nThe new qualifications method is an improved version of [Campaign Qualifications](ref:examine-campaigns-qualification), [Voucher Qualifications](ref:examine-vouchers-qualification), and [Promotions Validation](ref:validate-promotions) API requests. The new qualification method introduces the following improvements:\n\n- Qualification results are returned faster\n- No limit on the number of returned redeemables\n- Introduces new qualification scenarios, not available in the previous version\n\n## Paging \n\nThe Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the `starting_after` cursor.\n\nTo process of paging the redeemables works in the following manner:\n\n- You send the first API request for Qualifications without the `starting_after` parameter.\n- The response will contain a parameter named `has_more`. If the parameter's value is set to `true`, then more redeemables are available.\n- Get the value of the `created_at` parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables.\n- Send another API request for Qualification with the `starting_after` parameter set to the value taken from the `created_at` parameter from the last returned redeemable.\n- Voucherify will return the next page of redeemables.\n- If the `has_more` parameter is set to `true`, apply steps 3-5 to get the next page of redeemables.", "parameters": [], "security": [ @@ -80988,4 +80988,4 @@ } } } -} +} \ No newline at end of file diff --git a/scripts/build-md-tables-from-openapi.ts b/scripts/build-md-tables-from-openapi.ts new file mode 100644 index 000000000..20c29655e --- /dev/null +++ b/scripts/build-md-tables-from-openapi.ts @@ -0,0 +1,23 @@ +import * as fs from 'fs/promises' +import path from 'path'; +import './globals.t' +import * as openApi from '../reference/OpenAPI.json'; +import { mdTables } from './md-tables'; +import SchemaToMarkdownTable, {RenderMode, ExamplesRenderedAs} from './src/schema-to-md-table'; + +const PATH_TO_GERENATED_TABLES = [__dirname, './output']; + +(async () => { + const stm = new SchemaToMarkdownTable(openApi.components.schemas, RenderMode.List, ExamplesRenderedAs.PartOfDescription); + for(const [objectName] of mdTables){ + try{ + const fileName = `${objectName}.md`; + await fs.writeFile(path.join(...PATH_TO_GERENATED_TABLES, fileName), stm.render(objectName)) + console.log(`Generated markdown table in ${fileName}`) + }catch(e){ + console.log(`Error for ${objectName}`, e) + + } + } + console.log('done') +})() \ No newline at end of file diff --git a/tableWithNestedSchemaGenerator/globals.t.ts b/scripts/globals.t.ts similarity index 100% rename from tableWithNestedSchemaGenerator/globals.t.ts rename to scripts/globals.t.ts diff --git a/scripts/md-tables.ts b/scripts/md-tables.ts new file mode 100644 index 000000000..4ff8217f0 --- /dev/null +++ b/scripts/md-tables.ts @@ -0,0 +1,33 @@ +export const mdTables: [string, string?][] = [ + ['1_obj_voucher_object', 'VOUCHERS-API-Voucher-Object.md'], + ['2_obj_campaign_object', 'CAMPAIGNS-API-Campaign-Object.md'], + ['3_obj_promotion_tier_object', 'PROMOTIONS-API-Promotion-Tier-Object.md'], + ['4_obj_reward_object', 'REWARDS-API-Reward-Object.md'], + ['4_obj_reward_assignment_object', 'REWARDS-API-Reward-Assignment-Object.md'], + ['5_obj_publication_object', 'PUBLICATIONS-API-Publication-Object.md'], + ['6_res_validate_voucher'], // VALIDATIONS-API-Validation-Object.md // Does not generate + ['6_res_validate_voucher_false'], + ['7_obj_redemption_object'], // REDEMPTIONS-API-Redemption-Object.md // Does not generate + ['7_obj_rollback_redemption_object_extended'], // REDEMPTIONS-API-Rollback-Redemption-Object.md // Does not generate + ['19_res_redemptions_POST', 'STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md'], + ['8_obj_loyalty_campaign_object', 'LOYALTIES-API-Loyalty-Campaign-Object.md'], + ['8_obj_loyalty_card_object_non_expanded_categories', 'LOYALTIES-API-Loyalty-Card-Object.md'], + ['8_obj_earning_rule_object'], // LOYALTIES-API-Earning-Rule-Object.md // Does not generates + ['8_obj_loyalty_tier_object', 'LOYALTIES-API-Loyalty-Tier-Object.md'], + ['9_obj_customer_object', 'CUSTOMERS-API-Customer-Object.md'], + ['9_obj_customer_activity_object', 'CUSTOMERS-API-Customer-Activity-Object.md'], + ['10_obj_order_object', 'ORDERS-API-Order-Object.md'], + ['11_obj_product_object', 'PRODUCTS-API-Product-Object.md'], + ['11_obj_sku_object', 'PRODUCTS-API-SKU-Object.md'], + ['12_obj_product_collection_object'], // PRODUCT-COLLECTIONS-API-Product-Collection-Object.md // Does not generates + ['13_obj_validation_rule_object', 'VALIDATION-RULES-API-Validation-Rule-Object.md'], + ['13_obj_validation_rule_assignment_object', 'VALIDATION-RULES-API-Validation-Rule-Assignment-Object.md'], + ['14_obj_segment_object', 'SEGMENTS-API-Customer-Segment-Object.md'], + ['15_req_track_custom_event'], // EVENTS-API-Custom-Event-Object.md // Something does not feel right - + ['18_res_list_consents_GET', 'CONSENTS-API-Consents-Object.md'], + ['17_obj_async_action_object', 'ASYNC-ACTIONS-API-Async-Action-Object.md'], + ['16_obj_export_object', 'EXPORTS-API-Export-Object.md'], + ['20_obj_category_object', 'CATEGORIES-API-Category-Object.md'], + ['21_obj_metadata_schema_object', 'METADATA-SCHEMAS-API-Metadata-Schema-Object.md'], + ['23_obj_qualification_object', 'QUALIFICATIONS-API-Qualification-Object.md'] +]; \ No newline at end of file diff --git a/tableWithNestedSchemaGenerator/output/.gitkeep b/scripts/output/.gitkeep similarity index 100% rename from tableWithNestedSchemaGenerator/output/.gitkeep rename to scripts/output/.gitkeep diff --git a/docs/script/index.js b/scripts/readme-fix-docs-order.ts similarity index 50% rename from docs/script/index.js rename to scripts/readme-fix-docs-order.ts index 91c194d59..64e5926d3 100644 --- a/docs/script/index.js +++ b/scripts/readme-fix-docs-order.ts @@ -1,42 +1,13 @@ -const fetch = require("node-fetch"); -const fsPromises = require("fs/promises"); -const fs = require("fs"); -const path = require("path"); -require("dotenv").config(); -const { version } = require("minimist")(process.argv.slice(2)); +import * as fs from 'fs/promises' +import path from 'path'; +import dotenv from 'dotenv' +import minimist from 'minimist'; +import { ok } from 'assert'; -if (!version) { - console.log( - "`version` argument was not provided :/, next time try add `-- --version=************` at the end of file execution command" - ); - return; -} +dotenv.config(); +const { version } = minimist(process.argv.slice(2)); -if (process.env.README_IO_AUTH?.length < 10) { - console.log("`README_IO_AUTH` was not provided in `.env` file :/"); - return; -} -const main = async () => { - const basePath = path.join(__dirname, ".."); - const pathsToFiles = await getFiles(basePath); - const dataToProcess = []; - for (const pathToFile of pathsToFiles) { - const data = await fsPromises.readFile(pathToFile, { encoding: "utf8" }); - const slug = data.match(/slug: .*/)?.[0]?.split?.("slug: ")?.[1]; - const order = parseInt( - data.match(/order: .*/)?.[0]?.split?.("order: ")?.[1] - ); - if (!slug || isNaN(order)) { - throw new Error("Invalid slug or order in " + pathToFile); - } - dataToProcess.push({ slug, order, pathToFile }); - } - for (const chunk of chunkArray(dataToProcess, 6)) { - await asyncMap(chunk, updateDoc); - } - console.log("Done!"); -}; const updateDoc = async ({ slug, order, pathToFile }) => { const options = { method: "PUT", @@ -49,29 +20,40 @@ const updateDoc = async ({ slug, order, pathToFile }) => { body: JSON.stringify({ order }), }; - const response = await fetch( - `https://dash.readme.com/api/v1/docs/${slug}`, - options - ); - - const responseJSON = await response.json(); - if (responseJSON.error) { - console.log({ filePath: pathToFile, response }); - throw new Error(responseJSON.error); - } + try{ + const response = await fetch( + `https://dash.readme.com/api/v1/docs/${slug}`, + options + ); - if (order === responseJSON.order) { - console.log(`Updated successfully ${pathToFile}!`); - } else { - console.log(`Not updated ${pathToFile}!`); + const responseJSON = await response.json(); + + if (responseJSON.error) { + console.log(`Error in json response from readme for ${slug}`, { responseJSON }); + throw new Error(responseJSON.error); + } + + if (order === responseJSON.order) { + console.log(`Updated successfully ${pathToFile}!`); + } else { + console.log(`Not updated ${pathToFile}!`); + } + + return responseJSON; + }catch(error){ + console.log(`Error when reqesting readme for ${slug}`, error); + throw new Error(error) } - - return responseJSON; }; -const getFiles = async (path) => { - const pathsToFiles = []; - const items = await fsPromises.readdir(path, { +const chunkArray = (list, chunkSize) => + [...Array(Math.ceil(list.length / chunkSize))].map((_) => + list.splice(0, chunkSize) + ); + +const getFiles = async (path: string) => { + const pathsToFiles: string[] = []; + const items = await fs.readdir(path, { withFileTypes: true, }); for (const item of items) { @@ -93,9 +75,39 @@ const asyncMap = (arr, asyncFn) => { return Promise.all(arr.map(asyncFn)); }; -const chunkArray = (list, chunkSize) => - [...Array(Math.ceil(list.length / chunkSize))].map((_) => - list.splice(0, chunkSize) - ); -main(); +const readmeFixDocsOrder = async () => { + if (!version) { + console.log( + "`version` argument was not provided :/, next time try add `-- --version=************` at the end of file execution command" + ); + return; + } + if (process.env.README_IO_AUTH?.length < 10) { + console.log("`README_IO_AUTH` was not provided in `.env` file :/"); + return; + } + const basePath = path.join(__dirname, "../docs"); + const pathsToFiles = await getFiles(basePath); + + const dataToProcess = []; + for (const pathToFile of pathsToFiles) { + const data = await fs.readFile(pathToFile, { encoding: "utf8" }); + const slug = data.match(/slug: .*/)?.[0]?.split?.("slug: ")?.[1]; + const order = parseInt( + data.match(/order: .*/)?.[0]?.split?.("order: ")?.[1] + ); + if (!slug || isNaN(order)) { + throw new Error("Invalid slug or order in " + pathToFile); + } + dataToProcess.push({ slug, order, pathToFile }); + } + for (const chunk of chunkArray(dataToProcess, 6)) { + await asyncMap(chunk, updateDoc); + } + console.log("Done!"); +}; + + + +readmeFixDocsOrder() diff --git a/scripts/remove-stoplight-tags-from-openapi.ts b/scripts/remove-stoplight-tags-from-openapi.ts new file mode 100644 index 000000000..3f909efa8 --- /dev/null +++ b/scripts/remove-stoplight-tags-from-openapi.ts @@ -0,0 +1,31 @@ +import fs from 'fs/promises'; +import path from 'path'; + +function isObject(value) { + return ( + typeof value === 'object' && + value !== null && + !Array.isArray(value) + ); + } + +const removeStoplightTag = (node: object): object => { + delete node['x-stoplight']; + for(const attr in node){ + if(isObject(node[attr])){ + removeStoplightTag(node[attr]) + } + } + return node; +} + +const main = async() => { + const openApiPath = path.join(__dirname, '../reference/OpenAPI.json'); + const openAPIContent = JSON.parse((await fs.readFile(openApiPath)).toString()) + + removeStoplightTag(openAPIContent) + + await fs.writeFile(openApiPath, JSON.stringify(openAPIContent, null, 2) ) +} + +main() \ No newline at end of file diff --git a/scripts/src/schema-to-md-table.ts b/scripts/src/schema-to-md-table.ts new file mode 100644 index 000000000..59cc69e3f --- /dev/null +++ b/scripts/src/schema-to-md-table.ts @@ -0,0 +1,335 @@ +import { EOL } from 'os'; +import * as yup from 'yup'; +import MarkdownIt from 'markdown-it'; + +yup.addMethod(yup.MixedSchema, "oneOfSchemas", function (schemas: yup.AnySchema[]) { + return this.test( + "one-of-schemas", + "Not all items in '${path}' match one of the allowed schemas", + (item) => + schemas.some((schema) => schema.isValidSync(item, { strict: true })) + ); +}); + +const nodeWithTitleAndPropertiesSchema = yup.object({ + title: yup.string().optional(), + type: yup.string().oneOf(['object', 'string']), + properties: yup.object({}), +}); + +const oneOfSchema = yup.array().of(yup.object({ + '$ref': yup.string().required() +})).optional(); + +const itemsSchema = yup.mixed().oneOfSchemas([nodeWithTitleAndPropertiesSchema, yup.object({ '$ref': yup.string().optional() })]).optional(); + +const anyOfSchema = yup.array().of(yup.mixed().oneOfSchemas([ + nodeWithTitleAndPropertiesSchema, + yup.object({ '$ref': yup.string().required() }) +])).optional() + +const propertySchema = yup.object({ + type: yup.mixed().oneOfSchemas([ + yup.string(), + yup.array().of(yup.string()) + ]), + description: yup.string().optional(), + enum: yup.array().of(yup.mixed().oneOfSchemas([ + yup.string(), + yup.array().of(yup.number()), + yup.array().of(yup.string()) + ])).optional(), + oneOf: oneOfSchema, + anyOf: anyOfSchema, + items: itemsSchema, + '$ref': yup.string().optional() +}); + +interface Items extends yup.InferType