List Sales Orders

Query Parameter	Description
order_source_id	string (GUID)
external_order_id	string, ID that the Order Source assigned
external_order_number	string, Number that the Order Source assigned
modified_at_start	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`
modified_at_end	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`
created_at_start	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`
created_at_end	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`
order_date_start	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`
order_date_end	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`
payment_status	enumerated string, `unknown`, `paid`, `unpaid`, `partially_paid`.
fulfillment_status	enumerated string, `unknown`, `fulfilled`, `unfulfilled`, `partially_fulfilled`
cancelled	`bool`
page	`int`, defaults to 1
page_size	`int`, defaults to 25
sort_dir	`asc` or `desc`
sort_by	`modified_at`, `created_at`, `order_date`

Example

GET /v-beta/sales_orders?:key=value

1
2
3
GET /v-beta/sales_orders?order_source_id=__YOUR_ORDER_SOURCE_ID_HERE__&sort_dir=desc&sort_by=order_date&page=1&page_size=1 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

{
  "sales_orders": [
    {
      "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": "2018-08-21T21:44:54.27Z",
          "refresh_date": "2018-08-21T21:44:54.27Z"
        },
        "active": true
      },
      "sales_order_status": {
        "payment_status": "unknown",
        "fulfillment_status": "fulfilled",
        "is_cancelled": false
      },
      "order_date": "2016-09-13T15:57:00Z",
      "created_at": "2018-08-09T14:55:09.58Z",
      "modified_at": "2018-08-09T14:55:09.58Z",
      "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": "[email protected]"
      },
      "bill_to": {
        "email": "[email protected]",
        "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
        }
      ]
    }
  ],
  "total": 36,
  "page": 1,
  "pages": 36,
  "links": {
    "first": {
      "href": "https://api.shipengine.com/v-beta/sales_orders?order_source_id=__YOUR_ORDER_SOURCE_ID_HERE__&sort_dir=desc&sort_by=order_date&page=1&page_size=1"
    },
    "last": {
      "href": "https://api.shipengine.com/v-beta/sales_orders?order_source_id=__YOUR_ORDER_SOURCE_ID_HERE__&sort_dir=desc&sort_by=order_date&page=36&page_size=1"
    },
    "prev": {},
    "next": {
      "href": "https://api.shipengine.com/v-beta/sales_orders?order_source_id=__YOUR_ORDER_SOURCE_ID_HERE__&sort_dir=desc&sort_by=order_date&page=2&page_size=1"
    }
  }
}