# List Order

List orders with filtering and pagination

 GET /api/v3/orders

 Use cases:
   - Monitor order status changes
   - Sync orders to your system
   - Generate reports on order volumes

Endpoint: GET /api/v3/orders
Version: v3.0.0

## Query parameters:

  - `filter.created_at_min` (string)
    ISO 8601 date-time format (e.g., 2024-01-01T00:00:00Z)

  - `filter.created_methods` (array)
    Filter by order creation methods
    Enum: "VENDOR_CREATED_METHOD_SYNC", 2, "VENDOR_CREATED_METHOD_MANUAL", 3, "VENDOR_CREATED_METHOD_API", 4, "VENDOR_CREATED_METHOD_IMPORT", 5, "VENDOR_CREATED_METHOD_LABEL", 6

  - `filter.order_ids` (array)
    Filter by specific order IDs

  - `filter.payment_status` (array)
    Filter by payment status (for legacy API compatibility)
    Enum: "VENDOR_ORDER_PAYMENT_STATUS_PENDING", 2, "VENDOR_ORDER_PAYMENT_STATUS_SUCCESS", 3, "VENDOR_ORDER_PAYMENT_STATUS_FAILED", 4, "VENDOR_ORDER_PAYMENT_STATUS_EXPIRED", 5, "VENDOR_ORDER_PAYMENT_STATUS_SUCCESS_PARTIALLY", 6

  - `filter.statuses` (array)
    Filter by order statuses
    Enum: "VENDOR_ORDER_STATUS_AWAITING_PAYMENT", 2, "VENDOR_ORDER_STATUS_PAYMENT_FAILED", 3, "VENDOR_ORDER_STATUS_AWAITING_FULFILLMENT", 4, "VENDOR_ORDER_STATUS_IN_PRODUCTION", 5, "VENDOR_ORDER_STATUS_PACKED", 6, "VENDOR_ORDER_STATUS_SHIPPED", 7, "VENDOR_ORDER_STATUS_CANCELLED", 8, "VENDOR_ORDER_STATUS_ON_HOLD", 9

  - `paging.limit` (integer)

  - `paging.page` (integer)

## Response 200 fields (application/json):

  - `status` (string)
    Response status: "success" or "error"

  - `message` (string)
    Human-readable message describing the result

  - `paging` (object)
    Pagination metadata including total count and pages

  - `paging.total` (integer,string)

  - `paging.total_page` (integer)

  - `paging.page` (integer)

  - `paging.limit` (integer)

  - `data` (array)
    List of orders matching the filter criteria
 Each order includes: ID, status, line items, tracking info, pricing

  - `data.order_id` (string)
    Unique order ID

  - `data.store_id` (string)
    Store ID this order belongs to

  - `data.store_name` (string)
    Store name for display

  - `data.team_id` (string)
    Team ID (your account ID)

  - `data.created_method` (string,number)
    How this order was created (manual, API, store sync, etc.)
    Enum: "VENDOR_CREATED_METHOD_SYNC", 2, "VENDOR_CREATED_METHOD_MANUAL", 3, "VENDOR_CREATED_METHOD_API", 4, "VENDOR_CREATED_METHOD_IMPORT", 5, "VENDOR_CREATED_METHOD_LABEL", 6

  - `data.order_platform` (string,number)
    Marketplace platform (Shopify, Etsy, WooCommerce, etc.)
    Enum: "MARKETPLACE_PLATFORM_EBAY", 2, "MARKETPLACE_PLATFORM_AMAZON", 3, "MARKETPLACE_PLATFORM_SHOPIFY", 4, "MARKETPLACE_PLATFORM_WOOCOMMERCE", 5, "MARKETPLACE_PLATFORM_ETSY", 6, "MARKETPLACE_PLATFORM_SHOPBASE", 7, "MARKETPLACE_PLATFORM_GEARMENT", 8, "MARKETPLACE_PLATFORM_ORDERDESK", 9, "MARKETPLACE_PLATFORM_TIKTOKSHOP", 10, "MARKETPLACE_PLATFORM_POSHMARK", 11, "MARKETPLACE_PLATFORM_PRESTASHOP", 12, "MARKETPLACE_PLATFORM_INKGO", 13, "MARKETPLACE_PLATFORM_WISH", 14, "MARKETPLACE_PLATFORM_BIGCOMMERCE", 15, "MARKETPLACE_PLATFORM_CUSTOMILY", 16

  - `data.platform_ref` (string)
    Platform reference ID (deprecated, will be removed) will be deleted soon

  - `data.shipping_labels` (array)
    Shipping label URLs (if pre-purchased)

  - `data.order_date` (string)
    When the order was originally placed

  - `data.approved_at` (string)
    When the order was approved for fulfillment

  - `data.paid_at` (string)
    When the payment was confirmed

  - `data.order_status` (string,number)
    Current order status
    Enum: "VENDOR_ORDER_STATUS_AWAITING_PAYMENT", 2, "VENDOR_ORDER_STATUS_PAYMENT_FAILED", 3, "VENDOR_ORDER_STATUS_AWAITING_FULFILLMENT", 4, "VENDOR_ORDER_STATUS_IN_PRODUCTION", 5, "VENDOR_ORDER_STATUS_PACKED", 6, "VENDOR_ORDER_STATUS_SHIPPED", 7, "VENDOR_ORDER_STATUS_CANCELLED", 8, "VENDOR_ORDER_STATUS_ON_HOLD", 9

  - `data.order_subtotal` (object)
    Subtotal (sum of all line items before fees/tax/discount)

  - `data.order_subtotal.currency_code` (string)
    The three-letter currency code defined in ISO 4217.

  - `data.order_subtotal.units` (integer,string)
    The whole units of the amount.
 For example if currencyCode is "USD", then 1 unit is one US dollar.

  - `data.order_subtotal.nanos` (integer)
    Number of nano (10^-9) units of the amount.
 The value must be between -999,999,999 and +999,999,999 inclusive.
 If units is positive, nanos must be positive or zero.
 If units is zero, nanos can be positive, zero, or negative.
 If units is negative, nanos must be negative or zero.
 For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

  - `data.order_shipping_fee` (object)
    Shipping cost

  - `data.order_gift_message_fee` (object)
    Gift message fee (if applicable)

  - `data.order_tax` (object)
    Total tax amount

  - `data.order_total` (object)
    Final total amount (subtotal + fees + tax - discount)

  - `data.fulfillment_option` (object)
    Fulfillment configuration options

  - `data.fulfillment_option.purchase_tracking_config` (string,number)
    Tracking purchase timing configuration
    Enum: "VENDOR_PURCHASE_TRACKING_TIME_DEFAULT", 1, "VENDOR_PURCHASE_TRACKING_TIME_IMMEDIATELY_AFTER_THE_PAYMENT_TIME", 2, "VENDOR_PURCHASE_TRACKING_TIME_ONCE_ALL_ITEMS_ARE_PRINTED", 3, "VENDOR_PURCHASE_TRACKING_TIME_WITHIN_A_SPECIFIC_NUMBER_OF_DAY", 4

  - `data.shipping_option` (object)
    Shipping method and carrier details

  - `data.shipping_option.method` (string,number)
    Shipping method (required)
    Enum: "METHOD_STANDARD", 2, "METHOD_GROUND", 3, "METHOD_FAST_SHIP", 4, "METHOD_STAMP", 5

  - `data.billing_option` (object)
    Billing and tax options (IOSS, etc.)

  - `data.billing_option.ioss_number` (string)
    IOSS (Import One-Stop Shop) number for EU tax compliance (optional)
 Required for shipments to EU countries to avoid customs delays

  - `data.billing_option.ioss_value` (object)
    Total value for IOSS declaration (optional)

  - `data.billing_option.tax_number` (string)
    Tax identification number (optional)
 Used for VAT/GST compliance in various countries

  - `data.billing_option.tax_value` (object)
    Tax value/amount (optional)

  - `data.line_items` (array)
    All line items in this order

  - `data.line_items.id` (integer,string)
    Internal line item ID

  - `data.line_items.quantity` (integer)
    Quantity ordered (minimum 1)

  - `data.line_items.printing_options` (array)
    Printing options for this line item

  - `data.line_items.printing_options.print_location_code` (string,number)
    Print location on the product (required)
    Enum: "PRINT_LOCATION_CODE_WHOLE", 1, "PRINT_LOCATION_CODE_FRONT", 2, "PRINT_LOCATION_CODE_BACK", 3, "PRINT_LOCATION_CODE_LEFT_SLEEVE", 4, "PRINT_LOCATION_CODE_RIGHT_SLEEVE", 5, "PRINT_LOCATION_CODE_POCKET", 6

  - `data.line_items.printing_options.design_url` (string)
    Design file URL (PNG, JPEG, or PDF format)

  - `data.line_items.seller_variant_id` (string)
    Seller's variant ID (from marketplace)

  - `data.line_items.product_id` (string)
    Product ID

  - `data.line_items.product_name` (string)
    Product name

  - `data.line_items.item_price` (object)
    Unit price per item

  - `data.line_items.line_tax` (object)
    Tax amount for this line

  - `data.line_items.line_fee` (object)
    Additional fees for this line

  - `data.line_items.line_discount` (object)
    Discount applied to this line

  - `data.line_items.line_subtotal` (object)
    Subtotal before tax and fees

  - `data.line_items.line_total` (object)
    Total amount for this line

  - `data.line_items.fulfillment_option` (object)
    Fulfillment options (barcode, etc.)

  - `data.line_items.fulfillment_option.barcode_url` (string)

  - `data.line_items.product_url` (string)
    Product URL (link to product page)

  - `data.line_items.product_sku` (string)
    Product SKU

  - `data.line_items.variant` (object)
    Variant details

  - `data.line_items.variant.variant_id` (string)
    Variant ID (string format)

  - `data.line_items.variant.variant_name` (string)
    Variant name (e.g., "Black / Medium")

  - `data.line_items.variant.legacy_id` (integer)
    Legacy variant ID (integer format, for backward compatibility)

  - `data.line_items.variant.sku` (string)
    SKU (Stock Keeping Unit)

  - `data.line_items.variant.name` (string)
    Variant name

  - `data.line_items.variant.description` (string)
    Variant description

  - `data.line_items.variant.option_1` (string)
    First option value (e.g., "Black" for color)

  - `data.line_items.variant.option_2` (string)
    Second option value (e.g., "Medium" for size)

  - `data.line_items.variant.option_3` (string)
    Third option value (optional)

  - `data.line_items.variant.option_1_name` (string)
    First option name (e.g., "Color")

  - `data.line_items.variant.option_2_name` (string)
    Second option name (e.g., "Size")

  - `data.line_items.variant.option_3_name` (string)
    Third option name (optional)

  - `data.line_items.variant.stock_label` (string,number)
    Stock availability status
    Enum: "VENDOR_STOCK_LABEL_IN_STOCK", 1, "VENDOR_STOCK_LABEL_OUT_OF_STOCK", 2, "VENDOR_STOCK_LABEL_AT_RISK", 3, "VENDOR_STOCK_LABEL_DISCONTINUED", 4

  - `data.line_items.order_id` (string)
    Order ID this line item belongs to

  - `data.line_items.line_item_id` (string)
    Line item ID (string format)

  - `data.tracking_number` (string)
    Primary tracking number

  - `data.tracking_link` (string)
    Tracking link URL

  - `data.tracking_company` (string)
    Carrier name

  - `data.tracking_product_type` (string)
    Product type for tracking

  - `data.tracking_date_created` (string)
    When tracking was created

  - `data.tracking_type` (string)
    Tracking type

  - `data.payment_status` (string,number)
    Payment status
    Enum: "VENDOR_ORDER_PAYMENT_STATUS_PENDING", 2, "VENDOR_ORDER_PAYMENT_STATUS_SUCCESS", 3, "VENDOR_ORDER_PAYMENT_STATUS_FAILED", 4, "VENDOR_ORDER_PAYMENT_STATUS_EXPIRED", 5, "VENDOR_ORDER_PAYMENT_STATUS_SUCCESS_PARTIALLY", 6

  - `data.shipped_at` (string)
    When the order was shipped

  - `data.legacy_external_id` (string)
    Legacy external ID (for OMS backward compatibility) for oms order's external id

  - `data.reference_id` (string)
    Your custom reference ID

  - `data.gift_messages` (array)
    Gift messages for this order

  - `data.gift_messages.order_id` (string)
    Order ID this gift message belongs to

  - `data.gift_messages.gift_message_id` (string)
    Gift message ID (unique identifier)

  - `data.gift_messages.type` (string,number)
    Gift message type (custom or uploaded image)
    Enum: "TYPE_CUSTOM_IMAGE", 1, "TYPE_UPLOAD_IMAGE", 2

  - `data.gift_messages.content` (string)
    Gift message text content (max 1000 characters)

  - `data.gift_messages.avatar_url` (string)
    Avatar/image URL for the gift message card

  - `data.gift_messages.gift_message_name` (string)
    Gift message template/design name

  - `data.addresses` (array)
    Shipping and billing addresses

  - `data.addresses.first_name` (string)
    Recipient's first name (required)

  - `data.addresses.last_name` (string)
    Recipient's last name (optional)

  - `data.addresses.company` (string)
    Company name (optional)

  - `data.addresses.contact_pronoun` (string)
    Contact pronoun (optional)

  - `data.addresses.street_1` (string)
    Street address line 1 (required)

  - `data.addresses.street_2` (string)
    Street address line 2 (optional, for apartment/suite)

  - `data.addresses.state_code` (string)
    State/province code (ISO 3166-2)

  - `data.addresses.state_name` (string)
    State/province full name (optional)

  - `data.addresses.city` (string)
    City name (required)

  - `data.addresses.zip_code` (string)
    Postal/ZIP code (required)

  - `data.addresses.country_code` (string)
    Country code (ISO 3166-1 alpha-2, required)

  - `data.addresses.country_name` (string)
    Country full name (optional)

  - `data.addresses.phone_no` (string)
    Phone number (optional)

  - `data.addresses.email` (string)
    Email address (optional)

  - `data.addresses.type` (string,number)
    Address type
    Enum: "TYPE_SHIP_FROM", 2, "TYPE_SHIP_TO", 3, "TYPE_BILL_TO", 4, "TYPE_RETURN_TO", 5

## Response 400 fields (application/json):

  - `code` (string, required)
    Machine-readable error code
    Example: "INVALID_ARGUMENT"

  - `message` (string, required)
    Human-readable error message
    Example: "The request parameters are invalid"

  - `details` (array)
    Additional error details

  - `details.field` (string)
    Field that caused the error

  - `details.issue` (string)
    Description of the issue

## Response 401 fields (application/json):

  - `code` (string, required)
    Machine-readable error code
    Example: "INVALID_ARGUMENT"

  - `message` (string, required)
    Human-readable error message
    Example: "The request parameters are invalid"

  - `details` (array)
    Additional error details

  - `details.field` (string)
    Field that caused the error

  - `details.issue` (string)
    Description of the issue

## Response 403 fields (application/json):

  - `code` (string, required)
    Machine-readable error code
    Example: "INVALID_ARGUMENT"

  - `message` (string, required)
    Human-readable error message
    Example: "The request parameters are invalid"

  - `details` (array)
    Additional error details

  - `details.field` (string)
    Field that caused the error

  - `details.issue` (string)
    Description of the issue

## Response 404 fields (application/json):

  - `code` (string, required)
    Machine-readable error code
    Example: "INVALID_ARGUMENT"

  - `message` (string, required)
    Human-readable error message
    Example: "The request parameters are invalid"

  - `details` (array)
    Additional error details

  - `details.field` (string)
    Field that caused the error

  - `details.issue` (string)
    Description of the issue

## Response 500 fields (application/json):

  - `code` (string, required)
    Machine-readable error code
    Example: "INVALID_ARGUMENT"

  - `message` (string, required)
    Human-readable error message
    Example: "The request parameters are invalid"

  - `details` (array)
    Additional error details

  - `details.field` (string)
    Field that caused the error

  - `details.issue` (string)
    Description of the issue