Available APIs

Authentication - OAuth2.0

Orders

Inventory

Items

Inbound Shipments

Rmas

Labels

Receipt

Location

Tracking

Document

Webhook

Appointment

Troubleshooting

Events & Payloads

The following webhook events are supported:

Event Name Triggering Event Payload
Order_Shipped Send the notification when an order is shipped. Shipment payload
Order_PartiallyShipped Send the notification when any partial shipment is shipped for the order. Shipment payload

Order_Shipped and Order_PartiallyShipped

Parameter Data Type Description Required
Event
eventId String A unique Event ID. Y
eventName String The event name.
Valid Values: Order_Shipped, Order_Partially_Shipped.		 N
webhookId String The Webhook Subscription ID associated with the event. Y
ocurredAt (this parameter name is a placeholder) Timestamp The timestamp when the event occurs (ISO8601 format). Y
deliveredAt Timestamp The timestamp when the event is attempted to deliver to the callback URL. This value should change if we retry. Y
retryCount Number The retryCount of the event delivery. Y
Order
orderNumber String   Y
externalOrderNumber String   N
fedexOrderId String   Y
status String The status of the order. Y
order.fulfillments[]
carrier String   N
trackNum String   N
trackUrl String   N
shipDate String   N
lpnNumber Number   N
order.fulfillments[].lines[]
externalLineId String   N
sku String   N
shipQty Number   N
shipQtyUom String Valid Values: EA, CA, PA. N

Sample Payload: Order_Partially_Shipped, Order_Shipped

         

{
    "eventId": "2183287432743743anff",
    "eventName":"Order_PartiallyShipped",
    "webhookId": "1111",
    "occurredAt":"2018-09-07T11:01:51-07:00",
    "deliveredAt":"2018-09-07T11:01:51-07:00",
    "retryCount": 0,
    "order": {
        "orderNumber":"1122323",
        "externalOrderNumber":"21334343",
                "fedexOrderId": "0001-0007-H1230162729",
                "status":"Partially Shipped",
               "fulfillments" :  [ 
                {
           "carrier": "FedEx",
           "trackNum": "2333444",
           "trackUrl":"...some url here",
           "shipDate":"01/04/2018",
                      "lines": [ 
                     {
            "externalLineId":"001",
            "sku":"001-001-4344",
            "shipQty":1,
            "shipQtyUom":"EA" 
                    }
                   ]    
             }
        }
}