Skip to navigation
Webhooks

Event Reference

Common fields

  • orderNumber is the Rush Order order number, and alternateOrderNumber is your own.
  • refId is the reference ID returned when an order is submitted through the Orders API.
  • packageId identifies one shipment of an order: the client code, order number and package letter, such as ABC98765A.

order.whready

Sent once per Rush Order order number, when an order enters the warehouse system. timestamp is when the order entered it.

FieldTypeDescription
refId, alternateOrderNumberstring or nullSee common fields.
orderNumberstringThe Rush Order order number.
orderDatestring or nullThe order date received with the order, ISO 8601 with its offset.
shipMethodstring or nullThe order’s ship method code.
items[]arrayThe order’s lines, excluding zero quantities: sku (yours), internalSku (Rush Order’s), disposition, location, quantity.
Example
{
  "type": "order.whready",
  "timestamp": "2026-09-20T18:02:10.123+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "refId": "202620091210ABC1042",
    "alternateOrderNumber": "SHOP-1042",
    "orderNumber": "98765",
    "orderDate": "2026-09-20T17:12:45+00:00",
    "shipMethod": "UGA",
    "items": [
      {
        "sku": "WIDGET-BLU",
        "internalSku": "ABC-WIDGET-BLU",
        "disposition": "A-Stock",
        "location": "USW",
        "quantity": 2
      },
      {
        "sku": "ABC-WIDGET-RED",
        "internalSku": "DMG-ABC-WIDGET-RED-O",
        "disposition": "DMG",
        "location": "USC",
        "quantity": 1
      }
    ]
  }
}

order.released

Sent once per Rush Order order number, when an order is released to the warehouse for picking and packing. Returns are not included. timestamp is when the order was released.

FieldTypeDescription
orderNumberstringThe Rush Order order number.
alternateOrderNumberstring or nullYour order number.
Example
{
  "type": "order.released",
  "timestamp": "2026-09-21T15:05:12+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "orderNumber": "98765",
    "alternateOrderNumber": "SHOP-1042"
  }
}

order.shipped

Sent once per package, when its most recent label is 60 minutes old, listing only the labels that shipped. A tracking number added later produces a new event with all of the package’s tracking numbers. A label voided after the event produces none. timestamp is when the most recent label was recorded.

FieldTypeDescription
refId, alternateOrderNumberstring or nullSee common fields.
orderNumber, packageIdstringSee common fields.
warehousestring or nullThe warehouse that shipped the package (see codes).
shippedAtstringWhen the first label was recorded, ISO 8601 with its offset.
items[]arrayThe package’s items: sku, internalSku, quantity (shipped), disposition, location and itemDetails.
itemDetails[]arrayOne entry per scanned unit, empty when none were scanned: serialNumber, serialNumber2, lotNumber, expirationDate (as scanned, with no fixed format). Each is a string or null.
packages[]arrayThe labels, grouped by carrier (a lower-case code such as usps, or the carrier’s name with hyphens, such as estes-express) and service, with trackingNumbers (one per box).
Example
{
  "type": "order.shipped",
  "timestamp": "2026-09-21T23:31:00+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "refId": "202620091210ABC1042",
    "alternateOrderNumber": "SHOP-1042",
    "orderNumber": "98765",
    "warehouse": "USW",
    "shippedAt": "2026-09-21T16:30:00-07:00",
    "packageId": "ABC98765A",
    "items": [
      {
        "sku": "WIDGET-BLU",
        "internalSku": "ABC-WIDGET-BLU",
        "quantity": 2,
        "itemDetails": [
          {
            "serialNumber": "WB-000123",
            "serialNumber2": "X1",
            "lotNumber": null,
            "expirationDate": null
          },
          {
            "serialNumber": "WB-000124",
            "serialNumber2": null,
            "lotNumber": "L2026-117",
            "expirationDate": "03/31/2027"
          }
        ],
        "disposition": "A-Stock",
        "location": "USW"
      }
    ],
    "packages": [
      {
        "carrier": "usps",
        "service": "USPS Ground Advantage",
        "trackingNumbers": ["9261290312833844954982", "9261290312833844954999"]
      }
    ]
  }
}

Shipment events

Four events follow a package after it ships, from the carrier’s tracking. Each is sent per tracking number, so a package with several boxes produces an event for each box. Return labels are not included. timestamp is when our tracking provider recorded the change.

They share these fields:

FieldTypeDescription
packageId, orderNumberstringSee common fields.
trackingNumberstringThe tracking number the event is about.
carrierstringThe carrier, as a lower-case code such as usps or fedex.
servicestring or nullThe carrier’s service, when it reports one.
deliveryTypestringshipment.delivered only: how the package was delivered (see codes).
reasonstringEvery event except shipment.delivered: why it happened (see codes).

shipment.delivered

Sent once per tracking number, when the carrier reports the package delivered.

Example
{
  "type": "shipment.delivered",
  "timestamp": "2026-09-24T19:42:05+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "packageId": "ABC98765A",
    "orderNumber": "98765",
    "trackingNumber": "9261290312833844954982",
    "carrier": "usps",
    "service": "USPS Ground Advantage",
    "deliveryType": "left_at_door_or_with_neighbor"
  }
}

shipment.delivery_failed

Sent for each failed delivery attempt, such as no one being available to receive the package. A later attempt that also fails is a new event.

Example
{
  "type": "shipment.delivery_failed",
  "timestamp": "2026-09-23T21:10:44+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "packageId": "ABC98765A",
    "orderNumber": "98765",
    "trackingNumber": "9261290312833844954982",
    "carrier": "usps",
    "service": "USPS Ground Advantage",
    "reason": "recipient_unavailable"
  }
}

shipment.exception

Sent when the carrier reports a problem with the package, such as a customs hold, a refusal, or a return to sender. A later exception is a new event.

Example
{
  "type": "shipment.exception",
  "timestamp": "2026-09-25T08:15:30+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "packageId": "ABC98766A",
    "orderNumber": "98766",
    "trackingNumber": "1Z999AA10123456784",
    "carrier": "ups",
    "service": null,
    "reason": "customs_hold"
  }
}

shipment.tracking_expired

Sent once per tracking number, when tracking stops because the carrier has had no updates for a long time, typically about a month. The package’s final status is unknown.

Example
{
  "type": "shipment.tracking_expired",
  "timestamp": "2026-10-27T04:00:12+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "packageId": "ABC98767A",
    "orderNumber": "98767",
    "trackingNumber": "9261290312833844955001",
    "carrier": "usps",
    "service": "USPS Ground Advantage",
    "reason": "no_updates"
  }
}

inbound.received

Sent once per receiver, when an inbound delivery, with or without a PO, has been received into inventory. A PO delivered in several shipments produces an event for each receiver. Only receivers completed after you subscribed are sent. timestamp is when the receiver was completed.

FieldTypeDescription
receiverNumberintegerThe Rush Order receiver number.
poReferenceNumberstring or nullThe PO reference number from your inbound PO.
completedAtstring or nullWhen the receiver was completed, ISO 8601 with its offset.
warehousestring or nullThe warehouse that received it (see codes).
shipper, carrier, billOfLadingstring or nullAs recorded when the delivery arrived.
unitTypestring or nullHow the delivery arrived, such as pallet.
palletCountinteger or nullThe number of pallets.
commentstring or nullThe receiving team’s notes on the delivery.
items[]arrayOne per receiver line: sku, internalSku, disposition, location, description, lineId (from your inbound PO), quantityExpected, quantityReceived, cartonCount, caseQuantity, partialQuantity, notes and itemDetails.
itemDetails[]arrayOne entry per unit scanned with a serial number, or, for items without serials, one entry per unit with a lot number or expiration date. Empty when neither was recorded. Same fields as on order.shipped. Large deliveries can have thousands of entries.
Example
{
  "type": "inbound.received",
  "timestamp": "2026-09-22T20:45:00+00:00",
  "rushOrderMomCode": "ABC",
  "data": {
    "receiverNumber": 12345,
    "poReferenceNumber": "MYPO7656",
    "completedAt": "2026-09-22T13:45:00-07:00",
    "warehouse": "USW",
    "shipper": "Acme Products, Inc.",
    "carrier": "FEDEX",
    "billOfLading": "77719876540",
    "unitType": "pallet",
    "palletCount": 2,
    "comment": null,
    "items": [
      {
        "sku": "WIDGET-BLU",
        "internalSku": "ABC-WIDGET-BLU",
        "disposition": "A-Stock",
        "location": "USW",
        "description": "Widget, blue",
        "lineId": "1",
        "quantityExpected": 2,
        "quantityReceived": 2,
        "cartonCount": 1,
        "caseQuantity": 2,
        "partialQuantity": 0,
        "notes": null,
        "itemDetails": [
          {
            "serialNumber": "WB-000123",
            "serialNumber2": null,
            "lotNumber": null,
            "expirationDate": null
          },
          {
            "serialNumber": "WB-000124",
            "serialNumber2": null,
            "lotNumber": null,
            "expirationDate": null
          }
        ]
      }
    ]
  }
}

Codes

Disposition

items[].disposition is the condition of the stock, taken from the Rush Order SKU.

ValueMeaning
A-StockStandard stock: the Rush Order SKU has no condition prefix.
DMG, RTS, QUAR, FDAThe condition prefix on the Rush Order SKU, such as DMG in DMG-ABC-WIDGET-RED-O.

Delivery type

deliveryType on shipment.delivered.

ValueMeaning
signed_forReceived and signed for by the recipient.
left_at_door_or_with_neighborLeft at the door or with a neighbor.
picked_up_by_recipientPicked up by the recipient, such as from a pickup point.
unspecifiedDelivered, but the carrier didn’t say how.

Reason

reason on the other shipment events.

EventValueMeaning
shipment.delivery_failedaddress_issueA problem with the address.
recipient_unavailableNo one was available to receive the package.
recipient_not_locatedThe carrier couldn’t locate the recipient.
shipment.exceptioncustoms_holdHeld by customs.
refusedRefused by the recipient.
unclaimedNot collected by the recipient.
lost_or_damagedLost or damaged in transit.
canceled_before_pickupThe shipment was canceled before the carrier picked it up.
returning_to_senderOn its way back to the sender.
returned_to_senderReturned to the sender.
shipment.tracking_expiredno_updatesThe carrier stopped providing updates.
shipment.delivery_failed, shipment.exceptionotherAny other reason, or one the carrier didn’t specify.

Warehouse and location

Used by warehouse and items[].location.

CodeWarehouse
USWCalifornia
USENew York
USCOhio
USSTexas
CACanada
MXMexico
GBUnited Kingdom
NLNetherlands
HKHong Kong
JPJapan
AUAustralia
VNVietnam