ShippingEasy can send a webhook callback to your application when an order that was added to ShippingEasy via the ShippingEasy API is shipped

The URL for the callback is configured on your ShippingEasy API store settings page:

781781

The callback will be an HTTP POST from the ShippingEasy server. It will always include an api_signature querystring, and JSON formatted body.

The endpoint you provide for shipment notifications must not require authentication.

An example callback payload:

{  
  "shipment":{  
    "id":58,
    "tracking_number":"794675663409",
    "carrier_key":"FEDEX",
    "carrier_service_key":"FEDEX_GROUND",
    "shipment_cost":2009,
    "ship_date": "2018-02-12",
    "workflow_state": "label_ready",
    "cloned_from_shipment_id": null,
    "weight_in_ounces": "4.0",
    "length_in_inches": "3.0",
    "width_in_inches": "2.0",
    "height_in_inches": "1.0",
    "additional_packages": [
      {
        "description": "second box",
        "tracking_number": "794675663410",
        "weight_in_ounces": "16.0",
        "length_in_inches": "3.0",
        "width_in_inches": "3.0",
        "height_in_inches": "3.0"
      }
    ],
    "ship_from_address_id": 39201,
    "orders":[  
      {  
        "id":119,
        "external_order_identifier":"ABC-635574609661580899",
        "ordered_at":"2015-01-22T00:16:06Z",
        "order_status":"shipped",
        "parent_order_id":null,
        "source_order_ids":null,
        "total_including_tax":"0.00",
        "total_excluding_tax":"0.00",
        "discount_amount":"0.00",
        "coupon_discount":"0.00",
        "subtotal_including_tax":"0.00",
        "subtotal_excluding_tax":"0.00",
        "subtotal_tax":"0.00",
        "total_tax":"0.00",
        "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",
        "billing_company":null,
        "billing_first_name":null,
        "billing_last_name":null,
        "billing_address":null,
        "billing_address2":null,
        "billing_city":null,
        "billing_state":null,
        "billing_country":null,
        "billing_postal_code":null,
        "billing_phone_number":null,
        "billing_email":null,
        "recipients":[  
          {  
            "company":null,
            "first_name":"Jack",
            "last_name":"Ship",
            "address":"123 Main St",
            "address2":"Suite # 2",
            "address3":null,
            "city": "Somewhere",
            "residential":null,
            "state": "TX",
            "province":null,
            "country":"United States",
            "postal_code":null,
            "postal_code_plus_4":null,
            "phone_number":null,
            "email":null,
            "base_cost":"0.00",
            "cost_excluding_tax":"0.00",
            "cost_including_tax":"0.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":null,
            "shipping_zone_name":null,
            "items_total":0,
            "shipping_method":null,
            "items_shipped":0,
            "ext_shipping_detail_id":null,
            "line_items":[  
              {  
                "item_name":"Sprocket",
                "sku":null,
                "bin_picking_number":null,
                "weight_in_ounces":"0.0",
                "quantity":7,
                "total_excluding_tax":"0.00",
                "price_excluding_tax":"0.00",
                "unit_price":"0.00",
                "ext_line_item_id":null,
                "ext_product_id":null,
                "product_options":null,
                "uuid":null,
                "order_source_id":null
              }
            ]
          }
        ],
        "store_api_key":"c71dc6da574eea04e2c926906bcb4eec",
        "shipments":[  
          {  
            "id":58,
            "tracking_number":"794675663409",
            "carrier_key":"FEDEX",
            "carrier_service_key":"FEDEX_GROUND",
            "shipment_cost":2009,
            "ship_date":"2015-01-29",
            "workflow_state": "label_ready",
            "cloned_from_shipment_id": null,
            "weight_in_ounces": "4.0",
            "length_in_inches": "3.0",
            "width_in_inches": "2.0",
            "height_in_inches": "1.0",
            "additional_packages": [
              {
                "description": "second box",
                "tracking_number": "794675663410",
                "weight_in_ounces": "16.0",
                "length_in_inches": "3.0",
                "width_in_inches": "3.0",
                "height_in_inches": "3.0"
              }
            ],
            "ship_from_address_id": 39201,
            "shipment_type": "outbound"
          }
        ],
        "updated_at":"2015-01-29T18:50:35Z",
        "notes": "Please use extra packaging"
      }
    ]
  }
}

The supported values for workflow_state are:

Value

Meaning

label_ready

The shipment label has been purchased, but not yet printed.

label_printed

The shipment label has been both purchased and printed.

cancelled

The shipment label has been cancelled.

drop_shipped

No shipping label was created in ShippingEasy - instead, the order was marked as shipped.

label_pending

The shipment label has not yet been purchased.

The supported values for shipment_type are:

Value

Meaning

outbound

The shipment was for delivering an order to a buyer.

return

The shipment was for delivering the return of merchandise to a merchant.