API Reference
API Reference
These docs are for v1.1. Click to read the latest docs for v1.2.

Example requests

Before starting

As with all ShippingEasy API calls, you will need to calculate a signature to authenticate each request.

Examples

Creating an order

curl -H "Content-Type: application/json" --data @body.json "https://app.shippingeasy.com/api/stores/27aa472e16faa83dd13b7758d31974ed/orders?api_key=f9a7c8ebdfd34beaf260d9b0296c7059&api_timestamp=1401803554&api_signature=c65f43beed46e581939898a78acd10064cfa146845e97885ec02124d7ad648e4"

An example body.json can be found here:

{ "order": 
   {
      "external_order_identifier":"ABC-100",
      "ordered_at":"2014-01-16 14:37:56 -0600",
      "order_status":"awaiting_shipment",
      "subtotal_including_tax":"10.00",
      "total_including_tax":"10.00",
      "total_excluding_tax":"10.00",
      "discount_amount":"0.00",
      "coupon_discount":"1.00",
      "subtotal_including_tax":"0.00",
      "subtotal_excluding_tax":"0.00",
      "subtotal_excluding_tax":"0.00",
      "subtotal_tax":"0.00",
      "total_tax":"0",
      "base_shipping_cost":"0.00",
      "shipping_cost_including_tax":"0.00",
      "shipping_cost_excluding_tax":"0.00",
      "shipping_cost_tax":"0.00",
      "base_handling_cost":"0.00",
      "handling_cost_excluding_tax":"0.00",
      "handling_cost_including_tax":"0.00",
      "handling_cost_tax":"0.00",
      "base_wrapping_cost":"0.00",
      "wrapping_cost_excluding_tax":"0.00",
      "wrapping_cost_including_tax":"0.00",
      "wrapping_cost_tax":"0.00",
      "notes":"Please send promptly.",
      "billing_company":"Acme Inc.",
      "billing_first_name":"Fred",
      "billing_last_name":"Jones",
      "billing_address":"1234 Street",
      "billing_address2":"Suite 100",
      "billing_city":"Austin",
      "billing_state":"TX",
      "billing_postal_code":"78701",
      "billing_country":"USA",
      "billing_phone_number":"512-123-1234",
      "billing_email":"[email protected]",
      "recipients":[{
         "first_name":"Colin",
         "last_name":"Homenick",
         "company":"Wintheiser-Hickle",
         "email":"[email protected]",
         "phone_number":"637-481-6505",
         "residential":"true",
         "address":"21937 Adelbert Springs",
         "address2":"",
         "province":"",
         "state":"CT",
         "city":"Terryfurt",
         "postal_code":"93322",
         "postal_code_plus_4":"1234",
         "country":"Andorra",
         "shipping_method":"Ground",
         "base_cost":"10.00",
         "cost_excluding_tax":"10.00",
         "cost_tax":"0.00",
         "base_handling_cost":"0.00",
         "handling_cost_excluding_tax":"0.00",
         "handling_cost_including_tax":"0.00",
         "handling_cost_tax":"0.00",
         "shipping_zone_id":"123",
         "shipping_zone_name":"XYZ",
         "items_total":"1",
         "items_shipped":"0",
         "line_items":[{
            "item_name":"Pencil Holder",
            "sku":"9876543",
            "bin_picking_number":"7",
            "unit_price":"1.30",
            "total_excluding_tax":"1.30",
            "weight_in_ounces":"10",
            "product_options":{
               "pa_size":"large",
               "Colour":"Blue"
            },
            "quantity":"1"
         }]
      }]
   }
}

Cancelling an order

curl -X POST "https://app.shippingeasy.com/api/stores/86eac265e87ea9a74a86fe248f2e79d2/orders/ABC123/cancellations?api_key=XXX&api_signature=c24c5118a2b2af27557af721145991594d00a0d914f0d9bc2b9a2fa26efb30cc&api_timestamp=1409173624"

Searching orders

curl "https://app.shippingeasy.com/api/orders?api_key=XXX&api_signature=a6ab10918d435ad2abfbbe6004dc2fc7faac62a291f4d66e4a36e5a654d15a54&api_timestamp=1409174329&page=3&per_page=10&status%5B0%5D=ready_for_shipment&status%5B1%5D=shipped"