POST Customers/CustomerAnnotations

Request Information

URI Parameters

None.

Body Parameters

CustomerRequest
NameDescriptionTypeAdditional 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 CustomerAnnotation
NameDescriptionTypeAdditional 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:40:38.8375128+01:00",
    "Modified": "2025-12-06T05:40:38.8375128+01:00",
    "UserID": "sample string 4",
    "Text": "sample string 5",
    "LanguageID": 6
  },
  {
    "ID": 1,
    "Created": "2025-12-06T05:40:38.8375128+01:00",
    "Modified": "2025-12-06T05:40:38.8375128+01:00",
    "UserID": "sample string 4",
    "Text": "sample string 5",
    "LanguageID": 6
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomerAnnotation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer">
  <CustomerAnnotation>
    <Created>2025-12-06T05:40:38.8375128+01:00</Created>
    <ID>1</ID>
    <LanguageID>6</LanguageID>
    <Modified>2025-12-06T05:40:38.8375128+01:00</Modified>
    <Text>sample string 5</Text>
    <UserID>sample string 4</UserID>
  </CustomerAnnotation>
  <CustomerAnnotation>
    <Created>2025-12-06T05:40:38.8375128+01:00</Created>
    <ID>1</ID>
    <LanguageID>6</LanguageID>
    <Modified>2025-12-06T05:40:38.8375128+01:00</Modified>
    <Text>sample string 5</Text>
    <UserID>sample string 4</UserID>
  </CustomerAnnotation>
</ArrayOfCustomerAnnotation>