Updated APIs

Coupon, transaction, organization, points, task, and index.html

Author: harsha-cap

build/index.html

@@ -1,4 +1,4 @@
-# Coupon
+# Coupon
 Coupon represents store promotions or discounts created through Capillary Campaign Manager. A single campaign could contain one or more coupons or coupon series. Coupons are issued to loyalty or non-loyalty customers through SMS or email.
 
 You cannot create new coupons using coupon APIs. You can just send or retrieve coupons that are already created in your campaigns. Hence, it is important to note the coupon code, coupon id or coupon series id for making API calls.
@@ -221,7 +221,7 @@ code | Coupon code that you want to issue to the customer
 
 <aside class="warning"> You can pass either coupon id or code. Any one parameter is required</aside>
 
-## Redeem Coupons
+## Redeem Coupon
 
 ```html
 # Sample Request
@@ -362,7 +362,7 @@ Batch Support  | No
 ### Request URL
 `http://{host}/v1.1/coupon/redeem?{identifierName}={identifierValue}&format={xml/json}`
 
-### Request Parameters
+### Request Body Parameters
 Parameter | Datatype | Description
 --------- | -------- | -----------
 identifierName* | enum | Unique identifier of the customer whose coupon needs to be redeemed.
@@ -371,6 +371,9 @@ code | string | Coupon code that need to be redeemed.
 validation_code | string | Validation code is required for the orgs that use validation based redemption.
 number | string | Transaction number against which the coupon needs to be redeemed.
 amount | double | Transaction amount against which the coupon is redeemed.
+custom_fields | obj | Coupon redemption level custom fields.
+name | string | Name of the custom field.
+value | string | Custom field value.
 
 <aside class="warning"> You need to pass either `code` or `id` as applicable </aside>
 

source/includes/_coupon.md

@@ -1885,7 +1885,7 @@ optin_status=true | - | Returns the services (SMS/email) to which the customer h
 expiry_schedule=true | - | Returns the details of points expiry summary with number of points to expire, program ID, and date and time of expiry.
 expired_points=true | - | Returns the details of expired points of the customer.
 points_summary=true | - | Returns the history of points issued and redeemed.
-promotion_points=true | - | Returns the history of promotional points issued and redeemed. It also shows the store that issued the points and expiry date for each set of points issued.
+promotion_points=true | - | Returns the history of promotional points issued and redeemed. It also shows the store that issued the points and expiry date for each set of points issued. You can get up to 1000 results (maximum limit).
 membership_retention_criteria=true | - | Returns the criteria set for membership or tier retention (usually for membership based loyalty program).
 tier_upgrade_criteria=true | - | Returns the tier upgrade criteria configured in `tier_update_criteria` object of response payload.<br>This is supported only if the tier upgrade strategy is based on Lifetime Points, Lifetime Purchases, or Current Points,  but not on tracker based strategy. Also, you will not see upgrade criteria if the customer is in the highest tier.
 mlp=true | - | Retrieves the details of each loyalty program of the customer if the org has multiple loyalty programs (multi-brand loyalty).
@@ -3661,7 +3661,7 @@ https://us.api.capillarytech.com/v1.1/customer/referrals&mobile=9197407983xx
                      <element>
                         <identifier>971564265901</identifier>
                         <invited_on>2020-01-29 13:37:36.0</invited_on>
-                        <name>Siddhant</name>
+                        <name>Siva</name>
                         <till>
                            <code>jotun.uae.admin.2</code>
                            <name>jotun.uae.admin.2</name>
@@ -3670,7 +3670,7 @@ https://us.api.capillarytech.com/v1.1/customer/referrals&mobile=9197407983xx
                      <element>
                         <identifier>97150000099</identifier>
                         <invited_on>2020-01-29 13:55:32.0</invited_on>
-                        <name>Harry Test</name>
+                        <name>Harry</name>
                         <till>
                            <code>jotun.uae.admin.2</code>
                            <name>jotun.uae.admin.2</name>
@@ -3679,7 +3679,7 @@ https://us.api.capillarytech.com/v1.1/customer/referrals&mobile=9197407983xx
                      <element>
                         <identifier>97150000099</identifier>
                         <invited_on>2020-01-30 14:56:12.0</invited_on>
-                        <name>Test</name>
+                        <name>Jim</name>
                         <till>
                            <code>jotun.uae.admin.2</code>
                            <name>jotun.uae.admin.2</name>
@@ -3779,7 +3779,7 @@ https://us.api.capillarytech.com/v1.1/customer/referrals&mobile=9197407983xx
                      },
                      {
                         "identifier":"971564265901",
-                        "name":"Siddhant",
+                        "name":"Siva",
                         "invited_on":"2020-01-29 13:37:36.0",
                         "till":{
                            "code":"jotun.uae.admin.2",
@@ -3788,7 +3788,7 @@ https://us.api.capillarytech.com/v1.1/customer/referrals&mobile=9197407983xx
                      },
                      {
                         "identifier":"97150000099",
-                        "name":"Harry Test",
+                        "name":"Harry",
                         "invited_on":"2020-01-29 13:55:32.0",
                         "till":{
                            "code":"jotun.uae.admin.2",
@@ -3797,7 +3797,7 @@ https://us.api.capillarytech.com/v1.1/customer/referrals&mobile=9197407983xx
                      },
                      {
                         "identifier":"97150000099",
-                        "name":"Test",
+                        "name":"Jim",
                         "invited_on":"2020-01-30 14:56:12.0",
                         "till":{
                            "code":"jotun.uae.admin.2",
@@ -4647,12 +4647,12 @@ HTTP Method | POST
 Batch Support | Yes
 
 ### Request URL
-`https://{host}/v1.1/customer/subscriptions?format={xml/json}`
+`https://{host}/1.1/customer/subscriptions?format={xml/json}`
 
 ### Request Body Parameters
 Parameter | Datatype | Description
 --------- | -------- | -----------
-mobile/email/external_id/id* | Provide any of the customer identifiers to update subscription details.
+mobile/email/external_id/id* | string | Provide any of the customer identifiers to update subscription details.
 priority* | enum | Specify the service that you want to update. Value: `TRANS` for personalized messages, and `BULK` for campaign or promotional messages.
 scope | enum | Set scope to 'all' always.
 channel* | enum | Pass the communication channel that you want to update. Value: `sms`, `email`.

source/includes/_customer.md

@@ -441,7 +441,7 @@ http://apac.api.capillarytech.com/v1.1/organization/entities?format=json&type=ti
   }
 }
 ```
-Retrieves the details of zones, stores, store servers, concepts or TILLs configured for the current organization.
+Retrieves the details of zones, stores, store servers, concepts or TILLs configured for the current organization. By default, it fetches up to 200 entities.
 
 ### Resource Information
 | | |
@@ -467,7 +467,7 @@ sub_entities_count | int | Limit the number of sub-entities to retrieve for each
 details | enum | Pass `basic` to see only basic information excluding currency, time-zone, and language information.
 exclude_locale | enum | Pass `1` to exclude time zone details, `0` to retrieve base_timezone details of an entity. Default value is `0`.
 start_id | long | Fetches entities that are above the offset number you pass. Offset is the position of the entity  in the db record. The value is assigned based on the sequence of creation. For example, start_id=10 retrieves all the entities from record number 11.
-limit | int | Limit the number of entities to retrieve.
+limit | int | Limit the number of entities to retrieve. Default value is 200.
 modified_since | date | Retrieves the entities that are modified on or after a specific date. Pass the date in `YYYY-MM-DD` format.
 active_only | boolean | Pass `true` to retrieve the list of only active stores.
 scope | string | Default value: `STORE_CUSTOM_FIELDS`.

source/includes/_organization.md

@@ -5,7 +5,7 @@ Points represent loyalty points of an organization that are issued to the loyalt
 Points cannot be issued through APIs. It can be issued only through modules such as Loyalty Manager, Data Import and Member Care. 
 </aside>
 
-The APIs of points entity are interdependent. For example, to redeem points, first you need to check whether a customer can redeem those points (`isreedemable`), validate customer's registered mobile number by issuing validation code, and then redeem points using the validation code received by the customer.
+The APIs of points entity are interdependent. For example, to redeem points, first you need to check whether a customer can redeem those points (`isredeemable`), validate customer's registered mobile number by issuing validation code, and then redeem points using the validation code received by the customer.
 
 The points entity allows you to perform the following tasks:
 
@@ -18,7 +18,7 @@ The points entity allows you to perform the following tasks:
 > Sample Request
 
 ```html
-http://us.intouch.capillarytech.com/v1.1/points/isredeemable?points=100&issue_otp=true&mobile=44700900999&format=json
+http://us.intouch.capillarytech.com/v1.1/points/isredeemable?program_id=504&points=100&issue_otp=true&mobile=44700900999&format=json
 ```
 > Sample Response
 
@@ -145,6 +145,8 @@ Parameter | Datatype | Description
 --------- | -------- | -----------
 identifier* | enum | Pass any of the identifier type of the customer.
 value | string | Pass the respective identifier value of the customer to issue validation code.
+program_id | long | Unique ID of the loyalty program from which points need to redeem.
+group_redemption  | boolean | Pass `true` for group redemption - points earned in one program need to redeem in a different program of the org.
 points* | int | Number of points to redeem.
 issue_otp | boolean | Pass `true` to issue OTP if the validation is successful.
 validation_code | string | OTP issued to the customer's mobile number.
@@ -295,7 +297,8 @@ http://us.intouch.capillarytech.com/v1.1/points/redeem?validation_type=SMS&progr
             "transaction_number": "red123",
             "till_id": "",
             "notes": "10 points redemption by SMS.",
-            "validation_code": "4PZGXC"
+            "validation_code": "4PZGXC",
+			"group_redemption": "false"
            }
        ]
    }
@@ -319,6 +322,7 @@ http://us.intouch.capillarytech.com/v1.1/points/redeem?validation_type=SMS&progr
             <till_id />
             <transaction_number>red123</transaction_number>
             <validation_code>4PZGXC</validation_code>
+			<group_redemption>false</group_redemption>
          </element>
       </redeem>
    </root>
@@ -445,6 +449,8 @@ transaction_number | string | Provide the transaction number for which the point
 validation_code* | string | Provide the validation code received by the customer through `points/validationcode`.
 redemption_time | date-time | Provide the redemption date and time in YYYY-MM-DD HH-MM-SS format.
 program_id | long | Program id associated to the points that you want to redeem. Required only for orgs with MLP enabled.
+till_id | string | Till ID from which points are redeemed.
+group_redemption | boolean | Pass `true` for cross program redemption, that is, redeem loyalty points earned in a loyalty program in a different loyalty program of the org. Default value is `false`. 
 
 <aside class="notice">Parameters marked with * are mandatory.</aside>
 
@@ -499,7 +505,7 @@ Code | Description
 814 | No points were redeemed on this transaction number
 815 | Unable to process points at this moment. Please try again later
 816 | Unable to find customer in this organization
-817 | Points redemption failed
+817 | Points redemption failed. 
 818 | Points you are trying to redeem are more than the available points
 819 | Points you are trying to redeem are more than the maximum allowed redemption limit.<br> Unable to send message to customer
 820 | Unable to process. Customer is marked as fraud
@@ -514,6 +520,7 @@ Code | Description
 860 | Unable to issue OTP
 881 | Customer is not registered into the loyalty program
 888 | Configuration is invalid. Please report to Capillary Support
+889 | Points processing failed. Please try again later. 
 894 | Unable to process points at this moment. Please try again later
 895 | Loyalty program is not configured for your organization
 898 | Unable to process points at this moment. Please try again later

source/includes/_points.md

@@ -1393,7 +1393,7 @@ http://us.api.capillarytech.com/v1.1/task/reminder?format=xml&only_for_stores=tr
         <local_id></local_id>
         <time>2016-05-30 12:12:12</time>
         <created_by>453345</created_by>
-        <!-- created_by needs to be assoc_id -->
+        <!-- created_by needs to be associate_id of the admin user -->
         <template>Please note this</template>
     <remindee_id>1245332</remindee_id>
     </reminder>

source/includes/_task.md

@@ -2202,6 +2202,8 @@ old_type | enum | Previous transaction type - usually `NOT_INTERESTED` for retro
 ```html
 https://us.api.capillarytech.com/v1.1/transaction/get?number=BILL7&format=json
 ```
+
+
 > Sample Response
 
 ```json