Zid Docs

Add Redemption to Cart

POSTv1/stores/<<STORE_ID>>/carts/loyalty-redemption-method/add

Allows adding a chosen redemption method to a customer's shopping cart.

Request

Header Params

string

optional

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

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

Accept-Language

enum<string>

optional

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

Allowed value:

Default:

User-Agent

string

optional

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.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

CART-SESSION-ID

string

required

A unique identifier for the current cart session.

Example:

63ac14b3b6d6f883e2be179f6652890f

X-CUSTOMER-TOKEN

string

required

The X-CUSTOMER-TOKEN is a unique identifier generated when a customer logs in through the customer-login API. This token acts as the standard authorization mechanism, allowing the system to recognize the logged-in customer and grant them access to appropriate resources.

point_redemption_method

object

optional

Contains details about a specific point redemption method that the user wants to add or update.

string

optional

A unique identifier for the point redemption method.

Example:

c2e3d648-8fb2-4dde-8ce3-4c71ddd9a181

external_id

integer

optional

An external identifier associated with the point redemption method.

Example:

1667

store_id

string

optional

The unique identifier of the store associated with this redemption method.

Example:

cba413cc-a358-4a1a-b8b1-711122555215

name

string

optional

The name or label of the redemption method.

Example:

points_to_redeem

integer

optional

The number of points required to redeem this reward.

Example:

rule_type

string

optional

The type of rule applied to the redemption method, such as "fixed_rate_settings".

Example:

fixed_rate_settings

reward

object

optional

Details about the reward associated with the redemption method.

conditions

null

optional

Any conditions or restrictions applicable to the redemption method. Null indicates no specific conditions.

is_active

integer

optional

Indicates whether the redemption method is currently active.

Example:

created_at

string

optional

The date and time when the redemption method was created, in ISO 8601 format.

Example:

2023-05-31T14:26:43.000000Z

updated_at

string

optional

The date and time when the redemption method was last updated, in ISO 8601 format.

Example:

2023-05-31T14:26:43.000000Z

deleted_at

null

optional

The date and time when the redemption method was deleted, if applicable.

{
  "point_redemption_method": {
    "id": "c2e3d648-8fb2-4dde-8ce3-4c71ddd9a181",
    "external_id": 1667,
    "store_id": "cba413cc-a358-4a1a-b8b1-711122555215",
    "name": "5",
    "points_to_redeem": 5,
    "rule_type": "fixed_rate_settings",
    "reward": {
      "discount_value": 5
    },
    "conditions": null,
    "is_active": 1,
    "created_at": "2023-05-31T14:26:43.000000Z",
    "updated_at": "2023-05-31T14:26:43.000000Z",
    "deleted_at": null
  }
}

Request samples

Responses

OK(200)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

The redemption method is added to the cart successfully.

code

string

optional

A status code indicating the outcome of the operation. In this case, "SUCCESS_WITHOUT_PAYLOAD" suggests that the loyalty points were redeemed successfully, but no additional data or payload is returned with the response.

Example:

SUCCESS_WITHOUT_PAYLOAD

message

string

optional

A confirmation message indicating that the loyalty points have been successfully redeemed.

Example:

Loyalty points redeemed successfully

{
  "code": "SUCCESS_WITHOUT_PAYLOAD",
  "message": "Loyalty points redeemed successfully"
}

Last modified: 3 months ago