POST Customers/CustomerPoints
Retrieves existing CustomerPoints
Request Information
URI Parameters
None.
Body Parameters
CustomerRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | string |
Required String length: inclusive between 0 and 128 |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": "sample string 1",
"Lang": "sample string 2",
"StoreID": 3
}
application/xml, text/xml
Sample:
<CustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Customer"> <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang> <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID> <ID>sample string 1</ID> </CustomerRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of CustomerPoints| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| Expiration | date |
None. |
|
| 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. |
| CustomerID | string |
None. |
|
| 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. |
| Amount |
con IVA |
decimal number |
None. |
| Base |
sin IVA |
decimal number |
None. |
| Points | integer |
None. |
|
| Observations | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": 1,
"Created": "2025-12-06T05:40:48.5326413+01:00",
"Modified": "2025-12-06T05:40:48.5326413+01:00",
"Expiration": "2025-12-06T05:40:48.5326413+01:00",
"RefundExpiration": "2025-12-06T05:40:48.5326413+01:00",
"CustomerID": "sample string 4",
"RewardID": 1,
"OrderID": 1,
"Amount": 5.0,
"Base": 6.0,
"Points": 7,
"Observations": "sample string 8"
},
{
"ID": 1,
"Created": "2025-12-06T05:40:48.5326413+01:00",
"Modified": "2025-12-06T05:40:48.5326413+01:00",
"Expiration": "2025-12-06T05:40:48.5326413+01:00",
"RefundExpiration": "2025-12-06T05:40:48.5326413+01:00",
"CustomerID": "sample string 4",
"RewardID": 1,
"OrderID": 1,
"Amount": 5.0,
"Base": 6.0,
"Points": 7,
"Observations": "sample string 8"
}
]
application/xml, text/xml
Sample:
<ArrayOfCustomerPoints xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer">
<CustomerPoints>
<Amount>5</Amount>
<Base>6</Base>
<Created>2025-12-06T05:40:48.5326413+01:00</Created>
<CustomerID>sample string 4</CustomerID>
<Expiration>2025-12-06T05:40:48.5326413+01:00</Expiration>
<ID>1</ID>
<Modified>2025-12-06T05:40:48.5326413+01:00</Modified>
<Observations>sample string 8</Observations>
<OrderID>1</OrderID>
<Points>7</Points>
<RefundExpiration>2025-12-06T05:40:48.5326413+01:00</RefundExpiration>
<RewardID>1</RewardID>
</CustomerPoints>
<CustomerPoints>
<Amount>5</Amount>
<Base>6</Base>
<Created>2025-12-06T05:40:48.5326413+01:00</Created>
<CustomerID>sample string 4</CustomerID>
<Expiration>2025-12-06T05:40:48.5326413+01:00</Expiration>
<ID>1</ID>
<Modified>2025-12-06T05:40:48.5326413+01:00</Modified>
<Observations>sample string 8</Observations>
<OrderID>1</OrderID>
<Points>7</Points>
<RefundExpiration>2025-12-06T05:40:48.5326413+01:00</RefundExpiration>
<RewardID>1</RewardID>
</CustomerPoints>
</ArrayOfCustomerPoints>