API Reference

A project in Omnium is used to handle all activities that are completed over a period of time. There are multiple use cases for projects, such as return and claim workflows, long-running sales, or selling services. Projects connect collections of carts, orders, and returns with all other data needed for project management.

Key project features

Workflows
Partners
Project parts
Change orders
Transactions

Project Model

See the full project model definition:
Omnium Project Model

Searching Projects

Use the SearchProjects endpoint to find projects:

Search Projects API

Example Request

{
  "take": 10,
  "page": 1,
  "query": "Oppussing bad"
}

This request retrieves the first 10 projects that match the search query.

Sorting Results

By default, projects are returned in the order of their document ID. To sort the results, add the sortOrder property to the request:

{
  "take": 10,
  "page": 1,
  "query": "Oppussing bad",
  "sortOrder": "CreatedDescending"
}

This example sorts projects by creation date in descending order.

Available Sort Orders

CreatedAscending
CreatedDescending
ModifiedAscending
ModifiedDescending
ProjectTypeNameAscending
ProjectTypeNameDescending
CustomerAscending
CustomerDescending
PartnerAscending
PartnerDescending
ProjectDeadlineAscending
ProjectDeadlineDescending
ProjectValueAscending
ProjectValueDescending
ProjectStoreContactAscending
ProjectStoreContactDescending
ProjectCurrentWorkflowStepAscending
ProjectCurrentWorkflowStepDescending

Project Types

See the full project type model definition:
Omnium Project Type Model