The forecast report by shipment date allows you to generate a report of all ordered products and products from scheduled orders, filtered by their shipment date. This report is useful for planning inventory and fulfillment operations.Documentation Index
Fetch the complete documentation index at: https://docs.firmhouse.com/llms.txt
Use this file to discover all available pages before exploring further.
Parameters
The report accepts the following parameters: Shipment dates after - Filter to only include products with shipment dates on or after this date. Defaults to today. Shipment dates before - Filter to only include products with shipment dates on or before this date. Defaults to one month from now.Available fields
The report includes the following fields:- subscription_id - The associated subscription ID
- subscription_email - The customer’s email address
- subscription_status - The status of the subscription
- product_id - The product ID
- title - The product title
- quantity - The quantity to be shipped
- shipment_date - The scheduled shipment date
- shopify_variant_id - The Shopify variant ID (if applicable)
- shopify_product_id - The Shopify product ID (if applicable)
- sku - The product SKU
- effective_price_cents - The effective price in cents
- effective_interval - The delivery interval for the product
- effective_interval_unit_of_measure - The unit of measure for the interval (days, weeks, months)
- total_amount_excluding_tax - The total amount excluding tax
- total_amount_including_tax - The total amount including tax