Skip to content

Commit

Permalink
Merge pull request #657 from voucherifyio/pw-API-Version-Upgrades-update
Browse files Browse the repository at this point in the history 
"API version upgrades" article update
  • Loading branch information
@p-woznikowski
p-woznikowski authored Jan 30, 2024
2 parents 1fc02b1 + 93ea20b commit ac47947
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
4 changes: 4 additions & 0 deletions Changelog.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 20240130

Update to the API version upgrades article regarding the v2024-01-01 webhook version.

## 20240117

Quick fix to the CSV export with API article.
Expand Down
11 changes: 6 additions & 5 deletions docs/guides/development/API-Version-Upgrades.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@ If you’re running an older version, you’ll want to upgrade to take advantage

## API changelog

| Version | Description |
|:---|:---|
| v2017-04-05 <br>version deprecated | - Responses from the voucher and campaign listing methods were moved to the new object structure. Methods will now render specific properties for a total count and an array of objects.<br>- Introduced validation for listing parameters: `limit` and `page`. A limit can range between 1 and 100 items.<br>- Get voucher/campaign methods render **validation rules** related to the voucher object. They can be inherited from a campaign.<br>- Created an API method for getting a campaign identified by name. |
| v2017-04-20 <br>version deprecated | Response from the voucher publish method was moved to the new object structure. Returned voucher details are wrapped by transaction object describing publication event:<br>{ "id": "pub_whQzIndYoyZoqiLEKN0s04GK", "object": "publication", "created_at": "2017-04-20T13:18:01Z", "customer_id": "cust_mOjhGypfbqch0v3DpAA9LDXj", "tracking_id": "janusz", "channel": "API", "metadata": { "test":true }, "voucher": {} } |
| v2018-08-01 | This version introduces a new model for building Validation Rules. The extended mechanism gives an advanced configuration for making promo conditions.<br><br>The modifications in this version affect the following API methods:<br><br>- `List Promotion Tiers`: replaced an object describing conditions by a list of records describing an association between rule and tier - `validation_rule_assignments`<br>- `List Promotion Tiers for campaign` - as above<br>- `Promotion Tier Object` - as above<br>- `Validation Rule Object` - structure reorganized to handle advanced rules<br>- `Validation Rule Assignment Object` - added object describing a relation between rules and linked promotions<br>- `Validation Rules` - modified data model<br><br>The mechanics and details of Validation Rules builder are described in the Help Center. |
| Version | Description |
| :--------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| v2017-04-05 <br>version deprecated | - Responses from the voucher and campaign listing methods were moved to the new object structure. Methods will now render specific properties for a total count and an array of objects.<br>- Introduced validation for listing parameters: `limit` and `page`. A limit can range between 1 and 100 items.<br>- Get voucher/campaign methods render **validation rules** related to the voucher object. They can be inherited from a campaign.<br>- Created an API method for getting a campaign identified by name. |
| v2017-04-20 <br>version deprecated | Response from the voucher publish method was moved to the new object structure. Returned voucher details are wrapped by transaction object describing publication event:<br>{ "id": "pub_whQzIndYoyZoqiLEKN0s04GK", "object": "publication", "created_at": "2017-04-20T13:18:01Z", "customer_id": "cust_mOjhGypfbqch0v3DpAA9LDXj", "tracking_id": "janusz", "channel": "API", "metadata": { "test":true }, "voucher": {} } |
| v2018-08-01 | This version introduces a new model for building Validation Rules. The extended mechanism gives an advanced configuration for making promo conditions.<br><br>The modifications in this version affect the following API methods:<br><br>- `List Promotion Tiers`: replaced an object describing conditions by a list of records describing an association between rule and tier - `validation_rule_assignments`<br>- `List Promotion Tiers for campaign` - as above<br>- `Promotion Tier Object` - as above<br>- `Validation Rule Object` - structure reorganized to handle advanced rules<br>- `Validation Rule Assignment Object` - added object describing a relation between rules and linked promotions<br>- `Validation Rules` - modified data model<br><br>The mechanics and details of Validation Rules builder are described in the Help Center. |
| Webhooks v2024-01-01 | In [v20231205](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20231205) release, a new version of webhooks was introduced. The new webhooks are available for distribution and the events listed in Project settings. There, you can switch from the old v2018-01-01 webhook version to the new one. The accounts created after the v20231205 release can use only the new version. |

> 📘 Release Notes
>
Expand Down

0 comments on commit ac47947

Please sign in to comment.