Skip to content

Commit fd1ebf0

Browse files
author
Dhananjay8
committed
updated readme
1 parent 62a46bc commit fd1ebf0

1 file changed

Lines changed: 56 additions & 52 deletions

File tree

README.md

Lines changed: 56 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -808,104 +808,108 @@ For executing transactions, you need to understand the 4 modules described below
808808
echo json_encode($response, JSON_PRETTY_PRINT);
809809
```
810810

811-
### Redemptions Module
811+
812+
### Redemption Modules
812813

813-
* Initialize Redemptions service object to perform user redemption specific actions.
814+
Two modules of redemption, "Redeemable SKUs" and "User Redemptions", are described below.
815+
816+
#### Redeemable SKUs Module
817+
818+
* Initialize Redeemable SKUs service object to perform redeemable skus specific actions.
814819

815820
```php
816-
$redemptionsService = $ostObj->services->redemptions;
821+
$redeemableSkusService = $ostObj->services->redeemableSkus;
817822
```
818-
819-
* Get User redemption detail using the userId and redemptionId.
823+
824+
* Get Redeemable SKU detail using the redeemable sku id.
820825

821826
```php
822827
// Mandatory API parameters
823828

824-
// UserId of user for whom redemption details needs to be fetched.
825-
$userId = 'ee8___';
826-
827-
// RedemptionId of user.
828-
$redemptionId = 'aa___';
829-
829+
// Fetch details of following redeemable sku.
830+
$redeemableSkuId = '1';
831+
830832
$getParams = array();
831-
$getParams['user_id'] = $userId;
832-
$getParams['redemption_id'] = $redemptionId;
833-
$response = $redemptionsService->get($getParams)->wait();
833+
$getParams['redeemable_sku_id'] = $redeemableSkuId;
834+
$response = $redeemableSkusService->get($getParams)->wait();
834835
echo json_encode($response, JSON_PRETTY_PRINT);
835836
```
836837

837-
* Get User Redemptions List. Pagination is supported by this API.
838+
* Get Redeemable SKUs List. Pagination is supported by this API.
838839

839840
```php
840841
// Mandatory API parameters
841-
842-
// UserId of user for whom redemption details needs to be fetched.
843-
$userId = 'ee89___';
844-
842+
// NOTE: No mandatory parameters.
843+
845844
// Optional API parameters
846-
847-
// Array of user redemption uuids.
848-
$redemptionIds = array('a743___', 'a743___');
849845

850846
// Limit.
851847
$limit = 10;
852848

853-
// Pagination identifier from the previous API call response. Not needed for page one.
854-
$paginationIdentifier = 'eyJsY___';
849+
// Array of redeemable SKU ids.
850+
$redeemableSkuIds = array('1', '2');
855851

852+
// Pagination identifier from the previous API call response. Not needed for page one.
853+
$paginationIdentifier = 'eyJsY___';
854+
856855
$getParams = array();
857-
$getParams['user_id'] = $userId;
858-
$getParams['redemption_ids'] = $redemptionIds;
856+
$getParams['redeemable_sku_ids'] = $redeemableSkuIds;
859857
$getParams['limit'] = $limit;
860858
$getParams['pagination_identifier'] = $paginationIdentifier;
861-
862-
$response = $redemptionsService->getList($getParams)->wait();
859+
860+
$response = $redeemableSkusService->getList($getParams)->wait();
863861
echo json_encode($response, JSON_PRETTY_PRINT);
864862
```
863+
864+
#### User Redemptions Module
865865

866-
### RedeemableSkus Module
867-
868-
* Initialize RedeemableSkus service object to perform redeemable skus specific actions.
866+
* Initialize Redemptions service object to perform user redemption specific actions.
869867

870868
```php
871-
$redeemableSkusService = $ostObj->services->redeemableSkus;
869+
$redemptionsService = $ostObj->services->redemptions;
872870
```
873-
874-
* Get Redeemable SKU detail using the redeemable SKU id.
871+
872+
* Get User redemption details using the userId and redemptionId.
875873

876874
```php
877875
// Mandatory API parameters
878-
879-
// RedeemableSkuId of product for whom details needs to be fetched.
880-
$redeemableSkuId = '1';
881-
876+
877+
// UserId of user for whom redemption details needs to be fetched.
878+
$userId = 'ee8___';
879+
880+
// Unique identifier of the redemption of user.
881+
$redemptionId = 'aa___';
882+
882883
$getParams = array();
883-
$getParams['redeemable_sku_id'] = $redeemableSkuId;
884-
$response = $redeemableSkusService->get($getParams)->wait();
884+
$getParams['user_id'] = $userId;
885+
$getParams['redemption_id'] = $redemptionId;
886+
$response = $redemptionsService->get($getParams)->wait();
885887
echo json_encode($response, JSON_PRETTY_PRINT);
886888
```
887889

888-
* Get Redeemable SKUs List. Pagination is supported by this API.
890+
* Get User Redemptions List. Pagination is supported by this API.
889891

890892
```php
891893
// Mandatory API parameters
892-
894+
$userId = 'ee89___';
895+
893896
// Optional API parameters
894-
897+
895898
// Limit.
896899
$limit = 10;
897-
900+
901+
// Array of user redemption uuids.
902+
$redemptionIds = array('a743___', 'a743___');
903+
898904
// Pagination identifier from the previous API call response. Not needed for page one.
899905
$paginationIdentifier = 'eyJsY___';
900-
901-
// Array of redeemable SKU ids.
902-
$redeemableSkuIds = array('1', '2');
903-
906+
904907
$getParams = array();
905-
$getParams['redeemable_sku_ids'] = $redeemableSkuIds;
908+
$getParams['user_id'] = $userId;
909+
$getParams['redemption_ids'] = $redemptionIds;
906910
$getParams['limit'] = $limit;
907911
$getParams['pagination_identifier'] = $paginationIdentifier;
908-
909-
$response = $redeemableSkusService->getList($getParams)->wait();
912+
913+
$response = $redemptionsService->getList($getParams)->wait();
910914
echo json_encode($response, JSON_PRETTY_PRINT);
911-
```
915+
```

0 commit comments

Comments
 (0)