Cashback Rule Method Update

POSTv1/managers/loyalty-program/points-collection/update

Updates the configuration of a cashback rule 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:

X-Manager-Token

string

required

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.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

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

ruleId

string

optional

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

Example:

7656e0f6-0259-4bcf-90d6-b7ad1fcdcb2f

config

object

optional

Contains the configuration settings for the loyalty cashback rule.

money

integer

optional

The amount of money required to earn points under the loyalty cashback rule.

Example:

100

points

integer

optional

The number of points earned for the specified amount of money.

Example:

{
  "ruleId": "7656e0f6-0259-4bcf-90d6-b7ad1fcdcb2f",
  "config": {
    "money": 100,
    "points": 1
  }
}

Request samples

Responses

OK(200)

Bad Request(400)

HTTP Code: 200

Content Type : JSONapplication/json

The cashback rule method status is updated successfully.

status

object

optional

Indicates the overall status of the API response.

data

object

optional

The data section provides details about the status of the points collection update and the specifics of the points collection methods.

status

boolean

optional

Indicates that the points collection method has been successfully updated.

Default:

true

message

string

optional

A confirmation message indicating that the points collection method was updated without any issues.

Example:

Points collection updated successfully

is_cashback_enabled

boolean

optional

Indicates whether the cashback feature is enabled.

Default:

false

points_collection_methods_list

array [object {10}]

optional

This is a list of the different methods available for collecting points, detailing the specifics of each method.

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 collection

description

string

optional

A detailed description of the message, providing more context.

Example:

Points collection updated successfully

{
  "status": {},
  "data": {
    "status": true,
    "message": "Points collection updated successfully",
    "is_cashback_enabled": false,
    "points_collection_methods_list": [
      {
        "id": "b1e3ca5d-2a89-4993-89bf-0f31a4b70b00",
        "external_id": "pos",
        "store_id": "3dfc16e6-ad19-4126-9c2a-5e4a7fb73051",
        "points_rewarded": 1,
        "amount_to_spend": 100,
        "available_to": null,
        "is_active": false,
        "created_at": "2023-12-28T10:32:13.000000Z",
        "updated_at": "2023-08-28T10:32:13.000000Z",
        "deleted_at": null
      }
    ]
  },
  "message": {
    "type": "string",
    "code": "MSG_POPUP_OK",
    "name": "Points collection",
    "description": "Points collection updated successfully"
  }
}

Last modified: 8 days ago