Skip to main content

Get orders for the store

GET 
/api/v1/orders

This endpoint retrieves a paginated list of orders for your store with flexible filtering options.

Authentication: Requires Private API Key (sk_*)

Query Parameters:

  • limit - Number of orders to return (1-50, default: 50)
    • status - Filter by order status (optional)
    • dateFrom - Start date filter (optional, ISO 8601)
    • dateTo - End date filter (optional, ISO 8601)

Response Data:

  • Order summaries with key information
    • Customer details (name, contact)
    • Payment and fulfillment status
    • Total amount and currency
    • Timestamps (created, updated)

Use Cases:

  • Building order management dashboards
    • Order fulfillment workflows
    • Reporting and analytics
    • Order synchronization with external systems

Important Notes:

  • Results are ordered by creation date (newest first)
    • For pagination, use multiple calls with appropriate date filters
    • Maximum 50 orders per request to ensure performance

Error Scenarios:

  • 400 BAD REQUEST - Invalid parameters (limit out of range, invalid date format, etc.) (Error code: INVALID_REQUEST)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Orders retrieved successfully with filtering applied