Zid Docs
Adjust Customer Points
POSTv1/managers/loyalty-program/customers/adjust-customer-pointsAllows manual adjustments to a customer's loyalty points balance.
Request
Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.
The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.
The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.
Preferred language for the response. Defaults to en if not specified.
This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.
The unique identifier of the customer.
Indicates the direction of the points transaction. It can specify whether points are being added to or subtracted from the customer's account.
The number of loyalty points involved in the transaction. This value represents the quantity of points being added or subtracted.
A brief explanation or description of the reason for the points transaction. This provides context for why the points are being added or subtracted
{
"customerId": 1234,
"direction": "\"add\"",
"points": 50,
"reason": "\"Purchase reward\""
}Request samples
Responses
The customer points balance is adjusted successfully.
Indicates the overall status of the API response.
The data object contains information about the points adjustment made to the customer's account.
The timestamp indicating when the points adjustment was made. The date and time are provided in ISO 8601 format.
The reason for adjusting the points.
The number of points that were adjusted (added or subtracted) in the customer's account.
Indicates whether points were added or subtracted from the customer's account. A value of "+" means points were added, while a value of "-" would indicate points were subtracted.
The type of transaction, indicating how the points were adjusted. "ManualAccumulation" suggests that the points were added manually by an administrator or system user.
The order number associated with this points adjustment.
The date and time when the points will expire.
The current status of the points after the adjustment.
Describes how the points were added to the customer's account, indicating that this was done manually rather than through an automated process or system trigger.
Contains detailed information about the message.
Specifies the type of message.
A specific code representing the type.
A short, human-readable title or name for the message.
A detailed description of the message, providing more context.
{
"status": "string",
"data": {
"date": "2024-08-19T07:01:03.580901Z",
"reason": "test",
"points": 100,
"direction": "+",
"type": "ManualAccumulation",
"order_number": null,
"expiry_date": null,
"point_status": "Active",
"collection_method": "Manually added points"
},
"message": {
"type": "string",
"code": "MSG_POPUP_OK",
"name": "Adjust customer points",
"description": "Points updated successfully"
}
}