API - Shipment Notification

A shipping notification can be sent to a user specified email, or a shipment callback can be sent to a user specified URL. By default the callback will be in XML format. If the callback URL ends with .json, then the callback will be in JSON format.

To set up shipping notifications or shipment callback, please contact us.

Example Callback in XML

<shipping_notification>
  <status>success</status>
  <message>order is shipped</message>
  <partner_order_id>123456</partner_order_id>
  <order_id>7654321</order_id>
  <shipper>UPS</shipper>
  <tracking_number>1Z88F42A129059XXXX</tracking_number>
  <shipping_datetime>2018-1-31T12-14-50</shipping_datetime>
</shipping_notification> 

Example Callback in JSON

{
  "shipping_notification":
  {
    "status": "success",
    "message": "order is shipped",
    "partner_order_id": "123456",
    "order_id": "7654321",
    "shipper": "UPS",
    "tracking_number": "1Z88F42A129059XXXX",
    "shipping_datetime": "2018-01-31T13-14-50",
  }
}

Success: HTTP 200 should be returned, otherwise the system will try to post again.