# Get Order

Get details of a specific order

 GET /api/v3/orders/{order_id}

 Response includes:
   - Order status and tracking
   - Line items with printing details
   - Shipping information
   - Payment/transaction details

 Use cases:
   - Track order fulfillment
   - Get shipping/tracking info
   - Customer support queries

Endpoint: GET /api/v3/orders/{order_id}
Version: v3.0.0

## Response 200 fields (application/json):

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

  - `message` (string)
    Human-readable message

  - `data` (object)
    Complete order details
 Includes: line items, tracking, shipping, payment, pricing

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

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

  - `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.fulfillment_vendor` (string,number)
    Fulfillment vendor (Gearment, etc.)
    Enum: "VENDOR_FULFILLMENT_VENDOR_GEARMENT", 2, "VENDOR_FULFILLMENT_VENDOR_AMAZON", 3

  - `data.vendor_ref` (string)
    Vendor's reference ID for this order

  - `data.priority` (string,number)
    Fulfillment priority (standard, rush, etc.)
    Enum: "VENDOR_FULFILLMENT_PRIORITY_NORMAL", 2, "VENDOR_FULFILLMENT_PRIORITY_RUSH", 3

  - `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.ioss_value.currency_code` (string)
    The three-letter currency code defined in ISO 4217.

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

  - `data.billing_option.ioss_value.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.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.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.primary_package_id` (string)
    Primary package ID for this order

  - `data.primary_shipment_id` (string)
    Primary shipment ID for this order

  - `data.is_label_attached` (boolean)
    Whether shipping label is attached

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

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

  - `data.order_fee` (object)
    Additional processing fees

  - `data.order_discount` (object)
    Total discount applied

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

  - `data.order_redeem` (object)
    Amount redeemed from credits/wallet

  - `data.paid_total` (object)
    Amount already paid

  - `data.paid_needed` (object)
    Amount still needed to complete payment

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

  - `data.created_at` (string)
    When this order record was created

  - `data.updated_at` (string)
    When this order was last updated

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

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

  - `data.line_items.variant_id` (string)
    Product variant 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.option_1` (string)
    First option value (e.g., "Black" for color)

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

  - `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.variant_name` (string)
    Variant name (e.g., "Black / Medium")

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

  - `data.line_items.variant_sku` (string)
    Variant SKU

  - `data.line_items.product_type_name` (string)
    Product type name (e.g., "T-Shirt", "Hoodie")

  - `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.store_name` (string)
    Store name for display

  - `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

  - `data.stages` (array)
    Processing stages (printing, packing, shipping, etc.)

  - `data.stages.stage_id` (string)
    Processing stage ID

  - `data.stages.stage_name` (string)
    Processing stage name (e.g., "Printing", "Packing", "Shipping")

  - `data.stages.stage_started_at` (string)
    When this stage started

  - `data.stages.stage_completed_at` (string)
    When this stage completed

  - `data.stages.is_completed` (boolean)
    Whether this stage is completed

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

  - `data.order_shipping_fee` (object)
    Shipping cost

  - `data.order_handle_fee` (object)
    Order handling fee

  - `data.order_surcharge` (object)
    Additional surcharges

  - `data.order_rush_fee` (object)
    Rush processing fee (if applicable)

  - `data.order_thank_card_fee` (object)
    Thank you card fee (if applicable)

  - `data.order_trackings` (array)
    All tracking information for this order

  - `data.order_trackings.tracking_no` (string)
    Tracking number (e.g., "1Z999AA10123456784" for UPS)

  - `data.order_trackings.tracking_updated_at` (string)
    Last update timestamp for tracking information

  - `data.order_trackings.carrier` (string)
    Shipping carrier (e.g., "USPS", "FedEx", "UPS", "DHL")

  - `data.order_trackings.service` (string)
    Shipping service level (e.g., "Priority Mail", "Ground", "Express")

  - `data.order_trackings.type` (string)
    Legacy tracking type field (deprecated, use tracking_type instead)

  - `data.order_trackings.label_file` (object)
    Shipping label file (PDF or image)

  - `data.order_trackings.label_file.file_name` (string)

  - `data.order_trackings.label_file.file_path` (string)

  - `data.order_trackings.label_file.file_url` (string)

  - `data.order_trackings.label_file.file_id` (string)

  - `data.order_trackings.tracking_type` (string,number)
    Tracking type (indicates if this is the primary, secondary, or outdated tracking)
    Enum: "TRACKING_TYPE_PRIMARY", 1, "TRACKING_TYPE_SECONDARY", 2, "TRACKING_TYPE_OUTDATED", 3

  - `data.order_trackings.tracking_url` (string)
    Tracking URL for carrier's tracking page (e.g., "https://tools.usps.com/go/TrackConfirmAction?tLabels=...")

  - `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.refund_status` (string,number)
    Refund status
    Enum: "VENDOR_ORDER_REFUND_STATUS_NOT_REQUESTED", 2, "VENDOR_ORDER_REFUND_STATUS_NOT_APPLICABLE", 3, "VENDOR_ORDER_REFUND_STATUS_REQUESTED", 4, "VENDOR_ORDER_REFUND_STATUS_PROCESSING", 5, "VENDOR_ORDER_REFUND_STATUS_REFUNDED", 6, "VENDOR_ORDER_REFUND_STATUS_PARTIALLY_REFUNDED", 7, "VENDOR_ORDER_REFUND_STATUS_RETURN_REFUND_REQUESTED", 8, "VENDOR_ORDER_REFUND_STATUS_RETURN_REFUNDED", 9, "VENDOR_ORDER_REFUND_STATUS_REJECTED", 10, "VENDOR_ORDER_REFUND_STATUS_FAILED", 11

  - `data.cancel_status` (string,number)
    Cancellation status
    Enum: "VENDOR_ORDER_CANCEL_STATUS_NOT_REQUESTED", 2, "VENDOR_ORDER_CANCEL_STATUS_REQUESTED", 3, "VENDOR_ORDER_CANCEL_STATUS_PROCESSING", 4, "VENDOR_ORDER_CANCEL_STATUS_CANCELED", 5, "VENDOR_ORDER_CANCEL_STATUS_PARTIALLY_CANCELED", 6, "VENDOR_ORDER_CANCEL_STATUS_RETURN_REQUESTED", 7, "VENDOR_ORDER_CANCEL_STATUS_RETURNED", 8, "VENDOR_ORDER_CANCEL_STATUS_RETURN_REJECTED", 9, "VENDOR_ORDER_CANCEL_STATUS_REJECTED", 10, "VENDOR_ORDER_CANCEL_STATUS_FAILED", 11

  - `data.order_priority` (string)
    Order priority label (for display)

  - `data.transaction_info` (object)
    Payment transaction details

  - `data.transaction_info.txn_id` (string)
    Transaction ID (unique identifier for this payment transaction)

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

  - `data.transaction_info.method_code` (string)
    Payment method code (e.g., "credit_card", "paypal", "stripe")

  - `data.transaction_info.method_icon_urls` (string)
    Payment method icon URL (for displaying payment method logo)

  - `data.transaction_info.list_invoice_detail` (array)
    List of invoice details included in this transaction

  - `data.transaction_info.list_invoice_detail.invoice_id` (string)
    Invoice ID (unique identifier for this invoice)

  - `data.transaction_info.list_invoice_detail.order_id` (string)
    Order ID associated with this invoice line

  - `data.transaction_info.list_invoice_detail.variant_name` (string)
    Product variant name (e.g., "Unisex T-Shirt - Black - M")

  - `data.transaction_info.list_invoice_detail.quantity` (integer)
    Quantity of items in this invoice line

  - `data.transaction_info.list_invoice_detail.shipping_service` (string)
    Shipping service used (e.g., "USPS Priority Mail", "FedEx Ground")

  - `data.transaction_info.list_invoice_detail.tracking_number` (string)
    Tracking number for shipment

  - `data.transaction_info.list_invoice_detail.product_image_url` (string)
    Product image URL

  - `data.transaction_info.list_invoice_detail.line_total` (object)
    Total amount for this invoice line

  - `data.cancel_reason` (object)
    Cancellation reason (if canceled)

  - `data.cancel_reason.reason_id` (string)
    Cancellation reason ID

  - `data.cancel_reason.display_name` (string)
    Human-readable cancellation reason

  - `data.cancel_reason.custom_reason` (string)
    Custom cancellation reason (if not using predefined reasons)

  - `data.refunded_total` (object)
    Total amount refunded

  - `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

## 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