List Sales Order Statuses

Beta

GET/v1/sales/sales-orders/statuses

This endpoint is idempotent. Learn more

Lists the statuses a sales order can be in.

The statuses are platform-provided and the same for every account, so the result is small and stable enough to cache. Use it to label orders in your own interface; an order moves between statuses through its issue, unissue, close, and reopen actions rather than by being assigned a status.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:owner

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of sales_order_status

Resources in this page.

idstring

Sales order status ID.

objectstringenumValues:sales_order_status

Resource type identifier.

codestringenumValues:estimateissuedfulfilled

Machine-readable status code.

estimate: a draft quote that has not yet been committed.
issued: the order is committed for fulfillment, with a pick raised against it.
fulfilled: the order has been completed and closed.

namestring

Human-readable name of the status.

ownerownerExpandablenullable

Owner of this status value.

Sales order statuses are platform-provided and shared across all accounts, so the owner is always the OpenMRP system owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Sales Order Statuses

List Sales Order Statuses

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listSalesOrderStatus = await client.sales.salesOrders.retrieveStatuses();

console.log(listSalesOrderStatus.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listSalesOrderStatus = await client.sales.salesOrders.retrieveStatuses();

console.log(listSalesOrderStatus.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/sales-orders/statuses?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoib3Jzc181cDUzOXNleDVidmEiLCJkIjoiZiJ9.hrJUTBh8wDMoagcsXqv1Q97MScD4iEkS_EtiNtJ5kc0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "orss_5p539sex5bva",
      "object": "sales_order_status",
      "code": "estimate",
      "name": "Estimate",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/sales-orders/statuses?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoib3Jzc181cDUzOXNleDVidmEiLCJkIjoiZiJ9.hrJUTBh8wDMoagcsXqv1Q97MScD4iEkS_EtiNtJ5kc0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "orss_5p539sex5bva",
      "object": "sales_order_status",
      "code": "estimate",
      "name": "Estimate",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Sales Order Statuses

Query Parameters

Returns

Responses