POST Customers/CustomerAnnotation
Retrieves a CustomerAnnotation
Request Information
URI Parameters
None.
Body Parameters
CustomerAnnotationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| CustomerID | string |
Required String length: inclusive between 0 and 128 |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": 1,
"CustomerID": "sample string 2",
"Lang": "sample string 3",
"StoreID": 4
}
application/xml, text/xml
Sample:
<CustomerAnnotationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer"> <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 3</Lang> <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">4</StoreID> <CustomerID>sample string 2</CustomerID> <ID>1</ID> </CustomerAnnotationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CustomerAnnotation| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| UserID | string |
None. |
|
| Text | string |
None. |
|
| LanguageID |
The language of the comment |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": 1,
"Created": "2025-12-06T05:42:42.7410021+01:00",
"Modified": "2025-12-06T05:42:42.7410021+01:00",
"UserID": "sample string 4",
"Text": "sample string 5",
"LanguageID": 6
}
application/xml, text/xml
Sample:
<CustomerAnnotation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer"> <Created>2025-12-06T05:42:42.7410021+01:00</Created> <ID>1</ID> <LanguageID>6</LanguageID> <Modified>2025-12-06T05:42:42.7410021+01:00</Modified> <Text>sample string 5</Text> <UserID>sample string 4</UserID> </CustomerAnnotation>