Skip to main content

Get specific order details

GET 

/api/v1/orders/:orderId

This endpoint retrieves detailed information for a specific order including complete line items, customer data, and fulfillment details.

Authentication: Requires Private API Key (sk_*)

Response Data:

  • Complete order details with all line items
    • Customer information (name, email, phone, shipping address)
    • Payment details (method, status, transaction IDs)
    • Fulfillment status and tracking information
    • Pricing breakdown (subtotal, taxes, discounts, total)
    • Status change history with timestamps
    • External platform IDs if linked
    • Order metadata and notes

Use Cases:

  • Order detail pages and views
    • Order fulfillment processing
    • Customer support inquiries
    • Generating invoices and receipts
    • Order verification and validation

Error Scenarios:

  • 404 NOT FOUND - Order not found (Error code: ORDER_NOT_FOUND)
    • 400 BAD REQUEST - Invalid order ID format (Error code: INVALID_REQUEST)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Order retrieved successfully with complete details