Get Order List

Returns a list of orders, filtered by the query parameters below.

Which orders are listed

  • With no organization_id or user_id, you see the orders you have access to: your
    organization's orders if you have permission to view them, otherwise the orders you created.
  • By default only placed orders are listed: status defaults to paid, reviewed,
    processing, and shipped, so quotes and cancelled orders are left out. Pass status to
    include them.
  • type defaults to pcb (assembly orders).
  • Passing quote_valid lists only quotes and ignores status.

Filters are combined with AND. Parameters that take several values (status, type,
dpas_rating) accept either a comma-separated list (status=quote,paid) or the parameter
repeated (status=quote&status=paid).

Results are not paginated and are returned in no particular order; narrow large result sets
with the filters, such as start_date and end_date.

Each order is a summary. Use the include_* parameters to add more detail, or get the full
order with GET /api/v2/order/{order_id}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
status
array of strings, unique
Defaults to paid,reviewed,processing,shipped

Only list orders with one of these statuses

type
array of strings, unique
Defaults to pcb

pcb for assembly orders, fulfillment for fulfillment orders

string

Only list this organization's orders. Requires permission to view the organization's
orders.

string

Only list orders created by this user

string

Only list orders for this PCB

integer
≥ 1

Only list orders for this PCB version. Requires pcb_id.

string

Only list orders for this snapshot of a PCB design

string

Only list orders for this assembled-board internal part number

date-time

Only list orders created at or after this time (ISO 8601; UTC unless an offset is
given)

date-time

Only list orders created at or before this time (ISO 8601; UTC unless an offset is
given)

boolean

List only quotes: true for quotes that have not expired, false for expired quotes.
When given, status is ignored.

boolean

Only list orders that are (true) or are not (false) marked manufacturable

boolean

Only list orders whose part orientations have (true) or have not (false) been approved
in MacroFab's order review

dpas_rating
array of strings

Only list orders with one of these Defense Priorities and Allocations System ratings.
Unrated includes orders with no rating.

dpas_rating
Allowed:
boolean
Defaults to false

Include each order's shipments

boolean
Defaults to false

Include each order's shipping_selection

boolean
Defaults to false

Include each order's additional_services

Responses

422

A query parameter is invalid (for example, pcb_version without pcb_id)

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