GetPalletItemsByQuery
When a warehouse picks an order, they can choose to pack the items into pallet items. This API call allows you to get information about specific pallet items.
Tags: GetPalletItemsByQuery, GetPalletItemsQuery, SpecialFiltersGetPalletItems, GetPalletItemsByQueryResponse, GetPalletItemsResult, PalletItemInfo, PalletTypeInfo, PalletItemStatusInfo, PalletItemLoadStatusInfo, PalletItemAdvanced, PalletItemShipmentInfo, PalletItemOrderInfo, PalletItemLocationInfo
Request XML
POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/GetPalletItemsByQuery"
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPalletItemsByQuery xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query>
<PalletItemIds>
<int>int</int>
<int>int</int>
</PalletItemIds>
<SpecialFilters>
<LoadStatusChangeTimeFrom>dateTime</LoadStatusChangeTimeFrom>
<LoadStatusCode>string</LoadStatusCode>
</SpecialFilters>
<PalletItemLabelId>string</PalletItemLabelId>
<PalletTypeCode>string</PalletTypeCode>
<ParentPalletItemLabelId>string</ParentPalletItemLabelId>
<ParentPalletTypeCode>string</ParentPalletTypeCode>
<PalletItemSerials>
<string>string</string>
<string>string</string>
</PalletItemSerials>
</Query>
</GetPalletItemsByQuery>
</soap:Body>
</soap:Envelope>
Request specification
| GetPalletItemsByQuery |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| Query |
GetPalletItemsQuery |
Req. |
The query object |
| GetPalletItemsQuery |
| PalletItemIds |
int[] |
|
An array of integers |
| SpecialFilters |
SpecialFiltersGetPalletItems |
|
A SpecialFiltersGetPalletItems object |
| PalletItemLabelId |
string |
|
Filter by label id |
| PalletTypeCode |
string |
|
Filter by pallet type code |
| ParentPalletItemLabelId |
string |
|
Filter by parent label id |
| ParentPalletTypeCode |
string |
|
Filter by parent pallet type code |
| PalletItemSerials |
string[] |
|
Filter by serials |
| SpecialFiltersGetPalletItems |
| LoadStatusChangeTimeFrom |
dateTime |
|
Only return pallet items whose load status have changed after this time. |
| LoadStatusCode |
string(100) |
|
Load status code filter |
Response XML
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPalletItemsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
<GetPalletItemsByQueryResult>
<Success>boolean</Success>
<Message>string</Message>
<PalletItems>
<PalletItemInfo>
<Id>int</Id>
<Serial>string</Serial>
<LabelId>string</LabelId>
<ParentPalletItemId>int</ParentPalletItemId>
<Comment>string</Comment>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<PalletType>
<Id>int</Id>
<Code>string</Code>
<Name>string</Name>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
</PalletType>
<Status>
<Id>int</Id>
<Code>string</Code>
<Name>string</Name>
</Status>
<LoadStatus>
<Id>int</Id>
<Code>string</Code>
<Name>string</Name>
</LoadStatus>
<NumberOfItems>decimal</NumberOfItems>
<Advanced>
<PalletItemLocation>
<Id>int</Id>
<Name>string</Name>
</PalletItemLocation>
<OutDate>dateTime</OutDate>
</Advanced>
<Shipment>
<Id>int</Id>
</Shipment>
<Order>
<Id>int</Id>
</Order>
</PalletItemInfo>
<PalletItemInfo>
<Id>int</Id>
<Serial>string</Serial>
<LabelId>string</LabelId>
<ParentPalletItemId>int</ParentPalletItemId>
<Comment>string</Comment>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<PalletType>
<Id>int</Id>
<Code>string</Code>
<Name>string</Name>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
</PalletType>
<Status>
<Id>int</Id>
<Code>string</Code>
<Name>string</Name>
</Status>
<LoadStatus>
<Id>int</Id>
<Code>string</Code>
<Name>string</Name>
</LoadStatus>
<NumberOfItems>decimal</NumberOfItems>
<Advanced>
<PalletItemLocation>
<Id>int</Id>
<Name>string</Name>
</PalletItemLocation>
<OutDate>dateTime</OutDate>
</Advanced>
<Shipment>
<Id>int</Id>
</Shipment>
<Order>
<Id>int</Id>
</Order>
</PalletItemInfo>
</PalletItems>
</GetPalletItemsByQueryResult>
</GetPalletItemsByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
| GetPalletItemsByQueryResponse |
| GetPalletItemsByQueryResult |
GetPalletItemsResult |
|
| GetPalletItemsResult |
| Success |
boolean |
|
| Message |
string |
|
| PalletItems |
PalletItemInfo[] |
|
| PalletItemInfo |
| Id |
int |
Ongoing WMS internal id of the pallet item |
| Serial |
string(100) |
Serial number of the pallet item |
| LabelId |
string(30) |
Label of the pallet item |
| ParentPalletItemId |
int |
If the pallet item has been packed in another pallet item, this will be the id of the parent pallet item |
| Comment |
string(300) |
Comment |
| Weight |
decimal |
Weight |
| Volume |
decimal |
Volume |
| Length |
decimal |
Length |
| Width |
decimal |
Width |
| Height |
decimal |
Volume |
| PalletType |
PalletTypeInfo |
An element of type PalletTypeInfo. |
| Status |
PalletItemStatusInfo |
An object of type PalletItemStatusInfo, giving information about the pallet's current status |
| LoadStatus |
PalletItemLoadStatusInfo |
An element of type PalletItemLoadStatusInfo. |
| NumberOfItems |
decimal |
Number of items |
| Advanced |
PalletItemAdvanced |
Advanced |
| Shipment |
PalletItemShipmentInfo |
If the pallet item is connected to a shipment, this will contain information about that shipment |
| Order |
PalletItemOrderInfo |
If the pallet item is connected to a an order, this will contain information about that order |
| PalletTypeInfo |
| Id |
int |
The id of the pallet type |
| Code |
string(30) |
The code of the pallet type |
| Name |
string(100) |
The name of the pallet type |
| Length |
decimal |
The length of the pallet type |
| Width |
decimal |
The width of the pallet type |
| Height |
decimal |
The height of the pallet type |
| PalletItemStatusInfo |
| Id |
int |
The id of the pallet status |
| Code |
string(100) |
The code of the pallet status |
| Name |
string(100) |
The name of the pallet status |
| PalletItemLoadStatusInfo |
| Id |
int |
The id of the pallet load status |
| Code |
string |
The code of the pallet load status |
| Name |
string |
The name of the pallet load status |
| PalletItemAdvanced |
| PalletItemLocation |
PalletItemLocationInfo |
Location info of the pallet. |
| OutDate |
dateTime |
The time when the pallet item was marked as closed |
| PalletItemShipmentInfo |
| Id |
int |
The id of the shipment |
| PalletItemOrderInfo |
| Id |
int |
The id of the order |
| PalletItemLocationInfo |
| Id |
int |
The id of the pallet location |
| Name |
string |
The name of the pallet location |