orders/list

These methods let you find and filter client orders: Enumerate orders and filter by reference, client, status or other properties. Get details of a specific order by ID. Get a description of all properties. The present page does not explain those details, so simply pull this data from the API. Like other “lists” in Wordbee, such as for companies, projects, invoices, people, this method adheres to the generic “list” API specification. It is documented in detail here: Lists

URL

There are many endpoints for various operations, they all commence like this:

/api/orders/list/.....

The most commonly used end points are below. See Lists for all the capabilities and features.

(POST) /api/orders/list                     - view or filter orders with the most important properties
(POST) /api/orders/list/full                - view or filter orders, each with all properties
(POST) /api/orders/list/item/{orderid}      - view a specific order
(GET)  /api/orders/list/fields              - get a list of all properties with name, description and more

PARAMETERS

See the documentation here: : Lists

USE CASES

List all orders, most recent on top

This will pull the most recent 100 orders.

(POST) /api/orders/list

To pull the next 20 orders you would include a body:

(POST) /api/orders/list
BODY:
{
  "skip": 100,
  "take": 20
}

Find all orders by reference and of specific client

A query on both reference and client company ID. See query language specification here: Query language

(POST) /api/orders/list
BODY:
{
  "query": '{reference}.Matches("my order") AND {companyId}.Matches(537)',
}

You can also search by companyName or most properties. Use this API to get a list of all available fields , their data types and query capabilities:

(GET) /api/orders/list/fields

Find all orders where reference starts with

A query on both reference and client company ID. See query language specification here: Query language

(POST) /api/orders/list
BODY:
{
  "query": '{reference}.Matches("urgent-", "prefix")',
}

You can also search by companyName or most properties. Use this API to get a list of all available fields , their data types and query capabilities:

(GET) /api/orders/list/fields

Get specific order by ID

This is the quick way to find an order. Here the order ID is 1000:

(POST) /api/orders/list/items/1000

Or, you use a query:

(POST) /api/orders/list
BODY:
{
  "query": '{id}.Matches(1000)',
}

More features

See Lists for more such as:

• Get total orders by status (aggregations).

• Customize the properties to return in lists.

• Auto-complete API methods e.g. for the order reference.

RELATED DOCUMENTATION

Order status

The status property indicates the numeric order status. See Order status for all possible values.

The statust property is the print title of the status.

Invoices

To get all client invoices added to the order, use the invoices list API: invoices/list

To get all supplier invoices linked into the order’s project: First get the projectId property for the order. Then use the invoices list API above to filter for supplier invoices linked to the project ID.

ACCESS RIGHTS

This API is subject to the exact same restrictions as the orders pages in the online platform:

• The API users must be granted access to orders. The user can be a client with access to the client portal or an internal user.

• A user can only see the orders to which the user also has access online. For example, a client will not see orders from other clients.

• A user can only see properties that are granted access. For example, a client will not see project information (such as the project reference or status). Custom fields may also be visible to some not all users.