Skip to main content
The Orders API gives you programmatic access to every order in your Eaglecart store. Use it to sync orders with fulfillment services, build custom order management dashboards, trigger downstream workflows on status changes, or process refunds without touching the admin UI.
Order status values are: pending, confirmed, fulfilled, cancelled, and refunded. The fulfillment_status and payment_status fields track fulfillment and payment pipelines independently from the top-level order status.

The Order Object

string
Unique identifier for the order (e.g. ord_01HXYZ123).
string
The overall order status. One of pending, confirmed, fulfilled, cancelled, or refunded.
number
The total order amount in the store’s currency, as a decimal (e.g. 149.99).
string
ISO 4217 currency code (e.g. USD, EUR, GBP).
string
ISO 8601 timestamp of when the order was placed.
string
The fulfillment pipeline status. One of unfulfilled, partial, fulfilled.
string
The payment pipeline status. One of pending, paid, partially_refunded, refunded, voided.
object
The customer who placed the order.
array
The products included in the order.

List Orders

Retrieve a paginated list of all orders in your store. Filter by status or date range to narrow results. GET /orders
string
Filter orders by status. One of pending, confirmed, fulfilled, cancelled, refunded.
string
Return only orders created at or after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z).
string
Return only orders created at or before this ISO 8601 timestamp.
integer
Number of orders to return per page. Defaults to 20. Maximum is 100.
integer
Page number to retrieve. Defaults to 1.
Response

Get an Order

Retrieve a single order by its ID. GET /orders/:id
string
required
The unique ID of the order to retrieve.
Response

Create an Order

Create a new order programmatically. Use this endpoint to import orders from external sales channels or build custom checkout flows. POST /orders
string
required
The ID of the existing customer placing the order.
array
required
An array of items to include in the order. Each item must have a variant_id and quantity.
string
ISO 4217 currency code. Defaults to your store’s base currency.
string
An optional private note to attach to the order. Visible only in your store admin.
Response

Update Order Status

Update the status of an existing order. Use this endpoint to move orders through your fulfillment pipeline. PATCH /orders/:id
string
required
The unique ID of the order to update.
string
required
The new order status. One of confirmed, fulfilled, cancelled.
string
An optional note to record alongside the status change.
Response

Refund an Order

Issue a full or partial refund for an order. Refunds are processed against the original payment method. POST /orders/:id/refund
string
required
The unique ID of the order to refund.
number
required
The amount to refund in the order’s currency. Must not exceed the remaining refundable amount.
string
The reason for the refund. Recorded in the order timeline and audit log.
boolean
Set to true to return refunded line item quantities back to inventory. Defaults to false.
Response

Error Handling

The Orders API uses standard HTTP status codes. All error responses include a JSON body with a code field and a human-readable message.