Toggle Redemption Method Status

PUTv1/managers/loyalty-program/points-redemption/update-status

Enables or disables a specific redemption method within a store's loyalty program.

Request

Header Params

Authorization

string

required

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.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

string

required

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Default:

application/json

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Content-Type

enum<string>

required

The Media Type of the body of the request. This is used to describe the structure of the data in the body.

Allowed values:

application/jsonmultipart/form-dataapplication/x-www-form-urlencoded

Default:

application/json

redemptionRuleUuid

string

optional

A unique identifier for the loyalty redemption rule that is being targeted by the request.

Example:

c5ed20de-fe99-40b8-9fee-36b05b1a8436

status

integer

optional

A flag indicating whether to activate (1) or deactivate (0) the specified loyalty redemption rule.

Example:

{
  "redemptionRuleUuid": "c5ed20de-fe99-40b8-9fee-36b05b1a8436",
  "status": 1
}

Request samples

Responses

OK(200)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

Redemption method status toggled successfully.

status

string

optional

Indicates the overall status of the API response.

redemption_rule

object

optional

The redemption_rule section provides detailed information about a specific point redemption rule.

string

optional

A unique identifier for the specific redemption rule. This ID is used to track and manage the rule within the system.

Example:

7ba3e0ac-0ca9-4eeb-9026-01ec09ea3f6a

external_id

string

optional

An identifier used by external systems to track or reference the redemption rule.

Example:

15505

store_id

string

optional

The unique identifier of the store where this redemption rule is applied.

Example:

8b1cf62d-d05c-4405-949d-5c1cdcc64987

name

string

optional

The name or label given to this redemption rule.

Example:

points_to_redeem

integer

optional

The number of points required to redeem the associated reward. This value represents the cost in points for the customer to obtain the benefit.

Example:

rule_type

string

optional

The type of rule that defines how the reward is calculated or applied.

Example:

percentage_discount_settings

reward

object

optional

conditions

null

optional

Any specific conditions or restrictions that apply to this redemption rule.

is_active

boolean

optional

A boolean value indicating whether this redemption rule is currently active. True means the rule is active and can be used by customers.

Default:

true

created_at

string

optional

The timestamp indicating when the redemption rule was created.

Example:

2023-04-03T09:17:47.000000Z

updated_at

string

optional

The timestamp indicating when the redemption rule was updated.

Example:

2023-08-03T09:17:47.000000Z

deleted_at

null

optional

The timestamp indicating when the redemption rule was deleted.

message

object

optional

Contains detailed information about the message.

type

string

optional

Specifies the type of message.

code

string

optional

A specific code representing the type.

Example:

MSG_POPUP_OK

name

string

optional

A short, human-readable title or name for the message.

Example:

Points redemption

description

string

optional

A detailed description of the message, providing more context.

Example:

Update point redemption method status

{
  "status": "string",
  "redemption_rule": {
    "id": "7ba3e0ac-0ca9-4eeb-9026-01ec09ea3f6a",
    "external_id": "15505",
    "store_id": "8b1cf62d-d05c-4405-949d-5c1cdcc64987",
    "name": "35",
    "points_to_redeem": 35,
    "rule_type": "percentage_discount_settings",
    "reward": {
      "discount_value": 3
    },
    "conditions": null,
    "is_active": true,
    "created_at": "2023-04-03T09:17:47.000000Z",
    "updated_at": "2023-08-03T09:17:47.000000Z",
    "deleted_at": null
  },
  "message": {
    "type": "string",
    "code": "MSG_POPUP_OK",
    "name": "Points redemption",
    "description": "Update point redemption method status"
  }
}

Last modified: 8 days ago