post https://{host}/api_gateway/rewards/core/v1/fulfillmentStatus
This API allows you to define the predefined values for fulfillment statuses.
For example: A brand can have a fulfillment status as the Reward is ON ITS WAY before delivering the reward to the customer.
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
You can create custom fields with the scope set to ISSUE_REWARD to track and manage various stages of the reward issuance process.
Prerequisites
- Basic or OAuth Authentication
- Default access group
Resource information
| URI | /api_gateway/rewards/core/v1/fulfillmentStatus |
| HTTP Method | POST |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/fulfillmentStatus
Request body parameters
| Parameter | Data type | Description |
|---|---|---|
| name* | String | Name of the fulfillment status. |
[
{ "name": "ON ITS WAY"},
{"name": "DELIVERING SOON"}
]
Response parameters
| Parameter | Data Type | Description |
|---|---|---|
| orgId | Integer | ID of the org. |
| name | String | Name of the status |
| isEnabled | Boolean | Indicates if the status is enabled. By default the isEnabled parameter is set to true. |
| createdBy | Integer | Identifier of the user who created the status |
| createdOn | Long | Timestamp of when the status was created |
| lastUpdatedBy | Integer | Identifier of the user who last updated the status |
| lastUpdatedOn | Long | Timestamp of when the status was last updated |
[
{
"orgId": 100458,
"name": "ON ITS WAY",
"isEnabled": true,
"createdBy": 75130850,
"createdOn": 1721647977781,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721647977781
},
{
"orgId": 100458,
"name": "DELIVERING SOON",
"isEnabled": true,
"createdBy": 75130850,
"createdOn": 1721647977781,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721647977781
}
]