PATCH Api/v{apiVersion}/Orders/{id}?property={property}&value={value}

Patches an order

Request Information

URI Parameters

Name	Type	Additional information
id	globally unique identifier	Required
property	string	Required
value	string	Required
apiVersion	string	None.

Body Parameters

None.

Response Information

Resource Description

OrderDetails

Name	Type	Additional information
OrderID	globally unique identifier	None.
Number	integer	None.
Store	StorePreview	None.
Campaign	CampaignPreview	None.
Status	OrderStatus	None.
Date	date	None.
IsApprovalRequired	boolean	None.
StoreBudgetAmount	decimal number	None.
StoreBudgetSpentAmount	decimal number	None.
StoreBudgetSpentPercent	decimal number	None.
TotalAmount	decimal number	None.
Remarks	string	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderID": "570cfdb1-4e5d-46a4-ac36-1b69c92942c5",
  "Number": 2,
  "Store": {
    "StoreID": "089e8a3d-428f-4a42-be1c-13f59a72bc4f",
    "ParentName": "sample string 2",
    "Name": "sample string 3",
    "Customer": {
      "CustomerID": "fb6cf665-2018-4135-a1e1-02c6396be56f",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "Address": "sample string 4",
      "City": {
        "AreaID": "73024ff8-8d1b-4269-816c-22f4b9bee59e",
        "ParentID": "cb959e97-98a4-424e-b200-8c8ae79fe729",
        "ParentName": "sample string 2",
        "SupplierName": "sample string 3",
        "CustomerName": "sample string 4",
        "StoreName": "sample string 5",
        "Code": "sample string 6",
        "Name": "sample string 7",
        "Type": "Neighbourhood",
        "Status": "InActive",
        "OwnerName": "sample string 8",
        "Population": 9,
        "Mailboxes": 10
      },
      "Postcode": "sample string 5",
      "IsBackendCustomer": true,
      "Contact": "sample string 7",
      "PhoneNumber": "sample string 8"
    },
    "Status": "InActive",
    "Address": "sample string 4",
    "City": {
      "AreaID": "73024ff8-8d1b-4269-816c-22f4b9bee59e",
      "ParentID": "cb959e97-98a4-424e-b200-8c8ae79fe729",
      "ParentName": "sample string 2",
      "SupplierName": "sample string 3",
      "CustomerName": "sample string 4",
      "StoreName": "sample string 5",
      "Code": "sample string 6",
      "Name": "sample string 7",
      "Type": "Neighbourhood",
      "Status": "InActive",
      "OwnerName": "sample string 8",
      "Population": 9,
      "Mailboxes": 10
    },
    "Postcode": "sample string 5",
    "Contact": "sample string 6",
    "PhoneNumber": "sample string 7",
    "MarketAreaName": "sample string 8",
    "IsAttentionNeeded": true
  },
  "Campaign": {
    "CampaignID": "24c7bf07-bf45-47c8-800f-948b88862656",
    "Customer": {
      "CustomerID": "fb6cf665-2018-4135-a1e1-02c6396be56f",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "Address": "sample string 4",
      "City": {
        "AreaID": "73024ff8-8d1b-4269-816c-22f4b9bee59e",
        "ParentID": "cb959e97-98a4-424e-b200-8c8ae79fe729",
        "ParentName": "sample string 2",
        "SupplierName": "sample string 3",
        "CustomerName": "sample string 4",
        "StoreName": "sample string 5",
        "Code": "sample string 6",
        "Name": "sample string 7",
        "Type": "Neighbourhood",
        "Status": "InActive",
        "OwnerName": "sample string 8",
        "Population": 9,
        "Mailboxes": 10
      },
      "Postcode": "sample string 5",
      "IsBackendCustomer": true,
      "Contact": "sample string 7",
      "PhoneNumber": "sample string 8"
    },
    "Name": "sample string 2",
    "Type": "NoInformation",
    "Status": "InActive",
    "StartDate": "2026-01-15T13:44:04.1445867Z",
    "EndDate": "2026-01-15T13:44:04.1445867Z",
    "IsRunning": true,
    "IsOrderingAllowed": true,
    "NumberOfOrders": 7,
    "TotalBudgetAmount": 1.1,
    "TotalSpentAmount": 8.1
  },
  "Status": "Pending",
  "Date": "2026-01-15T13:44:04.1445867Z",
  "IsApprovalRequired": true,
  "StoreBudgetAmount": 1.1,
  "StoreBudgetSpentAmount": 1.1,
  "StoreBudgetSpentPercent": 1.1,
  "TotalAmount": 5.1,
  "Remarks": "sample string 6",
  "Notes": "sample string 7",
  "CreatedAt": "2026-01-15T13:44:04.1445867Z",
  "CreatedBy": "sample string 9",
  "ModifiedAt": "2026-01-15T13:44:04.1445867Z",
  "ModifiedBy": "sample string 11"
}

application/xml, text/xml

Sample:

<OrderDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <Campaign>
    <CampaignID>24c7bf07-bf45-47c8-800f-948b88862656</CampaignID>
    <Customer>
      <Address>sample string 4</Address>
      <City>
        <AreaID>73024ff8-8d1b-4269-816c-22f4b9bee59e</AreaID>
        <Code>sample string 6</Code>
        <CustomerName>sample string 4</CustomerName>
        <Mailboxes>10</Mailboxes>
        <Name>sample string 7</Name>
        <OwnerName>sample string 8</OwnerName>
        <ParentID>cb959e97-98a4-424e-b200-8c8ae79fe729</ParentID>
        <ParentName>sample string 2</ParentName>
        <Population>9</Population>
        <Status>InActive</Status>
        <StoreName>sample string 5</StoreName>
        <SupplierName>sample string 3</SupplierName>
        <Type>Neighbourhood</Type>
      </City>
      <Contact>sample string 7</Contact>
      <CustomerID>fb6cf665-2018-4135-a1e1-02c6396be56f</CustomerID>
      <IsBackendCustomer>true</IsBackendCustomer>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 8</PhoneNumber>
      <Postcode>sample string 5</Postcode>
      <Status>InActive</Status>
    </Customer>
    <EndDate>2026-01-15T14:44:04.1445867+01:00</EndDate>
    <IsOrderingAllowed>true</IsOrderingAllowed>
    <IsRunning>true</IsRunning>
    <Name>sample string 2</Name>
    <NumberOfOrders>7</NumberOfOrders>
    <StartDate>2026-01-15T14:44:04.1445867+01:00</StartDate>
    <Status>InActive</Status>
    <TotalBudgetAmount>1.1</TotalBudgetAmount>
    <TotalSpentAmount>8.1</TotalSpentAmount>
    <Type>NoInformation</Type>
  </Campaign>
  <CreatedAt>2026-01-15T14:44:04.1445867+01:00</CreatedAt>
  <CreatedBy>sample string 9</CreatedBy>
  <Date>2026-01-15T14:44:04.1445867+01:00</Date>
  <IsApprovalRequired>true</IsApprovalRequired>
  <ModifiedAt>2026-01-15T14:44:04.1445867+01:00</ModifiedAt>
  <ModifiedBy>sample string 11</ModifiedBy>
  <Notes>sample string 7</Notes>
  <Number>2</Number>
  <OrderID>570cfdb1-4e5d-46a4-ac36-1b69c92942c5</OrderID>
  <Remarks>sample string 6</Remarks>
  <Status>Pending</Status>
  <Store>
    <Address>sample string 4</Address>
    <City>
      <AreaID>73024ff8-8d1b-4269-816c-22f4b9bee59e</AreaID>
      <Code>sample string 6</Code>
      <CustomerName>sample string 4</CustomerName>
      <Mailboxes>10</Mailboxes>
      <Name>sample string 7</Name>
      <OwnerName>sample string 8</OwnerName>
      <ParentID>cb959e97-98a4-424e-b200-8c8ae79fe729</ParentID>
      <ParentName>sample string 2</ParentName>
      <Population>9</Population>
      <Status>InActive</Status>
      <StoreName>sample string 5</StoreName>
      <SupplierName>sample string 3</SupplierName>
      <Type>Neighbourhood</Type>
    </City>
    <Contact>sample string 6</Contact>
    <Customer>
      <Address>sample string 4</Address>
      <City>
        <AreaID>73024ff8-8d1b-4269-816c-22f4b9bee59e</AreaID>
        <Code>sample string 6</Code>
        <CustomerName>sample string 4</CustomerName>
        <Mailboxes>10</Mailboxes>
        <Name>sample string 7</Name>
        <OwnerName>sample string 8</OwnerName>
        <ParentID>cb959e97-98a4-424e-b200-8c8ae79fe729</ParentID>
        <ParentName>sample string 2</ParentName>
        <Population>9</Population>
        <Status>InActive</Status>
        <StoreName>sample string 5</StoreName>
        <SupplierName>sample string 3</SupplierName>
        <Type>Neighbourhood</Type>
      </City>
      <Contact>sample string 7</Contact>
      <CustomerID>fb6cf665-2018-4135-a1e1-02c6396be56f</CustomerID>
      <IsBackendCustomer>true</IsBackendCustomer>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 8</PhoneNumber>
      <Postcode>sample string 5</Postcode>
      <Status>InActive</Status>
    </Customer>
    <IsAttentionNeeded>true</IsAttentionNeeded>
    <MarketAreaName>sample string 8</MarketAreaName>
    <Name>sample string 3</Name>
    <ParentName>sample string 2</ParentName>
    <PhoneNumber>sample string 7</PhoneNumber>
    <Postcode>sample string 5</Postcode>
    <Status>InActive</Status>
    <StoreID>089e8a3d-428f-4a42-be1c-13f59a72bc4f</StoreID>
  </Store>
  <StoreBudgetAmount>1.1</StoreBudgetAmount>
  <StoreBudgetSpentAmount>1.1</StoreBudgetSpentAmount>
  <StoreBudgetSpentPercent>1.1</StoreBudgetSpentPercent>
  <TotalAmount>5.1</TotalAmount>
</OrderDetails>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderID"

570cfdb1-4e5d-46a4-ac36-1b69c92942c5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Number"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.StoreID"

089e8a3d-428f-4a42-be1c-13f59a72bc4f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.CustomerID"

fb6cf665-2018-4135-a1e1-02c6396be56f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.AreaID"

73024ff8-8d1b-4269-816c-22f4b9bee59e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.ParentID"

cb959e97-98a4-424e-b200-8c8ae79fe729
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.IsBackendCustomer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Contact"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.PhoneNumber"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.AreaID"

73024ff8-8d1b-4269-816c-22f4b9bee59e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.ParentID"

cb959e97-98a4-424e-b200-8c8ae79fe729
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Contact"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.PhoneNumber"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.MarketAreaName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.IsAttentionNeeded"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.CampaignID"

24c7bf07-bf45-47c8-800f-948b88862656
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.CustomerID"

fb6cf665-2018-4135-a1e1-02c6396be56f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.AreaID"

73024ff8-8d1b-4269-816c-22f4b9bee59e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.ParentID"

cb959e97-98a4-424e-b200-8c8ae79fe729
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.IsBackendCustomer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Contact"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.PhoneNumber"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Type"

NoInformation
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.StartDate"

2026-01-15T14:44:04.1445867+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.EndDate"

2026-01-15T14:44:04.1445867+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.IsRunning"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.IsOrderingAllowed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.NumberOfOrders"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.TotalBudgetAmount"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.TotalSpentAmount"

8.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

Pending
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Date"

2026-01-15T14:44:04.1445867+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsApprovalRequired"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StoreBudgetAmount"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StoreBudgetSpentAmount"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StoreBudgetSpentPercent"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TotalAmount"

5.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Remarks"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2026-01-15T14:44:04.1445867+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2026-01-15T14:44:04.1445867+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e--