POST Orders/Annotations

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrderID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Order">
  <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>
  <OrderID>1</OrderID>
</OrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of OrderAnnotation

Name	Type	Additional information
ID	integer	None.
Created	date	None.
Sent	date	None.
Subject	string	None.
Text	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Created": "2025-12-06T05:41:57.8455005+01:00",
    "Sent": "2025-12-06T05:41:57.8455005+01:00",
    "Subject": "sample string 3",
    "Text": "sample string 4"
  },
  {
    "ID": 1,
    "Created": "2025-12-06T05:41:57.8455005+01:00",
    "Sent": "2025-12-06T05:41:57.8455005+01:00",
    "Subject": "sample string 3",
    "Text": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderAnnotation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Order">
  <OrderAnnotation>
    <Created>2025-12-06T05:41:57.8455005+01:00</Created>
    <ID>1</ID>
    <Sent>2025-12-06T05:41:57.8455005+01:00</Sent>
    <Subject>sample string 3</Subject>
    <Text>sample string 4</Text>
  </OrderAnnotation>
  <OrderAnnotation>
    <Created>2025-12-06T05:41:57.8455005+01:00</Created>
    <ID>1</ID>
    <Sent>2025-12-06T05:41:57.8455005+01:00</Sent>
    <Subject>sample string 3</Subject>
    <Text>sample string 4</Text>
  </OrderAnnotation>
</ArrayOfOrderAnnotation>