Skip to main content
WEBHOOK
onOrderCreated
{
  "order": {
    "id": "<string>",
    "chargesToCustomer": {
      "lineItems": [
        {
          "description": "<string>",
          "amount": {
            "uom": "USD",
            "value": 123
          },
          "type": "FREIGHT_FLAT"
        }
      ]
    },
    "cargo": {
      "commodities": [
        {
          "description": "<string>",
          "isStackable": true,
          "itemReference": {
            "type": "ORDER_REFERENCE",
            "value": "<string>"
          },
          "dimensions": {
            "height": {
              "value": 123,
              "units": "IN"
            },
            "width": {
              "value": 123,
              "units": "IN"
            },
            "length": {
              "value": 123,
              "units": "IN"
            }
          },
          "weight": {
            "units": "LB",
            "value": 123
          },
          "hazmat": {
            "classifications": [
              {
                "qualifier": "P",
                "hazardClass": "1"
              }
            ],
            "contact": {
              "id": "<string>",
              "name": "<string>",
              "phone": "<string>",
              "email": "<string>",
              "role": "<string>",
              "customerId": "<string>",
              "carrierId": "<string>",
              "reference": {
                "type": "ORDER_REFERENCE",
                "value": "<string>"
              }
            },
            "packingGroup": "<string>",
            "unNumber": "<string>",
            "weight": {
              "units": "LB",
              "value": 123
            }
          },
          "nmfcCode": "<string>",
          "freightClass": "<string>",
          "pieceUnits": "BAGS",
          "pieceQuantity": 123,
          "handlingUnits": "BAGS",
          "handlingQuantity": 123
        }
      ],
      "declaredValue": {
        "uom": "USD",
        "value": 123
      },
      "dimensions": {
        "height": {
          "value": 123,
          "units": "IN"
        },
        "width": {
          "value": 123,
          "units": "IN"
        },
        "length": {
          "value": 123,
          "units": "IN"
        }
      },
      "totalWeight": {
        "units": "LB",
        "value": 123
      }
    },
    "equipmentOptions": [
      {
        "type": "BOX_TRUCK",
        "equipmentLength": {
          "value": 123,
          "units": "IN"
        },
        "temperature": {
          "units": "F",
          "max": 123,
          "min": 123
        },
        "description": "<string>"
      }
    ],
    "customer": {
      "name": "<string>",
      "externalIds": [
        {
          "type": "ALJEX",
          "value": "<string>"
        }
      ],
      "id": "<string>",
      "contacts": [
        {
          "id": "<string>",
          "name": "<string>",
          "phone": "<string>",
          "email": "<string>",
          "role": "<string>",
          "customerId": "<string>",
          "carrierId": "<string>"
        }
      ]
    },
    "route": {
      "stops": [
        {
          "location": {
            "externalIds": [
              {
                "type": "CUSTOM",
                "value": "<string>"
              }
            ],
            "address": {
              "country": "<string>",
              "postalCode": "<string>",
              "city": "<string>",
              "state": "<string>",
              "addressTwo": "<string>",
              "addressOne": "<string>"
            },
            "id": "<string>",
            "geoCoordinates": {
              "longitude": 123,
              "latitude": 123
            },
            "hours": {
              "sunday": {
                "type": "FACILITY_HOURS",
                "timezone": "<string>",
                "endTime": "<string>",
                "startTime": "<string>"
              },
              "saturday": {
                "type": "FACILITY_HOURS",
                "timezone": "<string>",
                "endTime": "<string>",
                "startTime": "<string>"
              },
              "friday": {
                "type": "FACILITY_HOURS",
                "timezone": "<string>",
                "endTime": "<string>",
                "startTime": "<string>"
              },
              "thursday": {
                "type": "FACILITY_HOURS",
                "timezone": "<string>",
                "endTime": "<string>",
                "startTime": "<string>"
              },
              "wednesday": {
                "type": "FACILITY_HOURS",
                "timezone": "<string>",
                "endTime": "<string>",
                "startTime": "<string>"
              },
              "tuesday": {
                "type": "FACILITY_HOURS",
                "timezone": "<string>",
                "endTime": "<string>",
                "startTime": "<string>"
              },
              "monday": {
                "type": "FACILITY_HOURS",
                "timezone": "<string>",
                "endTime": "<string>",
                "startTime": "<string>"
              }
            },
            "contacts": [
              {
                "name": "<string>",
                "email": "<string>",
                "phone": "<string>",
                "role": "<string>"
              }
            ],
            "name": "<string>"
          },
          "type": "PICKUP",
          "stopReferences": [
            {
              "type": "ORDER_REFERENCE",
              "value": "<string>"
            }
          ],
          "id": "<string>",
          "externalNotes": "<string>",
          "internalNotes": "<string>",
          "accessorials": [
            {
              "size": {
                "value": 123,
                "units": "IN"
              },
              "type": "TARPING"
            }
          ],
          "contact": {
            "id": "<string>",
            "name": "<string>",
            "phone": "<string>",
            "email": "<string>",
            "role": "<string>",
            "customerId": "<string>",
            "carrierId": "<string>"
          },
          "commodities": [
            {
              "description": "<string>",
              "isStackable": true,
              "itemReference": {
                "type": "ORDER_REFERENCE",
                "value": "<string>"
              },
              "dimensions": {
                "height": {
                  "value": 123,
                  "units": "IN"
                },
                "width": {
                  "value": 123,
                  "units": "IN"
                },
                "length": {
                  "value": 123,
                  "units": "IN"
                }
              },
              "weight": {
                "units": "LB",
                "value": 123
              },
              "hazmat": {
                "classifications": [
                  {
                    "qualifier": "P",
                    "hazardClass": "1"
                  }
                ],
                "contact": {
                  "id": "<string>",
                  "name": "<string>",
                  "phone": "<string>",
                  "email": "<string>",
                  "role": "<string>",
                  "customerId": "<string>",
                  "carrierId": "<string>",
                  "reference": {
                    "type": "ORDER_REFERENCE",
                    "value": "<string>"
                  }
                },
                "packingGroup": "<string>",
                "unNumber": "<string>",
                "weight": {
                  "units": "LB",
                  "value": 123
                }
              },
              "nmfcCode": "<string>",
              "freightClass": "<string>",
              "pieceUnits": "BAGS",
              "pieceQuantity": 123,
              "handlingUnits": "BAGS",
              "handlingQuantity": 123
            }
          ],
          "weight": {
            "units": "LB",
            "value": 123
          },
          "notes": "<string>",
          "schedulingType": "FIRST_COME_FIRST_SERVE",
          "dateTimeRanges": [
            {
              "startDate": "<string>",
              "endDate": "<string>",
              "startTime": "<string>",
              "endTime": "<string>",
              "timezone": "<string>",
              "type": "FACILITY_HOURS"
            }
          ],
          "externalIds": [
            {
              "type": "CUSTOM",
              "value": "<string>"
            }
          ]
        }
      ],
      "mileage": {
        "uom": "MI",
        "value": 123
      }
    },
    "references": [
      {
        "type": "ORDER_REFERENCE",
        "value": "<string>"
      }
    ],
    "environment": "TEST",
    "documents": [
      {
        "url": "<string>",
        "id": "<string>"
      }
    ],
    "user": {
      "id": "<string>",
      "externalIds": [
        {
          "type": "CUSTOM",
          "value": "<string>"
        }
      ]
    },
    "attributes": {},
    "tags": [
      "<string>"
    ],
    "externalNotes": "<string>",
    "internalNotes": "<string>",
    "accessorials": [
      {
        "size": {
          "value": 123,
          "units": "IN"
        },
        "type": "TARPING"
      }
    ],
    "freightModeDetails": {
      "mode": "TRUCKLOAD",
      "drayageSubtype": "IMPORT"
    }
  },
  "event": "order.created"
}
Beta Feature: This functionality is currently in beta. You may experience changes or limited support as we continue to improve it.

Body

application/json
order
object
required
event
enum<string>
required
Available options:
order.created

Response

OK