API Reference
Support

List orders

get
https://{targetURL}/api/v1/supplies/orders

Returns the orders (shopping items) recorded against the caller's currently active group, with optional filters by status, catalog item, or linked sample. Use this to drive an orders dashboard or to find pending orders to progress via PUT /orders/{orderID}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Expand an ID field to an object

string

Sort by a specific field

string

Set the current page (0 based)

string

Set the number of records to return (1000 maximum)

string

Specify a viewID to customize the result

string

Specify viewColumns to extend the result

string

Filter by one or more statuses (comma-separated). Valid values: PENDING, ORDERED, RECEIVED, COMPLETED

string

Filter by catalog item ID

string

Filter by sample ID

Headers
string
Defaults to Swagger
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

The given value for the filter is invalid.

404

No orders could be found.

Updated 23 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated 23 days ago