# Retrieve a list of orders within a date range

🚦 Rate Limit: 100 requests / minute

Endpoint: GET /orders
Version: 1.2.0
Security: BearerAuth

## Query parameters:

  - `modifiedFromDate` (string)
    Filter orders modified from this date (ISO 8601 format). If specified without modifiedToDate, current date will be used as end date.
    Example: "2025-05-01T00:00:00Z"

  - `modifiedToDate` (string)
    Filter orders modified up to this date (ISO 8601 format). Cannot be specified without modifiedFromDate.
    Example: "2025-05-31T23:59:59Z"

  - `offset` (integer)
    Number of records to skip for pagination (default: 0)

  - `pageSize` (integer)
    Number of records to return per page (default: 1000, max: 1000)
    Example: 50

## Response 200 fields (application/json):

  - `data` (array)

  - `data.order_number` (integer)
    Example: 87452

  - `data.created_at` (string)
    Example: "2025-05-12T18:32:44Z"

  - `data.updated_at` (string)
    Example: "2025-05-12T18:32:44Z"

  - `data.order_date` (string)
    Example: "2025-05-12T18:32:44Z"

  - `data.first_name` (string)
    Example: "Dale"

  - `data.last_name` (string)
    Example: "Cooper"

  - `data.date_of_birth` (string)
    Example: "1960-04-19"

  - `data.phone` (string)
    Example: "+1-202-555-0123"

  - `data.email` (string)
    Example: "dcooper@fbi.gov"

  - `data.subtotal_price` (number)
    Example: 245

  - `data.total_discounts` (number)
    Example: 25

  - `data.shipping_price` (number)
    Example: 18.5

  - `data.sales_tax` (number)
    Example: 19.85

  - `data.crv` (number)
    Example: 1.2

  - `data.total_tax` (number)
    Example: 21.05

  - `data.total_price` (number)
    Example: 259.55

  - `data.tip` (number)
    Example: 10

  - `data.delivery_preference` (string)
    Example: "shipping"

  - `data.order_type` (string)
    Example: "ecommerce"

  - `data.order_subtype` (string)
    Example: "wine_club"

  - `data.payment_status` (string)
    Example: "paid"

  - `data.fulfillment_status` (string)
    Example: "fulfilled"

  - `data.item_count` (integer)
    Example: 4

  - `data.order_items` (array)
    Array of order line items
    Example: [{"product_name":"Black Lodge Chardonnay 2022","variant_name":"750 ml Bottle","sku":"BL-CHA-2022-750","quantity":2,"price":38,"product_type":"Wine"},{"product_name":"Twin Peaks Merlot 2021","variant_name":"750 ml Bottle","sku":"TP-MER-2021-750","quantity":1,"price":42,"product_type":"Wine"}]

  - `data.order_items.product_name` (string)
    Example: "Black Lodge Chardonnay 2022"

  - `data.order_items.variant_name` (string)
    Example: "750 ml Bottle"

  - `data.order_items.sku` (string)
    Example: "BL-CHA-2022-750"

  - `data.order_items.quantity` (integer)
    Example: 2

  - `data.order_items.price` (number)
    Example: 38

  - `data.order_items.product_type` (string)
    Example: "Wine"

  - `data.order_discounts` (object)
    Object containing applied discounts
    Example: {"auto_discount":15,"promocode_discount":10,"pos_discount":null,"custom_discount":null}

  - `data.order_discounts.auto_discount` (number)
    Wine club automatic discount amount
    Example: 15

  - `data.order_discounts.promocode_discount` (number)
    Promotional code discount amount
    Example: 10

  - `data.order_discounts.pos_discount` (number)
    Point of sale discount amount
    Example: 5

  - `data.order_discounts.custom_discount` (number)
    Custom discount amount
    Example: 8.5

  - `data.shipping_first_name` (string)
    Example: "Dale"

  - `data.shipping_last_name` (string)
    Example: "Cooper"

  - `data.shipping_birth_date` (string)
    Example: "1960-04-19"

  - `data.shipping_phone` (string)
    Example: "+1-202-555-0123"

  - `data.shipping_address_line1` (string)
    Example: "123 Twin Peaks Way"

  - `data.shipping_address_line2` (string)
    Example: "Apt 302"

  - `data.shipping_address_city` (string)
    Example: "Twin Peaks"

  - `data.shipping_address_state` (string)
    Example: "Washington"

  - `data.shipping_address_zip_code` (string)
    Example: "98065"

  - `data.billing_first_name` (string)
    Example: "Dale"

  - `data.billing_last_name` (string)
    Example: "Cooper"

  - `data.billing_birth_date` (string)
    Example: "1960-04-19"

  - `data.billing_phone` (string)
    Example: "+1-202-555-0123"

  - `data.billing_address_line1` (string)
    Example: "123 Twin Peaks Way"

  - `data.billing_address_line2` (string)
    Example: "Apt 302"

  - `data.billing_address_city` (string)
    Example: "Twin Peaks"

  - `data.billing_address_state` (string)
    Example: "Washington"

  - `data.billing_address_zip_code` (string)
    Example: "98065"

  - `data.customer_type` (string)
    Example: "club_member"

  - `data.customer_tags` (array)
    Example: ["VIP","Black Lodge"]

  - `data.class` (string)
    Example: "Platinum"

  - `data.notes` (string)
    Example: "Leave with doorman at Great Northern Hotel"

  - `data.payment_type` (string)
    Example: "credit_card"

  - `data.order_edit` (array)
    Array of order edit records if applicable
    Example: [{"order_number":87452,"created_at":"2025-05-12T18:32:44Z","current_operation":{"newItems":"0","deletedItems":"1","updatedItems":"0"},"summary":{},"custom_refund_amount":25,"order_delivery_method":"shipping","order_edit_type":"refund","status":"completed","activity":"Order refunded due to customer request","notes":"Customer requested refund for damaged item"}]

  - `data.order_edit.current_operation` (object)

  - `data.order_edit.current_operation.newItems` (string)
    Number of new items added to the order
    Example: "0"

  - `data.order_edit.current_operation.deletedItems` (string)
    Number of items removed from the order
    Example: "0"

  - `data.order_edit.current_operation.updatedItems` (string)
    Number of items modified in the order
    Example: "0"

  - `data.order_edit.summary` (object)
    Summary of the order edit operation (JSON raw message)

  - `data.order_edit.custom_refund_amount` (number)
    Example: 25

  - `data.order_edit.order_delivery_method` (string)
    Example: "shipping"

  - `data.order_edit.order_edit_type` (string)
    Example: "refund"

  - `data.order_edit.status` (string)
    Example: "completed"

  - `data.order_edit.activity` (string)
    Example: "Order refunded due to customer request"

  - `data.order_edit.notes` (string)
    String containing order edit notes
    Example: "Customer requested refund for damaged item"

  - `data.club_package_info` (object)
    Wine club package details if applicable
    Example: {"wine_club_name":"Black Lodge Reserve","subscription_package_type":"quarterly","package_number":2025001,"package_type":"red_wine","package_status":"active","payment_date":"2025-01-15T00:00:00Z","open_at":"2025-01-01T00:00:00Z","closed_at":"2025-01-31T23:59:59Z","customer_package_status":"selection_completed","opened_date":"2025-01-01T00:00:00Z","closed_date":"2025-01-31T23:59:59Z","package_message":"Your wine selection has been confirmed","is_selection_completed":true,"wine_club_order_status":"fulfilled","compliance_status":"compliant","wine_club_message":"Package shipped successfully"}

  - `data.club_package_info.wine_club_name` (string)
    Example: "Black Lodge Reserve"

  - `data.club_package_info.subscription_package_type` (string)
    Example: "quarterly"

  - `data.club_package_info.package_number` (integer)
    Example: 2025001

  - `data.club_package_info.package_type` (string)
    Example: "red_wine"

  - `data.club_package_info.package_status` (string)
    Example: "active"

  - `data.club_package_info.payment_date` (string)
    Example: "2025-01-15T00:00:00Z"

  - `data.club_package_info.open_at` (string)
    Example: "2025-01-01T00:00:00Z"

  - `data.club_package_info.closed_at` (string)
    Example: "2025-01-31T23:59:59Z"

  - `data.club_package_info.customer_package_status` (string)
    Example: "selection_completed"

  - `data.club_package_info.opened_date` (string)
    Example: "2025-01-01T00:00:00Z"

  - `data.club_package_info.closed_date` (string)
    Example: "2025-01-31T23:59:59Z"

  - `data.club_package_info.package_message` (string)
    Example: "Your wine selection has been confirmed"

  - `data.club_package_info.is_selection_completed` (boolean)
    Example: true

  - `data.club_package_info.wine_club_order_status` (string)
    Example: "fulfilled"

  - `data.club_package_info.compliance_status` (string)
    Example: "compliant"

  - `data.club_package_info.wine_club_message` (string)
    Example: "Package shipped successfully"

  - `data.fulfillment_info` (array)
    Array of fulfillment tracking and shipping details
    Example: [{"fulfillment_id":"ful_123456789","fulfillment_number":"FUL-2025-001","status":"fulfilled","shipment_status":"delivered","service":"FedEx Ground","created_at":"2025-05-12T18:32:44Z","updated_at":"2025-05-13T10:15:30Z","tracking":{"company_name":"FedEx","tracking_number":"123456789012","tracking_numbers":["123456789012","123456789013"],"tracking_url":"https://www.fedex.com/tracking?action=track&tracknumbers=123456789012","tracking_urls":["https://www.fedex.com/tracking?action=track&tracknumbers=123456789012","https://www.fedex.com/tracking?action=track&tracknumbers=123456789013"]},"shipping_price":18.5,"fulfillment_type":"shipping","package_slip":"true","notify_customer":true,"history_created_at":"2025-05-12T18:32:44Z"}]

  - `data.fulfillment_info.fulfillment_id` (string)
    Example: "ful_123456789"

  - `data.fulfillment_info.fulfillment_number` (string)
    Example: "FUL-2025-001"

  - `data.fulfillment_info.shipment_status` (string)
    Example: "delivered"

  - `data.fulfillment_info.service` (string)
    Example: "FedEx Ground"

  - `data.fulfillment_info.tracking` (object)

  - `data.fulfillment_info.tracking.company_name` (string)
    Example: "FedEx"

  - `data.fulfillment_info.tracking.tracking_number` (string)
    Example: "123456789012"

  - `data.fulfillment_info.tracking.tracking_numbers` (array)
    Example: ["123456789012","123456789013"]

  - `data.fulfillment_info.tracking.tracking_url` (string)
    Example: "https://www.fedex.com/tracking?action=track&tracknumbers=123456789012"

  - `data.fulfillment_info.tracking.tracking_urls` (array)
    Example: ["https://www.fedex.com/tracking?action=track&tracknumbers=123456789012","https://www.fedex.com/tracking?action=track&tracknumbers=123456789013"]

  - `data.fulfillment_info.fulfillment_type` (string)
    Example: "shipping"

  - `data.fulfillment_info.notify_customer` (boolean)
    Example: true

  - `data.fulfillment_info.history_created_at` (string)
    Example: "2025-05-12T18:32:44Z"

  - `data.tender_info` (array)
    Array of payment tender records
    Example: [{"payment_type":"credit_card","card_type":"Visa","amount":259.55,"created_at":"2025-05-12T18:32:44Z","status":"paid","last_four":"4242","card_brand":"Visa","card_expiry":{"month":"12","year":"2026"}}]

  - `data.tender_info.card_type` (string)
    Example: "Visa"

  - `data.tender_info.amount` (number)
    Example: 259.55

  - `data.tender_info.last_four` (string)
    Example: "4242"

  - `data.tender_info.card_brand` (string)
    Example: "Visa"

  - `data.tender_info.card_expiry` (object)

  - `data.tender_info.card_expiry.month` (string)
    Example: "12"

  - `data.tender_info.card_expiry.year` (string)
    Example: "2026"

  - `pagination` (object)

  - `pagination.current_offset` (integer)

  - `pagination.page_size` (integer)
    Example: 50

  - `pagination.total_records` (integer)
    Example: 1250

  - `pagination.total_pages` (integer)
    Example: 25

  - `pagination.current_page` (integer)
    Example: 1

  - `pagination.pages_remaining` (integer)
    Example: 24

  - `pagination.has_next_page` (boolean)
    Example: true

  - `pagination.has_previous_page` (boolean)