CH

CodeHub

API Playground

← All collections

Collection Docs

Orders Collection

Order management with status enum (pending/shipped/delivered) and date filtering.

Fields

text

orderNumber

Required + unique; order identifier.

text

customerName

Required; customer name.

number

totalAmount

Required; must be 0 or greater.

select

status

Required enum: pending, shipped, delivered. Defaults to pending.

date

createdAt

Order creation timestamp (auto-set).

REST Endpoints

GET/api/orders

List orders. Filter by status or date range.

GET/api/orders/:id

Fetch one order by document ID.

POST/api/orders

Create an order. Include orderNumber, customerName, totalAmount, status.

PATCH/api/orders/:id

Update order fields (e.g., change status from pending to shipped).

DELETE/api/orders/:id

Delete an order document.

Teaching Tips

  • Filter by status: ?where[status][equals]=shipped
  • Filter by date: ?where[createdAt][greater_than]=2024-01-01
  • Sort by date: ?sort=-createdAt (newest first)
  • Combine: ?where[status][equals]=pending&sort=-createdAt