Sales Order Statuses

The SalesOrderStatuses resource allows you to view the sales order statuses available to your account. The response contains the fixed statuses that Unleashed provides, followed by the custom sales order statuses that your account has configured.

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
List all sales order statuses	GET `/SalesOrderStatuses`

An account can configure a maximum of 10 custom sales order statuses.

GET Sales Order Statuses

Fixed Sales Order Statuses

The following statuses are always returned first unless they are filtered out.

Status
Parked
Deleted
Completed
Backordered
Placed

Available Filters for GET Sales Order Statuses

Filter	Description
includeObsolete	Set to `true` to also return obsolete custom statuses. The default is `false`.
modifiedSince	Only return custom statuses created or edited after a specified date, must be UTC format. The fixed statuses have no modification date, so they are not returned when this filter is used.

Available Fields for GET Sales Order Statuses

Property	Type	Length	Notes
Name	String	15	Use the name of a custom status as `CustomOrderStatus` on a Sales Order.
IsCustomStatus	Boolean		`false` for the fixed statuses, `true` for custom statuses configured in your account.
Obsolete	Boolean		Always `false` for the fixed statuses. Obsolete custom statuses are only returned with `includeObsolete=true`.
LastModifiedOn	Nullable DateTime		Only returned for custom statuses.

Examples for Response GET `/SalesOrderStatuses`

show xml example

 
<?xml version="1.0"?>
<SalesOrderStatuses xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
  <SalesOrderStatus>
    <Name>Parked</Name>
    <IsCustomStatus>false</IsCustomStatus>
    <Obsolete>false</Obsolete>
  </SalesOrderStatus>
  <SalesOrderStatus>
    <Name>Deleted</Name>
    <IsCustomStatus>false</IsCustomStatus>
    <Obsolete>false</Obsolete>
  </SalesOrderStatus>
  <SalesOrderStatus>
    <Name>Completed</Name>
    <IsCustomStatus>false</IsCustomStatus>
    <Obsolete>false</Obsolete>
  </SalesOrderStatus>
  <SalesOrderStatus>
    <Name>Backordered</Name>
    <IsCustomStatus>false</IsCustomStatus>
    <Obsolete>false</Obsolete>
  </SalesOrderStatus>
  <SalesOrderStatus>
    <Name>Placed</Name>
    <IsCustomStatus>false</IsCustomStatus>
    <Obsolete>false</Obsolete>
  </SalesOrderStatus>
  <SalesOrderStatus>
    <Name>Awaiting Pick</Name>
    <IsCustomStatus>true</IsCustomStatus>
    <Obsolete>false</Obsolete>
    <LastModifiedOn>2026-03-29T02:36:03.1872657</LastModifiedOn>
  </SalesOrderStatus>
  <SalesOrderStatus>
    <Name>On Hold</Name>
    <IsCustomStatus>true</IsCustomStatus>
    <Obsolete>false</Obsolete>
    <LastModifiedOn>2026-04-02T21:15:44.5630000</LastModifiedOn>
  </SalesOrderStatus>
</SalesOrderStatuses>

show json example

{
    "Items": [
        {
            "Name": "Parked",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Deleted",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Completed",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Backordered",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Placed",
            "IsCustomStatus": false,
            "Obsolete": false,
            "LastModifiedOn": null
        },
        {
            "Name": "Awaiting Pick",
            "IsCustomStatus": true,
            "Obsolete": false,
            "LastModifiedOn": "/Date(1774751763187)/"
        },
        {
            "Name": "On Hold",
            "IsCustomStatus": true,
            "Obsolete": false,
            "LastModifiedOn": "/Date(1775164544563)/"
        }
    ]
}

Sales Order Statuses

The full range of URIs and HTTP Verbs supported are:

GET Sales Order Statuses

Examples for Response GET /SalesOrderStatuses

Examples for Response GET `/SalesOrderStatuses`