Ongoing WMS logo

Ongoing WMS Developer

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, Query, PalletItemInfo, PalletTypeInfo, PalletItemStatusInfo, PalletItemLoadStatusInfo

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>
      </Query>
    </GetPalletItemsByQuery>
  </soap:Body>
</soap:Envelope>
+

Request specification

GetPalletItemsByQuery
UserName str(50) Req. Your username
Password str(50) Req. Your password
Query object Req. Specifies the query/search criteria
Query
PalletItemIds object An array of integers
> int int Ongoing WMS internal id of a pallet item

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
          </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>
          </PalletItemInfo>
        </PalletItems>
      </GetPalletItemsByQueryResult>
    </GetPalletItemsByQueryResponse>
  </soap:Body>
</soap:Envelope>
+

Response specification

PalletItemInfo
Id int Ongoing WMS internal id of the pallet item
Serial str(100) Serial number of the pallet item
LabelId str(30) Label of the pallet item
Length dec Length
ParentPalletItemId int If the pallet item has been packed in another pallet item, this will be the id of the parent pallet item
Comment str(300) Comment
Weight dec Weight
Volume dec Volume
Length dec Length
Width dec Width
Height dec Volume
PalletType object An object of type PalletTypeInfo, giving information about the pallet type
Status object An object of type PalletItemStatusInfo, giving information about the pallet's current status
PalletType object An object of type PalletItemLoadStatusInfo, giving information about the pallet's current load status
Specification
Id int The id of the pallet type
Code str(30) The code of the pallet type
Name str(100) The name of the pallet type
Length dec The length of the pallet type
Width dec The width of the pallet type
Height dec The height of the pallet type
Specification
Id int The id of the pallet status
Code str(100) The code of the pallet status
Name str(100) The name of the pallet status
Specification
Id int The id of the pallet load status
Code str The code of the pallet load status
Name str The name of the pallet load status