Get the lines for an order history
Endpoint:
GET v1/OrderHistoryLineItem?orderId={orderId}&shipDate={shipDate}&shipViaCode={shipViaCode}&trackingNumber={trackingNumber}&packId={packId}
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderId |
Order Id |
integer |
Default value is -1 |
| shipDate |
Ship Date |
string |
None. |
| shipViaCode |
Ship Via Code |
string |
None. |
| trackingNumber |
Tracking Number |
string |
None. |
| packId |
Pack Id |
integer |
None. |
Body Parameters
None.
Response Information
Collection of OrderShipments| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId | integer |
None. |
|
| ShipViaCode | string |
None. |
|
| ShipViaDescription | string |
None. |
|
| FulfillingDC | string |
None. |
|
| PackId | integer |
None. |
|
| ShipStatus | string |
None. |
|
| TrackingNumber | string |
None. |
|
| TrackingLink | string |
None. |
|
| Parts | integer |
None. |
|
| ShipDate | date |
None. |
|
| EstimatedDeliveryDate | date |
None. |
|
| ActualDeliveryDate | date |
None. |
|
| LineItems | Collection of LineItem |
None. |
Response Examples
application/json, text/json :
[
{
"OrderId": 1,
"ShipViaCode": "sample string 2",
"ShipViaDescription": "sample string 3",
"FulfillingDC": "sample string 4",
"PackId": 5,
"ShipStatus": "sample string 6",
"TrackingNumber": "sample string 7",
"TrackingLink": "sample string 8",
"Parts": 2,
"ShipDate": "2024-09-07T19:24:16.5985059-07:00",
"EstimatedDeliveryDate": "2024-09-07T19:24:16.5985059-07:00",
"ActualDeliveryDate": "2024-09-07T19:24:16.5985059-07:00",
"LineItems": [
{
"PartId": "sample string 4",
"Description": "sample string 5",
"Ordered": 7,
"Shipped": 8,
"LinePrice": 9.0,
"IsCancelled": true
},
{
"PartId": "sample string 4",
"Description": "sample string 5",
"Ordered": 7,
"Shipped": 8,
"LinePrice": 9.0,
"IsCancelled": true
}
]
},
{
"OrderId": 1,
"ShipViaCode": "sample string 2",
"ShipViaDescription": "sample string 3",
"FulfillingDC": "sample string 4",
"PackId": 5,
"ShipStatus": "sample string 6",
"TrackingNumber": "sample string 7",
"TrackingLink": "sample string 8",
"Parts": 2,
"ShipDate": "2024-09-07T19:24:16.5985059-07:00",
"EstimatedDeliveryDate": "2024-09-07T19:24:16.5985059-07:00",
"ActualDeliveryDate": "2024-09-07T19:24:16.5985059-07:00",
"LineItems": [
{
"PartId": "sample string 4",
"Description": "sample string 5",
"Ordered": 7,
"Shipped": 8,
"LinePrice": 9.0,
"IsCancelled": true
},
{
"PartId": "sample string 4",
"Description": "sample string 5",
"Ordered": 7,
"Shipped": 8,
"LinePrice": 9.0,
"IsCancelled": true
}
]
}
]
text/javascript :
[{"OrderId":1,"ShipViaCode":"sample string 2","ShipViaDescription":"sample string 3","FulfillingDC":"sample string 4","PackId":5,"ShipStatus":"sample string 6","TrackingNumber":"sample string 7","TrackingLink":"sample string 8","Parts":2,"ShipDate":"2024-09-07T19:24:16.5985059-07:00","EstimatedDeliveryDate":"2024-09-07T19:24:16.5985059-07:00","ActualDeliveryDate":"2024-09-07T19:24:16.5985059-07:00","LineItems":[{"PartId":"sample string 4","Description":"sample string 5","Ordered":7,"Shipped":8,"LinePrice":9.0,"IsCancelled":true},{"PartId":"sample string 4","Description":"sample string 5","Ordered":7,"Shipped":8,"LinePrice":9.0,"IsCancelled":true}]},{"OrderId":1,"ShipViaCode":"sample string 2","ShipViaDescription":"sample string 3","FulfillingDC":"sample string 4","PackId":5,"ShipStatus":"sample string 6","TrackingNumber":"sample string 7","TrackingLink":"sample string 8","Parts":2,"ShipDate":"2024-09-07T19:24:16.5985059-07:00","EstimatedDeliveryDate":"2024-09-07T19:24:16.5985059-07:00","ActualDeliveryDate":"2024-09-07T19:24:16.5985059-07:00","LineItems":[{"PartId":"sample string 4","Description":"sample string 5","Ordered":7,"Shipped":8,"LinePrice":9.0,"IsCancelled":true},{"PartId":"sample string 4","Description":"sample string 5","Ordered":7,"Shipped":8,"LinePrice":9.0,"IsCancelled":true}]}]
application/xml, text/xml :
<ArrayOfOrderShipments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models.Orders">
<OrderShipments>
<ActualDeliveryDate>2024-09-07T19:24:16.5985059-07:00</ActualDeliveryDate>
<EstimatedDeliveryDate>2024-09-07T19:24:16.5985059-07:00</EstimatedDeliveryDate>
<FulfillingDC>sample string 4</FulfillingDC>
<LineItems>
<LineItem>
<Description>sample string 5</Description>
<IsCancelled>true</IsCancelled>
<LinePrice>9</LinePrice>
<Ordered>7</Ordered>
<PartId>sample string 4</PartId>
<Shipped>8</Shipped>
</LineItem>
<LineItem>
<Description>sample string 5</Description>
<IsCancelled>true</IsCancelled>
<LinePrice>9</LinePrice>
<Ordered>7</Ordered>
<PartId>sample string 4</PartId>
<Shipped>8</Shipped>
</LineItem>
</LineItems>
<OrderId>1</OrderId>
<PackId>5</PackId>
<Parts>2</Parts>
<ShipDate>2024-09-07T19:24:16.5985059-07:00</ShipDate>
<ShipStatus>sample string 6</ShipStatus>
<ShipViaCode>sample string 2</ShipViaCode>
<ShipViaDescription>sample string 3</ShipViaDescription>
<TrackingLink>sample string 8</TrackingLink>
<TrackingNumber>sample string 7</TrackingNumber>
</OrderShipments>
<OrderShipments>
<ActualDeliveryDate>2024-09-07T19:24:16.5985059-07:00</ActualDeliveryDate>
<EstimatedDeliveryDate>2024-09-07T19:24:16.5985059-07:00</EstimatedDeliveryDate>
<FulfillingDC>sample string 4</FulfillingDC>
<LineItems>
<LineItem>
<Description>sample string 5</Description>
<IsCancelled>true</IsCancelled>
<LinePrice>9</LinePrice>
<Ordered>7</Ordered>
<PartId>sample string 4</PartId>
<Shipped>8</Shipped>
</LineItem>
<LineItem>
<Description>sample string 5</Description>
<IsCancelled>true</IsCancelled>
<LinePrice>9</LinePrice>
<Ordered>7</Ordered>
<PartId>sample string 4</PartId>
<Shipped>8</Shipped>
</LineItem>
</LineItems>
<OrderId>1</OrderId>
<PackId>5</PackId>
<Parts>2</Parts>
<ShipDate>2024-09-07T19:24:16.5985059-07:00</ShipDate>
<ShipStatus>sample string 6</ShipStatus>
<ShipViaCode>sample string 2</ShipViaCode>
<ShipViaDescription>sample string 3</ShipViaDescription>
<TrackingLink>sample string 8</TrackingLink>
<TrackingNumber>sample string 7</TrackingNumber>
</OrderShipments>
</ArrayOfOrderShipments>
text/csv :
OrderId,ShipViaCode,ShipViaDescription,FulfillingDC,PackId,ShipStatus,TrackingNumber,TrackingLink,Parts,ShipDate,EstimatedDeliveryDate,ActualDeliveryDate,LineItems 1,sample string 2,sample string 3,sample string 4,5,sample string 6,sample string 7,sample string 8,2,9/7/2024 7:24:16 PM,9/7/2024 7:24:16 PM,9/7/2024 7:24:16 PM,System.Collections.Generic.List`1[Sunlight.Library.Models.Orders.LineItem] 1,sample string 2,sample string 3,sample string 4,5,sample string 6,sample string 7,sample string 8,2,9/7/2024 7:24:16 PM,9/7/2024 7:24:16 PM,9/7/2024 7:24:16 PM,System.Collections.Generic.List`1[Sunlight.Library.Models.Orders.LineItem]
text/tsv :
OrderId ShipViaCode ShipViaDescription FulfillingDC PackId ShipStatus TrackingNumber TrackingLink Parts ShipDate EstimatedDeliveryDate ActualDeliveryDate LineItems 1 sample string 2 sample string 3 sample string 4 5 sample string 6 sample string 7 sample string 8 2 9/7/2024 7:24:16 PM 9/7/2024 7:24:16 PM 9/7/2024 7:24:16 PM System.Collections.Generic.List`1[Sunlight.Library.Models.Orders.LineItem] 1 sample string 2 sample string 3 sample string 4 5 sample string 6 sample string 7 sample string 8 2 9/7/2024 7:24:16 PM 9/7/2024 7:24:16 PM 9/7/2024 7:24:16 PM System.Collections.Generic.List`1[Sunlight.Library.Models.Orders.LineItem]