GET api/v1/Fulfillment/OrderShipment/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
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 | ||
| ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
| 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-08-14T01:25:17.4373369+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-08-14T01:25:17.4373369+00:00",
"modifiedDateTime": "2025-08-14T01:25:17.4373369+00:00",
"executionTime": 9,
"txID": "sample string 10"
},
{
"id": 1,
"orderShipmentId": 2,
"itemId": 3,
"itemCode": "sample string 4",
"quantity": 5,
"locationName": "sample string 6",
"pickedQuantity": 1,
"pickedDateTime": "2025-08-14T01:25:17.4373369+00:00",
"modifiedDateTime": "2025-08-14T01:25:17.4373369+00:00",
"executionTime": 9,
"txID": "sample string 10"
}
],
"orderShipmentPackages": [
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"deliveryStatus": "sample string 7",
"carrierReceiveDate": "2025-08-14T01:25:17.4373369+00:00",
"transitDays": 9.0,
"deliveryDate": "2025-08-14T01:25:17.4373369+00:00",
"modifiedDateTime": "2025-08-14T01:25:17.4373369+00:00",
"executionTime": 13,
"txID": "sample string 14"
},
{
"id": 1,
"orderShipmentId": 2,
"packageNumber": 3,
"actualShipWeight": 1.0,
"shipCarrier": "sample string 4",
"trackingNumber1": "sample string 5",
"trackingNumber2": "sample string 6",
"deliveryStatus": "sample string 7",
"carrierReceiveDate": "2025-08-14T01:25:17.4373369+00:00",
"transitDays": 9.0,
"deliveryDate": "2025-08-14T01:25:17.4373369+00:00",
"modifiedDateTime": "2025-08-14T01:25:17.4373369+00:00",
"executionTime": 13,
"txID": "sample string 14"
}
],
"modifiedDateTime": "2025-08-14T01:25:17.4373369+00:00",
"executionTime": 18,
"txID": "sample string 19"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.