Search Orders

Search and export orders from Propeller to your ERP or fulfillment system. By the end of this page you will know how to retrieve orders by status and other filters.

Prerequisites

• REST API credentials (client_id and client_secret)
• An access token (Authenticate)

Search for new orders

Use POST /orders/search to find orders matching your criteria. A typical ERP export flow searches for confirmed orders that have not yet been exported.

curl -X POST "https://api.helice.cloud/v2/orders/search?expands=ORDER_ITEMS" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "statuses": ["CONFIRMED"],
    "page": 1,
    "offset": 25
  }'

The expands query parameter controls which related data is included in the response. Available options: ORDER_ITEMS, ADDRESSES, SOURCES, SHIPMENTS, SHIPMENT_ITEMS, TRACK_AND_TRACES. Multiple values can be comma separated.

Available filters

All filters are optional. If no filters are provided the endpoint returns all accessible orders with default pagination.

Filter	Type	Description
statuses	string	Order status values, e.g. ["CONFIRMED"]
exportStatuses	string	Export state: "exported", "finished", "failed" or empty string
types	string	dropshipment, purchase, quotation, stock
userIds	integer	Filter by user IDs who placed the orders
companyIds	integer	Filter by company IDs
term	string	Free text search across order fields
termFields	string	Fields to search, e.g. ["recipientCompany", "email"]
createdAt	object	Date range: {"from": "...", "to": "..."}
lastModifiedAt	object	Date range: {"from": "...", "to": "..."}
page	integer	Page number (starts at 1)
offset	integer	Items per page (defaults to 12)
sortInputs	object	Sort by field and direction

Read the response

The response contains an items array with matching orders and pagination metadata.

{
  "items": [
    {
      "id": 162,
      "status": "CONFIRMED",
      "date": "2025-02-24T14:14:55",
      "itemCount": 1,
      "total": {
        "totalGross": 20,
        "totalNet": 24.2,
        "tax": {"21": 3.15}
      },
      "clientData": {
        "email": "sander@example.com",
        "firstName": "Sander",
        "lastName": "Vleugelhof"
      }
    }
  ],
  "itemsFound": 5,
  "page": 1,
  "pages": 1,
  "offset": 25,
  "start": 1,
  "end": 5
}

Each order includes clientData, invoiceData, shippingData, paymentData and postageData. When you include ORDER_ITEMS in the expands parameter each order also contains its line items.

Process and mark as exported

After processing an order in your ERP you should update its export status in Propeller. This prevents the order from appearing in your next search. Use the Update Order endpoint to set the export status on the order.

See the Search Orders endpoint for the full request and response schemas.

What's next

Continue to What's next for links to advanced integration guides.