Orders

Search orders

Search orders with various filters.

get/api/orders/search

Request

  • Base URL: https://api.sc-market.space
  • URL: https://api.sc-market.space/api/orders/search
  • Auth: none required

Query parameters

contractorstring

The Spectrum ID of the contracting org

assignedstring

The assigned user's username

customerstring

The customer's username

sort_method'title' | 'customer_name' | 'status' | 'timestamp' | 'contractor_name'

The method to sort results by

status'fulfilled' | 'in-progress' | 'not-started' | 'cancelled' | 'active' | 'past'

The current status of the order

indexinteger

The page index of the search

page_sizeinteger

The page size for the search

reverse_sortboolean

Whether to reverse the sort

buyer_usernamestring

Filter by buyer (customer) username (for seller view)

seller_usernamestring

Filter by seller username (contractor spectrum_id or assigned user username) (for buyer view)

has_market_listingsboolean

Filter orders that have market listings attached

has_serviceboolean

Filter orders that have a service attached

cost_mininteger

Minimum cost filter

cost_maxinteger

Maximum cost filter

date_fromstring date-time

Filter orders created after this date (ISO 8601 format)

date_tostring date-time

Filter orders created before this date (ISO 8601 format)

Response

OK - Successful request with response body

Changes

No recorded changes to this operation across all 5 revisions of this API.