POST v1/OrderStatuses

Add a new OrderStatus.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The OrderStatus changes object

Name	Description	Type	Additional information
ShopOwnerId	Gets or sets the shop owner identifier.	integer	None.
ShopId	Gets or sets the shop identifier.	integer	None.
IsDefaultStatusForId	Gets or sets a value indicating whether this instance has default status.	integer	None.
HasActionDate	Gets or sets a value indicating whether this instance has action date.	boolean	Required
ActionDateCaption	Gets or sets the action date caption.	string	Max length: 50
ActionDateMessage	Gets or sets the action date message.	string	Max length: 200
Sequence	Gets or sets the sequence.	integer	Required
Id	Gets or sets the identifier.	integer	Must be 0
BaseOrderStatusId	Gets or sets the base order status identifier.	integer	None.
OrderStatusTypeId	Gets or sets the order status type identifier.	integer	None.
Name	Gets or sets the name.	string	Required Max length: 50
Enabled	Gets or sets the enabled.	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "ShopOwnerId": 1,
  "ShopId": 1,
  "IsDefaultStatusForId": 1,
  "HasActionDate": true,
  "ActionDateCaption": "sample string 2",
  "ActionDateMessage": "sample string 3",
  "Sequence": 4,
  "Id": 5,
  "BaseOrderStatusId": 6,
  "OrderStatusTypeId": 7,
  "Name": "sample string 8",
  "Enabled": true
}

application/xml, text/xml

Sample:

<OrderStatusChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>5</Id>
  <BaseOrderStatusId>6</BaseOrderStatusId>
  <OrderStatusTypeId>7</OrderStatusTypeId>
  <Name>sample string 8</Name>
  <Enabled>true</Enabled>
  <ShopOwnerId>1</ShopOwnerId>
  <ShopId>1</ShopId>
  <IsDefaultStatusForId>1</IsDefaultStatusForId>
  <HasActionDate>true</HasActionDate>
  <ActionDateCaption>sample string 2</ActionDateCaption>
  <ActionDateMessage>sample string 3</ActionDateMessage>
  <Sequence>4</Sequence>
</OrderStatusChanges>

Response Information

Resource Description

The OrderStatus object.

OrderStatusDefinition

Name	Description	Type	Additional information
ShopOwnerId	Gets or sets the shop owner identifier.	integer	None.
ShopId	Gets or sets the shop identifier.	integer	None.
IsDefaultStatusForId	Gets or sets a value indicating whether this instance has default status.	integer	None.
HasActionDate	Gets or sets a value indicating whether this instance has action date.	boolean	Required
ActionDateCaption	Gets or sets the action date caption.	string	Max length: 50
ActionDateMessage	Gets or sets the action date message.	string	Max length: 200
Sequence	Gets or sets the sequence.	integer	Required
Id	Gets or sets the identifier.	integer	Must be 0
BaseOrderStatusId	Gets or sets the base order status identifier.	integer	None.
OrderStatusTypeId	Gets or sets the order status type identifier.	integer	None.
Name	Gets or sets the name.	string	Required Max length: 50
Enabled	Gets or sets the enabled.	boolean	Required

Response Formats

application/json, text/json

Sample:

{
  "ShopOwnerId": 1,
  "ShopId": 1,
  "IsDefaultStatusForId": 1,
  "HasActionDate": true,
  "ActionDateCaption": "sample string 2",
  "ActionDateMessage": "sample string 3",
  "Sequence": 4,
  "Id": 5,
  "BaseOrderStatusId": 6,
  "OrderStatusTypeId": 7,
  "Name": "sample string 8",
  "Enabled": true
}

application/xml, text/xml

Sample:

<OrderStatusDefinition xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>5</Id>
  <BaseOrderStatusId>6</BaseOrderStatusId>
  <OrderStatusTypeId>7</OrderStatusTypeId>
  <Name>sample string 8</Name>
  <Enabled>true</Enabled>
  <ShopOwnerId>1</ShopOwnerId>
  <ShopId>1</ShopId>
  <IsDefaultStatusForId>1</IsDefaultStatusForId>
  <HasActionDate>true</HasActionDate>
  <ActionDateCaption>sample string 2</ActionDateCaption>
  <ActionDateMessage>sample string 3</ActionDateMessage>
  <Sequence>4</Sequence>
</OrderStatusDefinition>