v1

latestOpenAPI 3.1.02026-07-14110151.9 KB

/orders/:id

Find a specific order by ShippingEasy order ID

get/api/orders/:id

Query parameters

:idstring

ShippingEasy order ID

Response

200

idinteger

external_order_identifierstring

ext_order_reference_idstring

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:owner_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:sales_channel","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:fulfillment_channel","oasType":"schema","type":"unknown"}

ordered_atstring

order_statusstring

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:parent_order_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:source_order_ids","oasType":"schema","type":"unknown"}

total_including_taxstring

total_excluding_taxstring

discount_amountstring

coupon_discountstring

subtotal_including_taxstring

subtotal_excluding_taxstring

subtotal_taxstring

total_taxstring

base_shipping_coststring

shipping_cost_including_taxstring

shipping_cost_excluding_taxstring

shipping_cost_taxstring

base_handling_coststring

handling_cost_excluding_taxstring

handling_cost_including_taxstring

handling_cost_taxstring

base_wrapping_coststring

wrapping_cost_excluding_taxstring

wrapping_cost_including_taxstring

wrapping_cost_taxstring

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:billing_company","oasType":"schema","type":"unknown"}

billing_first_namestring

billing_last_namestring

billing_addressstring

billing_address2string

billing_citystring

billing_statestring

billing_countrystring

billing_postal_codestring

billing_phone_numberstring

billing_emailstring

store_api_keystring

updated_atstring

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:internal_notes","oasType":"schema","type":"unknown"}

meta_datastring

prime_order_idinteger

{"stackTrail":"paths:/api/orders/%3Aid:get:responses:200:content:application/json:schema:properties:split_from_order_id","oasType":"schema","type":"unknown"}

Example response

{
  "id": 18772253,
  "external_order_identifier": "265",
  "ext_order_reference_id": "231597493929-0",
  "ordered_at": "2015-06-18T21:25:39Z",
  "order_status": "ready_for_shipment",
  "total_including_tax": "1.00",
  "total_excluding_tax": "0.99",
  "discount_amount": "0.00",
  "coupon_discount": "0.00",
  "subtotal_including_tax": "1.00",
  "subtotal_excluding_tax": "0.99",
  "subtotal_tax": "0.00",
  "total_tax": "0.00",
  "base_shipping_cost": "0.00",
  "shipping_cost_including_tax": "0.01",
  "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",
  "billing_first_name": "Thomas",
  "billing_last_name": "Smith",
  "billing_address": "609 Castle Ridge Rd",
  "billing_city": "Austin",
  "billing_state": "TX",
  "billing_country": "US",
  "billing_postal_code": "78746-5147",
  "billing_phone_number": "512 201 5122",
  "billing_email": "jack@shippingeasy.com",
  "recipients": [
    {
      "first_name": "Thomas",
      "last_name": "Smith",
      "address": "609 Castle Ridge Rd",
      "city": "Austin",
      "state": "TX",
      "country": "United States",
      "postal_code": "78746",
      "postal_code_plus_4": "5147",
      "phone_number": "512 201 5122",
      "email": "jack@shippingeasy.com",
      "base_cost": "0.01",
      "cost_excluding_tax": "0.01",
      "cost_including_tax": "0.01",
      "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_method": "USPSPriority",
      "line_items": [
        {
          "item_name": "Blue SE hat (Pre-owned)",
          "sku": "231597493929",
          "weight_in_ounces": "0.0",
          "quantity": 1,
          "total_excluding_tax": "0.00",
          "price_excluding_tax": "0.99",
          "unit_price": "0.99",
          "ext_line_item_id": "231597493929",
          "uuid": "7887ed9a-d9d3-4c2f-aa8c-ea710f058b2d",
          "order_source_id": 7624869
        }
      ],
      "original_order": {
        "address_kind": "C",
        "created_at": "2015-06-18T22:25:56Z",
        "customer_id": 3633,
        "denormalized_ext_order_id": "265",
        "denormalized_ordered_at": "2015-06-18T21:25:39Z",
        "id": 18772253,
        "line_item_name": "blue se hat (pre-owned)",
        "line_item_sku": "231597493929",
        "order_detail_id": 18709860,
        "prime_order_id": 18772253,
        "recipient_last_name": "smith",
        "recipient_requested_service": "uspspriority",
        "state": "TX",
        "store_id": 13795,
        "total_quantity": 1,
        "total_weight_in_ounces": "0.0",
        "updated_at": "2015-06-18T22:25:58Z",
        "usps_shipping_zone": 1,
        "workflow_state": "ready_for_shipment"
      }
    }
  ],
  "store_api_key": "e7100c36a711a01d12b41757fade8d1f",
  "updated_at": "2015-06-18T22:25:58Z",
  "meta_data": "seller_record: 265, transaction_id: , ebay_order_id: 231597493929-0",
  "prime_order_id": 18772253
}