本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！

Update Customer Loyalty Points

Develop Env

https://echo.apifox.com/anything

POST

/customers/loyalty/points

Last modified:2025-02-20 07:53:20

Maintainer:Not configured

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.

Scopes

customers.read_write - Customers Read & write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params 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

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://echo.apifox.com/anything/customers/loyalty/points' \
--header 'Content-Type: application/json' \
--data-raw '{
    "points": 900,
    "reset_point": false,
    "type": "plus",
    "reason": "Valid reason text",
    "channel_send": [
        "email",
        "sms"
    ],
    "customers": [
        748394059, 873874834
    ]
}'

Responses

🟢201Created

application/json

Body

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

Example

{
    "status": 201,
    "success": true,
    "data": {
        "code": 201,
        "message": "تم تحديث نقاط الولاء للعملاء بنجاح"
    }
}

🟠422Validation

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-02-20 07:53:20

Customer Loyalty Points

Order