POST Customers/AddCustomerPoints
Retrieves an existing CustomerPoints.
Request Information
URI Parameters
None.
Body Parameters
AddCustomerPointsBinding| Name | Description | Type | Additional information |
|---|---|---|---|
| RefundExpiration |
Beyond this date, this customerPoint redemption cannot be cancelled without loss If a redeemed CustomerPoint is cancelled, e.g. because of an order return, a new CustomerPoint can be created if this this date is not overdue and the new CustomerPoint.Expiration = RefundExpiration |
date |
None. |
| Expiration | date |
None. |
|
|
Identifies customer by Email |
string |
None. |
|
| CustomerID | string |
String length: inclusive between 0 and 128 |
|
| RewardID |
Rewards adds points |
integer |
None. |
| OrderID |
Used to log transactions due to an order placement or return Order may add or substract points |
integer |
None. |
| Points |
Provide a negative number if needed |
integer |
None. |
| Observations | string |
None. |
|
| Amount |
con IVA |
decimal number |
None. |
| Base |
sin IVA |
decimal number |
None. |
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"RefundExpiration": "2025-12-06T05:42:41.0135407+01:00",
"Expiration": "2025-12-06T05:42:41.0135407+01:00",
"Email": "sample string 1",
"CustomerID": "sample string 2",
"RewardID": 1,
"OrderID": 1,
"Points": 3,
"Observations": "sample string 4",
"Amount": 5.0,
"Base": 6.0,
"Lang": "sample string 7",
"StoreID": 8
}
application/xml, text/xml
Sample:
<AddCustomerPointsBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Customer"> <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 7</Lang> <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">8</StoreID> <Amount>5</Amount> <Base>6</Base> <CustomerID>sample string 2</CustomerID> <Email>sample string 1</Email> <Expiration>2025-12-06T05:42:41.0135407+01:00</Expiration> <Observations>sample string 4</Observations> <OrderID>1</OrderID> <Points>3</Points> <RefundExpiration>2025-12-06T05:42:41.0135407+01:00</RefundExpiration> <RewardID>1</RewardID> </AddCustomerPointsBinding>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
integerResponse Formats
application/json, text/json
Sample:
1
application/xml, text/xml
Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>