POST api/orders/status

Sets the status of an order.

Request Information

URI Parameters

None.

Body Parameters

The model to set the status with.

Name	Type	Additional information
OrderId	globally unique identifier	None.
ExternalProductionId	string	String length: inclusive between 0 and 100
Id	integer	None.
Status	string	None.
ChangeDateUtc	date	None.
Description	string	None.
UserId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": "069195b5-71f1-4c8b-85ab-ea4f7b75cc7b",
  "ExternalProductionId": "sample string 2",
  "Id": 3,
  "Status": "sample string 4",
  "ChangeDateUtc": "2026-03-16T13:54:25.6250413+00:00",
  "Description": "sample string 6",
  "UserId": "39ae2beb-c5c8-4867-a056-99cdf2d06b64"
}

application/xml, text/xml

Sample:

<OrderStatusChangeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models">
  <ChangeDateUtc>2026-03-16T13:54:25.6250413+00:00</ChangeDateUtc>
  <Description>sample string 6</Description>
  <Id>3</Id>
  <Status>sample string 4</Status>
  <UserId>39ae2beb-c5c8-4867-a056-99cdf2d06b64</UserId>
  <ExternalProductionId>sample string 2</ExternalProductionId>
  <OrderId>069195b5-71f1-4c8b-85ab-ea4f7b75cc7b</OrderId>
</OrderStatusChangeDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.