GET api/v1/Fulfillment/OrderShipmentByNumber/{shortOrderNumber}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| shortOrderNumber | string |
Required |
Body Parameters
Response Information
Resource Description
OrderShipment| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | ||
| OrderId | integer | ||
| ShortOrderNumber | string | ||
| OrderShipmentDate | date | ||
| OrderShipmentPackageNumber | integer | ||
| OrderShipmentStatusId | TOrderStatus | ||
| WarehouseId | integer | ||
| ShipName | string | ||
| ShipAddress1 | string | ||
| ShipAddress2 | string | ||
| ShipAddress3 | string | ||
| ShipCity | string | ||
| ShipState | string | ||
| ShipZip | string | ||
| ShipPhone | string | ||
| Weight | decimal number | ||
| OrderShipmentItems | Collection of OrderShipmentItem | ||
| OrderShipmentPackages | Collection of OrderShipmentPackage | ||
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"orderId": 2,
"shortOrderNumber": "sample string 3",
"orderShipmentDate": "2025-12-19T20:21:43.6284828+00:00",
"orderShipmentPackageNumber": 5,
"orderShipmentStatusId": "Unknown",
"warehouseId": 6,
"shipName": "sample string 7",
"shipAddress1": "sample string 8",
"shipAddress2": "sample string 9",
"shipAddress3": "sample string 10",
"shipCity": "sample string 11",
"shipState": "sample string 12",
"shipZip": "sample string 13",
"shipPhone": "sample string 14",
"weight": 15.0,
"orderShipmentItems": [
{
"id": 1,
"orderShipmentId": 2,
"itemId": 3,
"itemCode": "sample string 4",
"quantity": 5,
"locationName": "sample string 6",
"pickedQuantity": 1,
"pickedDateTime": "2025-12-19T20:21:43.6284828+00:00",
"kitBuildBarcode": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
},
{
"id": 1,
"orderShipmentId": 2,
"itemId": 3,
"itemCode": "sample string 4",
"quantity": 5,
"locationName": "sample string 6",
"pickedQuantity": 1,
"pickedDateTime": "2025-12-19T20:21:43.6284828+00:00",
"kitBuildBarcode": "sample string 7",
"executionTime": 10,
"txID": "sample string 11"
}
],
"orderShipmentPackages": [
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"trackingLink": "sample string 7",
"deliveryStatus": "sample string 8",
"carrierReceiveDate": "2025-12-19T20:21:43.6284828+00:00",
"transitDays": 10.0,
"deliveryDate": "2025-12-19T20:21:43.6284828+00:00",
"executionTime": 14,
"txID": "sample string 15"
},
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"trackingLink": "sample string 7",
"deliveryStatus": "sample string 8",
"carrierReceiveDate": "2025-12-19T20:21:43.6284828+00:00",
"transitDays": 10.0,
"deliveryDate": "2025-12-19T20:21:43.6284828+00:00",
"executionTime": 14,
"txID": "sample string 15"
}
],
"executionTime": 18,
"txID": "sample string 19"
}
application/xml, text/xml
Sample:
<OrderShipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Models">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">18</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 19</TxID>
<Id>1</Id>
<OrderId>2</OrderId>
<OrderShipmentDate>2025-12-19T20:21:43.6284828+00:00</OrderShipmentDate>
<OrderShipmentItems>
<OrderShipmentItem z:Id="i2">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">10</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 11</TxID>
<Id>1</Id>
<ItemCode>sample string 4</ItemCode>
<ItemId>3</ItemId>
<KitBuildBarcode>sample string 7</KitBuildBarcode>
<LocationName>sample string 6</LocationName>
<OrderShipmentId>2</OrderShipmentId>
<PickedDateTime>2025-12-19T20:21:43.6284828+00:00</PickedDateTime>
<PickedQuantity>1</PickedQuantity>
<Quantity>5</Quantity>
</OrderShipmentItem>
<OrderShipmentItem z:Ref="i2" />
</OrderShipmentItems>
<OrderShipmentPackageNumber>5</OrderShipmentPackageNumber>
<OrderShipmentPackages>
<OrderShipmentPackage z:Id="i3">
<ExecutionTime xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">14</ExecutionTime>
<TxID xmlns="http://schemas.datacontract.org/2004/07/TulaERP.Contract.Common">sample string 15</TxID>
<ActualShipWeight>1</ActualShipWeight>
<CarrierReceiveDate>2025-12-19T20:21:43.6284828+00:00</CarrierReceiveDate>
<DeliveryDate>2025-12-19T20:21:43.6284828+00:00</DeliveryDate>
<DeliveryStatus>sample string 8</DeliveryStatus>
<Id>1</Id>
<OrderShipmentId>2</OrderShipmentId>
<PackageNumber>3</PackageNumber>
<ShipCarrier>sample string 4</ShipCarrier>
<TrackingLink>sample string 7</TrackingLink>
<TrackingNumber1>sample string 5</TrackingNumber1>
<TrackingNumber2>sample string 6</TrackingNumber2>
<TransitDays>10</TransitDays>
</OrderShipmentPackage>
<OrderShipmentPackage z:Ref="i3" />
</OrderShipmentPackages>
<OrderShipmentStatusId>Unknown</OrderShipmentStatusId>
<ShipAddress1>sample string 8</ShipAddress1>
<ShipAddress2>sample string 9</ShipAddress2>
<ShipAddress3>sample string 10</ShipAddress3>
<ShipCity>sample string 11</ShipCity>
<ShipName>sample string 7</ShipName>
<ShipPhone>sample string 14</ShipPhone>
<ShipState>sample string 12</ShipState>
<ShipZip>sample string 13</ShipZip>
<ShortOrderNumber>sample string 3</ShortOrderNumber>
<WarehouseId>6</WarehouseId>
<Weight>15</Weight>
</OrderShipment>