Webhooks

General Information

Once a webhook is defined, in addition to the JSON payload for each event triggered, additional headers are provided to assist with identifying the message coming from Barrett. These headers include:

X-Barrett-Webhook-Topic: The specific event that was triggered. (e.g., orders/fulfilled)
X-Barrett-Webhook-ID: Unique webhook identifier

Note

Webhooks are set up via your Barrett team. Self-service capabilities are coming soon via a web interface.

Webhook Topics

Orders

Event	Topic	Response
Created	orders/created	Response { "orders": [ { "orderId": "5001238900", "purchaseOrder": "251754", "orderType": "outgoing", "orderStatus": "entered", "dates": { "shipDateStart": "2020-09-25T00:00:00.000Z" }, "transport": { "carrier": "FDEG", "service": "HOME", "terms": "PPD", "type": "S" }, "shipTo": { "contactName": "JOHN DOE", "streetOne": "1234 ARDMORE LN", "streetTwo": "UNIT 4", "city": "ARDMORE", "state": "AL", "postalCode": "35739", "country": "US" }, "items": [ { "itemId": "XK560", "orderedQuantity": 2, "orderedQuantityUom": "EA" } ] } ] }
Cancelled	orders/cancelled	Response { "orders": [ { "orderId": "1130986900", "purchaseOrder": "24067152", "orderType": "outgoing", "orderStatus": "cancelled", "dates": { "shipDateStart": "2020-09-24" }, "transport": { "carrier": "FDEG", "service": "HOME", "terms": "PPD", "type": "S" }, "shipTo": { "contactName": "JOHN DOE", "streetOne": "1234 ARDMORE LN", "streetTwo": "UNIT 4", "city": "ARDMORE", "state": "AL", "postalCode": "35739", "country": "US" }, "items": [ { "itemId": "XK560", "orderedQuantity": 2, "orderedQuantityUom": "EA" } ] } ] }
Fulfilled	orders/fulfilled	Response { "fulfillments": [ { "fulfillmentId": "15239288-1", "orderId": "2832891", "purchaseOrder": "7765648101", "shipDate": "2021-03-21", "carrier": "UPS", "scac": "UPSC", "service": "GRES", "terms": "PPD", "loadId": "F75G443G44", "containers": [ { "containerId": "89898915239288000001", "trackingNumber": "1ZY999999999999999", "ucc128": "00008108190318744622", "dimensions": { "length": 22, "lengthUom": "IN", "width": 15, "widthUom": "IN", "height": 7, "heightUom": "IN", "weight": 6.75, "weightUom": "LB" }, "items": [ { "itemId": "WX5786", "shippedQuantity": 1, "shippedQuantityUom": "EA", "upc": "03600029145334", "serialNumber": "B10312020ARCHW" }, { "itemId": "WX9536", "shippedQuantity": 10, "shippedQuantityUom": "EA", "lotNumber": "A234893" } ] } ] } ] }
Received	orders/received	Response { "receipts": [ { "orderId": "2832890", "receiptId": "15239923-1", "purchaseOrder": "PO1339832038", "toFacility": "TN2", "orderType": "incoming", "proNumber": "2021042103", "totalQuantity": 2376, "undamagedQuantity": 1584, "damagedQuantity": 792, "quantityUom": "EA", "receiptDate": "2021-04-21", "items": [ { "itemId": "WX5786", "totalQuantity": 792, "undamagedQuantity": 792, "damagedQuantity": 0, "quantityUom": "EA", "serialNumber": "286", "lotNumber": "ABC123", "manufactureDate": "2021-03-21", "expirationDate": "2022-04-21", "custom": { "customNumbers": [ { "name": "DTLPASSTHRUNUM10", "value": 1 } ] } }, { "itemId": "WX5786", "totalQuantity": 792, "undamagedQuantity": 0, "damagedQuantity": 792, "quantityUom": "EA", "serialNumber": "286", "custom": { "customNumbers": [ { "name": "DTLPASSTHRUNUM10", "value": 3 } ] } }, { "itemId": "WX5746", "totalQuantity": 792, "undamagedQuantity": 792, "damagedQuantity": 0, "quantityUom": "EA", "serialNumber": "287", "custom": { "customNumbers": [ { "name": "DTLPASSTHRUNUM10", "value": 2 } ] } } ] } ] }

Inventory

Event

Topic

Response

Updated

inventory/adjusted

Response

{
    "customerId": "8675309",
    "inventoryAdjustments": [
        {
            "adjustmentDate": "2022-06-17T7:30:44+000",
            "itemId": "ITEM16",
            "statusId": "AVAILABLE",
            "facility": "MBC",
            "uom": "EA",
            "quantity": -9989,
            "reason":"Damaged Item"
        },{
            "adjustmentDate": "2022-06-17T7:30:44+000",
            "itemId": "ITEM16",
            "statusId": "DAMAGED",
            "facility": "MBC",
            "uom": "EA",
            "quantity": 9989,
            "reason":"Damaged Item"
        },{
            "adjustmentDate": "2022-05-13T9:44:29+000",
            "itemId": "ITEM13",
            "statusId": "ON HOLD",
            "facility": "MBC",
            "uom": "EA",
            "quantity": 5,
            "reason":"Recpt great than Prev. Reptd(EDI)",
            "po": "1000001"
        }
    ]
}

Items

Event

Topic

Response

Created

items/created

Response

{
  "items":
  [
      {
          "customerId": "8675309",
          "itemId": "MYITEM",
          "description": "This is my item description",
          "abbreviation": "MYITEM",
          "velocity": "B",
          "isHazardous": false,
          "statusId": "pending",
          "options":
          {
              "lotNumberRequired": false,
              "serialNumberRequired": false,
              "expirationDateRequired": false,
              "manufactureDateRequired": false
          },
          "upc": "123456787654",
          "countryOfOrigin": "US",
          "uomConversions":
          [],
          "uoms":
          [
              {
                  "isBase": true,
                  "uom": "EA",
                  "dimensions":
                  {
                      "height": 0,
                      "length": 0,
                      "width": 0,
                      "weight": 0
                  }
              }
          ],
          "shippingInformation":
          {}
      }
  ]
}