/orders

get https://api.shippingeasy.com/api/orders

Search and filter orders account-wide

Product Information

Each order contains one or more line items and each line item specifies a product. If additional information about the product has been specified in the ShippingEasy product catalog, then that additional information will be included if the optional includes=products parameter is specified.

The additional information is in the product node within the lineitems node. Here is an example of a line_items node when the _includes=products parameter was specified.

"line_items": [
            {
              "item_name": "Alias Name",
              "sku": "alias-1-sku",
              "bin_picking_number": "bin-111",
              "bundled_product": null,
              "weight_in_ounces": "16.0",
              "quantity": 1,
              "total_excluding_tax": "33.00",
              "price_excluding_tax": "0.00",
              "unit_price": "33.00",
              "ext_line_item_id": null,
              "ext_product_id": null,
              "product_options": null,
              "uuid": "a5c9a0f5-76f8-44c2-83f9-33e575036431",
              "order_source_id": 403009,
              "gift_message": null,
              "product": {
                "id": 19409,
                "description": "The master SKU",
                "sku": "master-sku-1",
                "weight_in_ounces": "16.0",
                "bin_picking_number": "bin-111",
                "upc": "UPC-0929",
                "asin": "ASIN-3292",
                "isbn": "ISBN-2929",
                "length_as_inches": "4.0",
                "width_as_inches": "3.0",
                "height_as_inches": "3.0",
                "country_of_manufacture": "United States of America",
                "harmonized_code": "008080",
                "declared_value": "99.00",
                "active": true,
                "sku_aliases": [
                  "alias-1-sku"
                ],
                "properties": [
                  
                ],
                "product_category_name": "Mens T-Shirts"
                "image":{
"thumb":"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/thumb/wireless_1_20070813new__42329.1256533712.120.1.png",
"medium":"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/medium/wireless_1_20070813new__42329.1256533712.120.1.png",
"original":"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/original/wireless_1_20070813new__42329.1256533712.120.1.jpg"
								}
              }
            }
          ],

Query Params

page

int32

Defaults to 1

The page to return in the paginated result set

per_page

int32

Defaults to 50

The number of result to include per pagein the paginated result set. The maximum number of results returned per page is 200.

last_updated_at

date

Defaults to 1 week ago

Filters the results by the orders' last updated at timestamp and only returns results with a timestamp newer than or equal to the specified value. The maximum time this value can be set to is 3 months ago. Note that "1 week ago" is the default, but cannot be used literally - you must specify a timestamp, for example: last_updated_at=2017-05-24T19:38:25.000-00:00

status

array of strings

Defaults to shipped

Filters the results by the orders' ShippingEasy order status. Possible values are "shipped", "cleared", "pending_shipment", and "ready_for_shipment". It is possible to pass an array of statuses, e.g. ["shipped", "ready_for_shipment"]

status

includes

string

Adds information to the response. Specifying includes=products will deliver additional information (if available) about each product in the order.

order_number

string

The external_order_identifier to search for

Product Information

200200