Add the transaction date of the activity. The transaction date would be considered for all activities except for the submit a receipt activity. Format : MM/DD/YYYY HH:MM:SS
Note: Our API records all date and time fields in UTC time.
- `points_passed` integer — Set custom points for an activity. You can set custom points for all activities except made_a_purchase activity. - `approval_date` string —Date and time on which the transaction will be auto approved. Format : MM/DD/YYYY HH:MM:SS.
Note: Our API records all date and time fields in UTC time.
- `points_expiration_date` string —Date and time on which points will expire. Format : MM/DD/YYYY HH:MM:SS.
Note: Our API records all date and time fields in UTC time.
- `transaction_attributes` string, json —Every activity has a two predefined transaction attributes - reason and tags. While awarding points for an activity, data can be passed in these attributes.
Custom attributes: In addition to the predefined attributes, you can define custom attributes for each activity and pass data in those attributes.
The custom attribute should be created in advance. To create custom attributes for your store, reach out to your account manager at support.zinrelo.com.
Note: "transaction_attributes" is mandatory only for 3 of the predefined activities.
Mandatory attributes are order_id, order_total, order_subtotal.
The order_subtotal should be greater than 0.01
A sample structure of the transaction_attributes for the made_a_purchase activity is given below:
{"tags" : ["tag1","tag2"],"reason" : "purchase","order_id" : "75","coupons" : "$5OFFVYZ,$10FFEDT,$05RTNVLW","order_total" : "1000","order_subtotal" : "1000",
"products" : [{"product_id": "112","product_quantity": "1","product_category": "tshirt, blue range, on sale","product_price": "15","product_title": "Sweatshirt","product_image_url": ""},
{"product_id": "980","product_quantity": "2","product_category": "sales, straight range of pants, formals, on 10% discount","product_price": "10.017","product_title": "Pant","product_image_url": ""}]
}
Note:
- The attributes like “product_id”, “product_price”, “product_quantity” and “product_title” are mandatory only when you pass product attributes.
- The order subtotal should be calculated as the sum of the subtotals of all products in the order, without taking into account any discounts. The discounted price needs to be adjusted in products and passed accordingly.
- We are also accepting product quantity in decimal values.
- When individual product prices are provided, the subtotal is ignored.
- In instances where product information is absent, the purchase amount is derived from the 'order_subtotal' field.
Mandatory attribute is 'receipt_files'. 'receipt_uid' is the optional field. Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.
A sample structure of the transaction_attributes for the submit_a_receipt activity is given below:
{"receipt_files":[""]}
Mandatory attribute is image_file. Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.
A sample structure of the transaction_attributes for the upload_photo activity is given below:
{"image_file": [""]}
To know more about the transaction attributes for Award API, click here.
## Response `200` 200 - AwardPointsDataObject - `data` AwardPointsResponseObject - `status` string — The transaction status can be one of three: Approved, Rejected, or Pending. - `points_expiration_date` string — The date on which points will expire. - `auto_approval_date` string — The "auto approval date" for a transaction signifies the date when the transaction will be automatically approved. This approval mechanism can be established through an API or can be configured by setting the "after a fixed duration" option within the approval type in the activities settings page within the admin console. When this specified date arrives, the transaction will undergo automatic approval as per the settings configured. - `last_modified_date` string — The most recent date on which a transaction was updated. - `award_info` AwardPointAwardInfo - `activity_id` string — The unique ID of the activity assigned by Zinrelo. - `points` integer — The points awarded for an activity. - `points_status` string — This indicates the status of the points, which might be 'approved,' 'rejected,' 'pending,' 'expired,' 'auto_rejected,' or 'auto_approved.' - `activity_name` string — The activity name stored with Zinrelo. - `id` string — The internal ID generated by Zinrelo. - `approver_details` AwardPointsApproverDetailsObject - `approver_name` string — The person or source who approves the transaction. - `approver_id` string — The unique ID associated with the approver. - `approved_date` string — The date on which the transaction was approved. - `member_id` string — The unique identifier of the member defined by an Admin. - `created_date` string — The date and time on which the transaction was created. - `transaction_type` string — This field specifies the transaction type. In the case of the award API, it will always be designated as "award." - `transaction_attributes` AwardPointsTransactionAttributesObject — By utilizing transaction attributes, you can define attributes for transactions. You can leverage these attributes for personalization and reporting purposes. For more details, refer- https://help.zinrelo.com/docs/custom-attributes - `order_total` integer — Gross total amount of the order including shipping. discount, etc. - `order_subtotal` integer — Net total amount of the order excluding shipping, discount. Points will be awarded to the member based on this amount. - `order_id` string — The order ID of the order which is being placed. This field is used to uniquely identify the order. - `tags` string[] — The tags associated with the transaction. - `currency` string — The currency store supports. - `coupon_code` string — The coupon code issued for the transaction. - `reason` string — The reason associated with the transaction. - `products` unknown[] — The list of products. - unknown - `additional_data` AwardPointsAddtionalDataObject - `activity_multiplier` integer — For activities such as "made_a_purchase," this represents the points spent per dollar. - `redemptions_list` unknown[] — In Award API, the redemeption list will always be empty. - unknown - `success` boolean ## Other responses - `400` — 400 --- [API](https://skmtc.net/trueloyal/apis/admin-apis.md) · [All operations](https://skmtc.net/trueloyal/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trueloyal/admin-apis/versions/c12d3d379897/schema)