Skip to main content
POST
/
cart
/
setReferral
Apply a referral code to the user's cart
curl --request POST \
  --url https://v3.minestorecms.com/api/cart/setReferral \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref_code": "ABC123"
}
'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
ref_code
string
required

The referral code to be applied to the cart.

Example:

"ABC123"

Response

Successfully applied the referral code to the cart.

​
success
boolean

Indicates if the referral code was successfully applied.

​
message
string

A message indicating the result of the referral code application.