Skip to content

Get Sales Order By Id

This endpoint retrieves detailed information about a sales order using its unique identifier.

API Endpoint

GET /v-beta/sales_orders/:sales_order_id

Example Request

GET /v-beta/sales_orders/32e18d70-52e0-5002-ab7a-ae33843c2187 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Response Structure

The API returns a comprehensive sales order object containing:

  • sales_order_id: Unique identifier for the order
  • external_order_id and external_order_number: External reference IDs
  • order_source: Details about where the order originated (e.g., Shopify)
  • sales_order_status: Payment and fulfillment status information
  • order_date, created_at, modified_at: Timestamp information
  • payment_details: Financial breakdown including subtotal, shipping, tax, and grand total
  • customer: Customer contact information
  • bill_to and ship_to: Billing and shipping address details
  • sales_order_items: Array of line items with product details, quantities, and pricing

Key Response Fields

Order Source Information

  • order_source_code, order_source_nickname, order_source_friendly_name
  • Refresh status and last update timestamps

Status Information

  • payment_status, fulfillment_status, is_cancelled

Line Item Details

  • Product name, SKU, weight
  • Shipping preferences
  • Unit pricing and totals
  • Quantity and gift status