GET api/webhooks/simulate/shipconfirm/{orderNumber}
Simulate the ship confirm web hook. It will show what will be sent so it can be tested.
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| orderNumber | string |
Order number to simulate |
Required |
Body Parameters
None
Response Information
Resource Description
Object representing what will be sent for this webhook
ShipmentWebhook| Name | Type | Description | Additional information |
|---|---|---|---|
| ClientName | string |
|
|
| OrderNumber | string |
|
|
| VisibleShipmentNumber | string |
|
|
| ShipmentCarrier | string |
|
|
| ShipmentServiceType | string |
|
|
| ShipFromWarehouse | string |
|
|
| ShipmentPackages | Collection of ShipmentPackageWebhook |
|
Response Formats
application/json, text/json
Sample:
{
"ClientName": "sample string 1",
"OrderNumber": "sample string 2",
"VisibleShipmentNumber": "sample string 3",
"ShipmentCarrier": "sample string 4",
"ShipmentServiceType": "sample string 5",
"ShipFromWarehouse": "sample string 6",
"ShipmentPackages": [
{
"PackageNumber": 1,
"ShipDate": "2025-01-18T05:00:17.101323+00:00",
"TrackingNumber": "sample string 3",
"TrackingNumber2": "sample string 4",
"Weight": 5.0,
"WeightUOM": "sample string 6",
"Length": 7.0,
"Width": 8.0,
"Height": 9.0,
"DimUOM": "sample string 10",
"ShipVia": "sample string 11",
"ShipmentItems": [
{
"ClientName": "sample string 1",
"ItemCode": "sample string 2",
"Quantity": 3,
"QuantityUoM": "sample string 4",
"LineNumber": 5,
"LotNumber": "sample string 6",
"BarCodeNumber": "sample string 7",
"SerialNumber": "sample string 8",
"PackageNumber": 9
},
{
"ClientName": "sample string 1",
"ItemCode": "sample string 2",
"Quantity": 3,
"QuantityUoM": "sample string 4",
"LineNumber": 5,
"LotNumber": "sample string 6",
"BarCodeNumber": "sample string 7",
"SerialNumber": "sample string 8",
"PackageNumber": 9
}
]
},
{
"PackageNumber": 1,
"ShipDate": "2025-01-18T05:00:17.101323+00:00",
"TrackingNumber": "sample string 3",
"TrackingNumber2": "sample string 4",
"Weight": 5.0,
"WeightUOM": "sample string 6",
"Length": 7.0,
"Width": 8.0,
"Height": 9.0,
"DimUOM": "sample string 10",
"ShipVia": "sample string 11",
"ShipmentItems": [
{
"ClientName": "sample string 1",
"ItemCode": "sample string 2",
"Quantity": 3,
"QuantityUoM": "sample string 4",
"LineNumber": 5,
"LotNumber": "sample string 6",
"BarCodeNumber": "sample string 7",
"SerialNumber": "sample string 8",
"PackageNumber": 9
},
{
"ClientName": "sample string 1",
"ItemCode": "sample string 2",
"Quantity": 3,
"QuantityUoM": "sample string 4",
"LineNumber": 5,
"LotNumber": "sample string 6",
"BarCodeNumber": "sample string 7",
"SerialNumber": "sample string 8",
"PackageNumber": 9
}
]
}
]
}
application/xml, text/xml
Sample:
<ShipmentWebhook xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ClientName>sample string 1</ClientName>
<OrderNumber>sample string 2</OrderNumber>
<VisibleShipmentNumber>sample string 3</VisibleShipmentNumber>
<ShipmentCarrier>sample string 4</ShipmentCarrier>
<ShipmentServiceType>sample string 5</ShipmentServiceType>
<ShipFromWarehouse>sample string 6</ShipFromWarehouse>
<ShipmentPackages>
<ShipmentPackageWebhook>
<PackageNumber>1</PackageNumber>
<ShipDate>2025-01-18T05:00:17.101323+00:00</ShipDate>
<TrackingNumber>sample string 3</TrackingNumber>
<TrackingNumber2>sample string 4</TrackingNumber2>
<Weight>5</Weight>
<WeightUOM>sample string 6</WeightUOM>
<Length>7</Length>
<Width>8</Width>
<Height>9</Height>
<DimUOM>sample string 10</DimUOM>
<ShipVia>sample string 11</ShipVia>
<ShipmentItems>
<ShipmentItemWebhook>
<ClientName>sample string 1</ClientName>
<ItemCode>sample string 2</ItemCode>
<Quantity>3</Quantity>
<QuantityUoM>sample string 4</QuantityUoM>
<LineNumber>5</LineNumber>
<LotNumber>sample string 6</LotNumber>
<BarCodeNumber>sample string 7</BarCodeNumber>
<SerialNumber>sample string 8</SerialNumber>
<PackageNumber>9</PackageNumber>
</ShipmentItemWebhook>
<ShipmentItemWebhook>
<ClientName>sample string 1</ClientName>
<ItemCode>sample string 2</ItemCode>
<Quantity>3</Quantity>
<QuantityUoM>sample string 4</QuantityUoM>
<LineNumber>5</LineNumber>
<LotNumber>sample string 6</LotNumber>
<BarCodeNumber>sample string 7</BarCodeNumber>
<SerialNumber>sample string 8</SerialNumber>
<PackageNumber>9</PackageNumber>
</ShipmentItemWebhook>
</ShipmentItems>
</ShipmentPackageWebhook>
<ShipmentPackageWebhook>
<PackageNumber>1</PackageNumber>
<ShipDate>2025-01-18T05:00:17.101323+00:00</ShipDate>
<TrackingNumber>sample string 3</TrackingNumber>
<TrackingNumber2>sample string 4</TrackingNumber2>
<Weight>5</Weight>
<WeightUOM>sample string 6</WeightUOM>
<Length>7</Length>
<Width>8</Width>
<Height>9</Height>
<DimUOM>sample string 10</DimUOM>
<ShipVia>sample string 11</ShipVia>
<ShipmentItems>
<ShipmentItemWebhook>
<ClientName>sample string 1</ClientName>
<ItemCode>sample string 2</ItemCode>
<Quantity>3</Quantity>
<QuantityUoM>sample string 4</QuantityUoM>
<LineNumber>5</LineNumber>
<LotNumber>sample string 6</LotNumber>
<BarCodeNumber>sample string 7</BarCodeNumber>
<SerialNumber>sample string 8</SerialNumber>
<PackageNumber>9</PackageNumber>
</ShipmentItemWebhook>
<ShipmentItemWebhook>
<ClientName>sample string 1</ClientName>
<ItemCode>sample string 2</ItemCode>
<Quantity>3</Quantity>
<QuantityUoM>sample string 4</QuantityUoM>
<LineNumber>5</LineNumber>
<LotNumber>sample string 6</LotNumber>
<BarCodeNumber>sample string 7</BarCodeNumber>
<SerialNumber>sample string 8</SerialNumber>
<PackageNumber>9</PackageNumber>
</ShipmentItemWebhook>
</ShipmentItems>
</ShipmentPackageWebhook>
</ShipmentPackages>
</ShipmentWebhook>