CircuitHub Platform Docs

An order represents a manufacturing request in CircuitHub — placing PCBs for fabrication and assembly based on your project revisions. Each order belongs to a project and tracks production through to completion.

List orders

GET /v1/orders

circuithub order list --workspace acme-electronics

Output:

ID      Status        Date          Qty   Payment   Project
8001    in_progress   2025-03-01    10    paid      Power Supply Board
8002    completed     2025-02-28    25    paid      Sensor Module

curl -H "Authorization: Bearer $CIRCUITHUB_API_KEY" \
  "https://api.circuithub.com/v1/orders?workspace=acme-electronics"

Response:

{
  "orders": [
    {
      "id": 8001,
      "urn": "urn:circuithub:order:8001",
      "name": "ORD-8001",
      "status": "in_progress",
      "quantity": 10,
      "createdAt": "2025-03-01T14:00:00Z",
      "updatedAt": "2025-03-02T11:00:00Z",
      "quotedShippingDate": "2025-03-15T00:00:00Z",
      "estimatedShippingDate": "2025-03-14T00:00:00Z",
      "shippedDate": null,
      "trackingNumber": null,
      "shippingService": null,
      "value": 790.50,
      "paymentStatus": "paid",
      "poNumber": "PO-2025-042",
      "projectId": 12345,
      "projectName": "Power Supply Board",
      "revisionId": 99001,
      "revisionNumber": 3
    }
  ]
}

Query parameters

Parameter	Type	Description
`workspace`	string	Required. Workspace slug

Response fields

Field	Type	Description
`id`	integer	Order ID
`urn`	string	Order URN
`name`	string	Order name/number
`status`	string	Order status (e.g. `in_progress`, `completed`)
`quantity`	integer	Number of boards ordered
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 last update timestamp
`quotedShippingDate`	string	Quoted shipping date, ISO 8601
`estimatedShippingDate`	string \| null	Estimated shipping date, ISO 8601
`shippedDate`	string \| null	Actual ship date, ISO 8601
`trackingNumber`	string \| null	Shipment tracking number
`shippingService`	string \| null	Shipping carrier/service
`value`	number	Order value in USD
`paymentStatus`	string	Payment status
`poNumber`	string	Purchase order number
`projectId`	integer	Project this order belongs to
`projectName`	string	Project name
`revisionId`	integer	Project revision used for this order
`revisionNumber`	integer	Human-readable revision number

Get an order

GET /v1/orders/:orderId

circuithub order show 8001