# Retrieve Orders

Retrieve a list of orders with optional filtering

Endpoint: GET /orders
Version: 1.0.1
Security: oauth2ClientCredentials

## Query parameters:

  - `limit` (integer)
    Maximum number of results per page

  - `cursor` (string)
    Pagination cursor for retrieving next/previous page

  - `direction` (string)
    Direction for pagination (next or previous)
    Enum: "next", "previous"

  - `status` (string)
    Filter orders by status
    Enum: "CREATED", "CANCELLED", "PROCESSING", "FULFILLED", "AWAITING_SHIPMENT", "SHIPPED"

## Response 200 fields (application/json):

  - `orders` (array)

  - `orders.id` (string)
    Unique order identifier
    Example: "2vSGym0bH8qVEwCIGlyFoRgJq1A"

  - `orders.discount` (string)
    Discount percentage applied to the order
    Example: "10%"

  - `orders.daysSupply` (integer)
    Number of days the order is intended to supply
    Example: 30

  - `orders.orderType` (string)
    Order type (one-time or subscription)
    Enum: "ONE-TIME", "SUBSCRIPTION"

  - `orders.shippingMethod` (string)
    Selected shipping method
    Enum: "STANDARD", "EXPRESS", "OVERNIGHT"

  - `orders.status` (string)
    Current status of the order
    Enum: "CREATED", "CANCELLED", "PROCESSING", "FULFILLED", "AWAITING_SHIPMENT", "SHIPPED"

  - `orders.fulfillmentInfo` (object)
    Details about the order fulfillment process

  - `orders.fulfillmentInfo.carrier` (string)
    Shipping carrier name
    Example: "UPS"

  - `orders.fulfillmentInfo.trackingNumber` (string)
    Shipping carrier tracking number
    Example: "1Z9999999999999999"

  - `orders.lineItems` (array)
    Products included in the order

  - `orders.lineItems.productId` (integer, required)
    Unique identifier of the product
    Example: 77123129891

  - `orders.lineItems.quantity` (integer, required)
    Quantity of the product
    Example: 2

  - `orders.lineItems.packDescription` (string, required)
    Description of the product packaging
    Example: "Whole Body Wellness"

  - `orders.lineItems.price` (string)
    per pill price of product
    Example: "0.37"

  - `orders.lineItems.discountedPrice` (string)
    per pill price of product with partner discount
    Example: "0.37"

  - `orders.lineItems.administration` (object)
    Dosage schedule information

  - `orders.lineItems.administration.morning` (integer, required)
    Morning dosage quantity
    Example: 1

  - `orders.lineItems.administration.afternoon` (integer, required)
    Afternoon dosage quantity

  - `orders.lineItems.administration.evening` (integer, required)
    Evening dosage quantity
    Example: 1

  - `orders.lineItems.administration.sleep` (integer, required)
    Bedtime dosage quantity

  - `orders.customer` (object)
    Customer information

  - `orders.customer.sourceId` (string, required)
    Unique customer identifier in the partner system
    Example: "1234567890"

  - `orders.customer.firstName` (string, required)
    Customer's first name
    Example: "John"

  - `orders.customer.lastName` (string, required)
    Customer's last name
    Example: "Doe"

  - `orders.customer.email` (string)
    Customer's email address
    Example: "john.doe@example.com"

  - `orders.customer.phone` (string)
    Customer's phone number
    Example: "1234567890"

  - `orders.customer.address` (object, required)
    Physical address information

  - `orders.customer.address.line1` (string, required)
    Primary address line
    Example: "437 Lytton"

  - `orders.customer.address.line2` (string)
    Secondary address line (optional)
    Example: "Suite 100"

  - `orders.customer.address.city` (string, required)
    City name
    Example: "Palo Alto"

  - `orders.customer.address.state` (string, required)
    State or province code
    Example: "CA"

  - `orders.customer.address.zip` (string, required)
    Postal/ZIP code
    Example: "94301"

  - `orders.subtotalPrice` (string)
    Order subtotal amount
    Example: "30.00"

  - `orders.totalDiscount` (string)
    Order subtotal amount
    Example: "27.00"

  - `orders.totalFees` (string)
    Total for handling fees on external products. Each external item has a $5 handling fee.
    Example: "5.00"

  - `orders.totalShipping` (string)
    Shipping cost
    Example: "9.99"

  - `orders.totalVolumeDiscount` (string)
    Additional discount as for purchasing a days supply over the specified volume discount limits.
    Example: "12.10"

  - `orders.totalPrice` (string)
    Total order amount (subtotal + shipping)
    Example: "36.99"

  - `orders.createdAt` (string)
    Order creation timestamp
    Example: "2023-10-01T12:00:00Z"

  - `orders.updatedAt` (string)
    Order last update timestamp
    Example: "2023-10-01T12:00:00Z"

  - `cursor` (string)
    Pagination cursor for retrieving next/previous page
    Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

## Response 400 fields (application/json):

  - `detail` (string, required)
    Detailed error message explaining the bad request
    Example: "Invalid request parameters"