🎉ShipEngine is becoming ShipStation API🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Get Sales By Order Id

Example

GET /v-beta/sales_orders/:sales_order_id

HTTPcURLC#JavaScriptNodeJSPHPPythonRubyJavaGoSwiftObjective-CPowerShell

1
2
3

GET /v-beta/sales_orders/32e18d70-52e0-5002-ab7a-ae33843c2187 HTTP/1.1

{
  "sales_order_id": "e5a64168-f8d5-5a30-9e93-57f3e61da87b",
  "external_order_id": "1774",
  "external_order_number": "#SH1801",
  "order_source":
  {
    "order_source_id": "0b6acb5a-430e-464d-a3f7-e7e0175a2a76",
    "order_source_nickname": "My Shopify Shop",
    "order_source_code": "shopify",
    "order_source_friendly_name": "Shopify",
    "refresh_info":
    {
      "status": "idle",
      "last_refresh_attempt": "2019-07-25T15:24:46.657Z",
      "refresh_date": "2019-07-25T15:24:46.657Z"
    },
    "active": true
  },
  "sales_order_status":
  {
    "payment_status": "unknown",
    "fulfillment_status": "fulfilled",
    "is_cancelled": false
  },
  "order_date": "2019-07-25T15:24:46.657Z",
  "created_at": "2019-07-25T15:24:46.657Z",
  "modified_at": "2019-07-25T15:24:46.657Z",
  "payment_details":
  {
    "subtotal":
    {
      "currency": "usd",
      "amount": 0
    },
    "estimated_shipping":
    {
      "currency": "usd",
      "amount": 22.38
    },
    "estimated_tax":
    {
      "currency": "usd",
      "amount": 1.85
    },
    "grand_total":
    {
      "currency": "usd",
      "amount": 24.23
    }
  },
  "customer":
  {
    "name": "Amanda Miller",
    "phone": "555-555-5555",
    "email": "amanda.miller@email.com"
  },
  "bill_to":
  {
    "email": "amanda.miller@email.com",
    "address":
    {
      "name": null,
      "phone": null,
      "company_name": null,
      "address_line1": "",
      "address_line2": null,
      "address_line3": null,
      "city_locality": null,
      "state_province": null,
      "postal_code": null,
      "country_code": null,
      "address_residential_indicator": "no"
    }
  },
  "ship_to":
  {
    "name": "Amanda Miller",
    "phone": "555-555-5555",
    "address_line1": "525 S Winchester Blvd",
    "city_locality": "San Jose",
    "state_province": "CA",
    "postal_code": "95128",
    "country_code": "US",
    "address_residential_indicator": "yes"
  },
  "sales_order_items": [
    {
      "sales_order_item_id": "eb8628f7-64ae-5df1-80c6-5e8f24099036",
      "line_item_details":
      {
        "name": "black hotdog shirt L (Default Title)",
        "sku": "SHIRT-HD-BLK-L",
        "weight":
        {
          "value": 143.989,
          "unit": "ounce"
        }
      },
      "ship_to":
      {
        "name": "Amanda Miller",
        "phone": "555-555-5555",
        "address_line1": "525 S Winchester Blvd",
        "city_locality": "San Jose",
        "state_province": "CA",
        "postal_code": "95128",
        "country_code": "US",
        "address_residential_indicator": "yes"
      },
      "requested_shipping_options":
      {
        "shipping_service": "Priority Express Mail",
        "ship_date": null
      },
      "price_summary":
      {
        "unit_price":
        {
          "currency": "usd",
          "amount": 0
        },
        "estimated_tax":
        {
          "currency": "usd",
          "amount": 0
        },
        "estimated_shipping": null,
        "total":
        {
          "currency": "usd",
          "amount": 0
        }
      },
      "quantity": 1,
      "is_gift": false
    }
  ]
}