Skip to main content
The orders report allows you to generate a report of all orders in your project. You can filter orders by their creation date.

Parameters

The report accepts the following parameters: Orders created after - Filter to only include orders created on or after this date. Defaults to one month ago.

Available fields

The report includes the following fields:
  • id - The unique order identifier
  • subscription_id - The associated subscription ID
  • payment_id - The associated payment ID
  • status - The order status (pending, confirmed, snoozed, cancelled, fulfilled, draft)
  • track_and_trace_codes - Tracking codes for the shipment
  • shipment_date - The scheduled or actual shipment date
  • order_announcement_sent_at - When the order announcement email was sent
  • order_confirmation_sent_at - When the order confirmation email was sent
  • created_at - When the order was created
  • subtotal_incl_tax - Subtotal including tax
  • subtotal_excl_tax - Subtotal excluding tax
  • total_tax - Total tax amount
  • shipping_costs - Shipping costs including tax
  • shipping_costs_excl_tax - Shipping costs excluding tax
  • amount - Total order amount
  • currency - Order currency
  • formatted_number - The formatted order number
  • order_lines_json - Order line items in JSON format
  • order_lines_quantity - Quantities of order line items
  • order_lines_product - Product names in the order
  • order_lines_sku - SKUs of products in the order
  • full_address - Complete delivery address
  • full_name - Customer’s full name
  • address - Street address
  • house_number - House number
  • zipcode - Postal code
  • city - City
  • state - State or province
  • country - Country
  • email - Customer email
  • phone_number - Customer phone number

FAQ

What orders are included?

Only orders from subscriptions that have completed signup are included. Draft orders and orders from incomplete signups are excluded.

Can I include custom extra fields?

Yes, if you have configured extra fields for orders in your project, these will also be available in the report.

How are orders sorted?

Orders are sorted by creation date in descending order, with the most recent orders appearing first.