Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs

    [lightMode]

    Update Customer Loyalty Points

    Developing
    POST/customers/loyalty/points
    [updatedIn] 5 days ago

    This endpoint enables you to add loyalty points to customers, helping to enhance engagement and reward customer loyalty.

    :::info
    This endpoint will work only if the store has Customer Loyalty application installed.
    :::

    `customers.read_write` - Customers Read & write

    Request

    Authorization: OAuth 2.0
    Add the parameter
    Authorization
    to [header]    ，whose value is to concatenate the Token after the Bearer.
    [api.label.example]
    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    [message.bodyParameter]application/json
    points
    number 
    required

    Loyalty points, required unless rest_point is set to true

    >= 1<= 999999
    Example:
    100
    reset_points
    boolean 
    optional

    Boolean value to reset loyalty points

    type
    enum<string> 
    required

    The type of increasing points or decreasing points "plus" or "minus"

    Allowed values:
    plusminus
    reason
    string 
    required

    Text for showing the reason for the update

    channel_send
    array[string]
    required

    Select which channel to send

    Allowed values:
    emailsmsmobile
    customers
    array[number]
    required

    Customers list that will receive loyalty points

    select_all
    boolean 
    optional

    Selecting all customers

    [api.label.example]
    {
  "points": 900,
  "reset_point": false,
  "type": "plus",
  "reason": "Valid reason text",
  "channel_send": [
    "email",
    "sms"
  ],
  "customers": [
    748394059,
    873874834
  ]
}

    Request samples

    [api.label.responses]

    Created(201)
    Validation(422)
    Bad Request(400)
    HTTP Code: 201
    Content Type : JSONapplication/json
    [response.label.jsonSchema]
    status
    integer 
    required

    Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

    success
    boolean 
    required

    Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

    data
    object 
    required
    message
    string 
    required

    Message indicator of response status

    [api.label.example]
    {
  "status": 201,
  "success": true,
  "data": {
    "code": 201,
    "message": "تم تحديث نقاط الولاء للعملاء بنجاح"
  }
}
    [updatedIn] 5 days ago