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

Request Body

The body of the request must contain the JSON for a single order.

Order Attributes

The following is a list of attributes.

external_order_identifier
: Required. The e-commerce system's order ID.

ordered_at
: Required. Timestamp when the order was created.

order_status
: Possible values are "awaiting_shipment", "awaiting_payment", "awaiting_fulfillment", "awaiting_shipment", "partially_shipped". Default is "awaiting_shipment".

alternate_order_id
: Additional identifier for the e-commerce order.

total_including_tax
: Defaults to 0.0 if not specified.

total_excluding_tax
: Defaults to 0.0 if not specified.

discount_amount
: Defaults to 0.0 if not specified.

coupon_discount
: Defaults to 0.0 if not specified.

subtotal_including_tax
: Defaults to 0.0 if not specified.

subtotal_excluding_tax
: Defaults to 0.0 if not specified.

subtotal_tax
: Defaults to 0.0 if not specified.

total_tax
: Defaults to 0.0 if not specified.

base_shipping_cost
: Defaults to 0.0 if not specified.

shipping_cost_including_tax
: Defaults to 0.0 if not specified.

shipping_cost_excluding_tax
: Defaults to 0.0 if not specified.

shipping_cost_tax
: Defaults to 0.0 if not specified.

base_handling_cost
: Defaults to 0.0 if not specified.

handling_cost_excluding_tax
: Defaults to 0.0 if not specified.

handling_cost_including_tax
: Defaults to 0.0 if not specified.

handling_cost_tax
: Defaults to 0.0 if not specified.

base_wrapping_cost
: Defaults to 0.0 if not specified.

wrapping_cost_excluding_tax
: Defaults to 0.0 if not specified.

wrapping_cost_including_tax
: Defaults to 0.0 if not specified.

wrapping_cost_tax
: Defaults to 0.0 if not specified.

notes
: Customer notes on the order.

internal_notes
: Internal notes on the order.

billing_company
: Company name for billing address

billing_first_name
: Customer first name for billing address

billing_last_name
: Customer last name for billing address

billing_address
: First address line for billing address

billing_address2
: Additional address line for billing address

billing_city
: City name for billing address

billing_state
: State name for billing address

billing_country
: Country name for billing address

billing_postal_code
: Postal code for billing address

billing_phone_number
: Phone number.

billing_email
: Email address

sales_channel
:Sales channel that provided the order, if any

custom_1
:Customer-defined value

custom_2
:Customer-defined value

custom_3
:Customer-defined value

tags
:An array of up to 10 tags for the order

gift
:Specify "1" to indicate a gift order

recipients
: A nested associative array of recipient attributes. At least one recipient is required.

recipients > company
: Company name for shipping address

recipients > first_name
: Customer first name for shipping address

recipients > last_name
: Customer last name for shipping address

recipients > address
: Required. First address line for shipping address

recipients > address2
: Additional address line for shipping address

recipients > city
: City name for shipping address

recipients > state
: State name for shipping address

recipients > country
: Country name for shipping address

recipients > residential
: Whether or not address is residential or not. Value can be "true" or "false".

recipients > postal_code
: Required. Postal code for shipping address

recipients > postal_code_plus_4
: Postal code plus 4 for shipping address

recipients > phone_number
: Customer phone number

recipients > email
: Customer email address

recipients > base_cost
: Cost before tax for all line items sent to this recipient

recipients > cost_excluding_tax
: Cost before tax for all line items sent to this recipient

recipients > cost_including_tax
: Cost including tax for all line items sent to this recipient

recipients > cost_tax
: Cost of the tax for all line items sent to this recipient

recipients > base_handling_cost
: Handling cost before tax for all line items sent to this recipient

recipients > handling_cost_excluding_tax
: Handling cost before tax for all line items sent to this recipient

recipients > handling_cost_including_tax
: Handling cost including tax for all line items sent to this recipient

recipients > handling_cost_tax
: Handling cost of the tax for all line items sent to this recipient

recipients > shipping_zone_id
: ID of the shipping zone.

recipients > shipping_zone_name
: Name of the shipping zone.

recipients > shipping_method
: Method of shipment.

recipients > items_total
: Total number of items.

recipients > items_shipped
: Total number of items shipped.

recipients > line_items
: A nested associative array of line item attributes. At least one line item is required.

recipients > line_items > item_name
: Name of the item/product.

recipients > line_items > sku
: SKU of the item/product.

recipients > line_items > bin_picking_number
: Bin number where the item may be stored in a warehouse.

recipients > line_items > weight_in_ounces
: Weight of the item in ounces. This is the single unit weight - ShippingEasy multiplies weight_in_ounces by quantity to calculate shipping weight.

recipients > line_items > quantity
: Quantity of the items for the line item.

recipients > line_items > total_excluding_tax
: Total amount excluding tax for the item. This is the single unit amount - ShippingEasy multiplies total_excluding_tax by quantity to display a line item total on packing slips.

recipients > line_items > unit_price
: Unit price of the item. Should be set to the same value as total_excluding_tax.

recipients > line_items > price_excluding_tax
: Unit price of the item. Should be set to the same value as total_excluding_tax. Used for displaying order search results.

recipients > line_items > product_options
: Hash of product variations applicable to this line item. E.g. {"color":"red", "size":"XXL"}

recipients > line_items > ext_line_item_id
: Unique identifier used in the store for this line item in the order

recipients > line_items >gift_message
:Gift message, if any, for this line item

Example

{ "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"
         }]
      }]
   }
}
Language
Authorization