POST api/OrderStatuses

Creates a new order status or updates an existent order status's information.

Request Information

URI Parameters

None.

Body Parameters

Model used to retrieve or set information about a order status.

OrderStatusModel
NameDescriptionTypeAdditional information
Name

Order status' name (Required).

 string

None.
Active

Indicates whether the order status is active or not.

 boolean

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "active": true,
  "id": "431e0e89-6b82-45af-b488-f0dcf884cf1d",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<OrderStatusModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.OrderStatuses">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">431e0e89-6b82-45af-b488-f0dcf884cf1d</Id>
  <Active>true</Active>
  <Name>sample string 1</Name>
</OrderStatusModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderStatusModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.