Ongoing WMS logo

Ongoing WMS Developer

PalletItemComplete

This function allows you to set a pallet item as completed. It is also possible to have custom functionality like printing labels or similar when calling this function.

This might be used in combination with the Pack operation when packing an order.

Tags: CreateOrderPalletItem, Operation, CompletedByUser, PalletItemCompleteResult, PalletItemCompleteError

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/PalletItemComplete"

<?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>
       <PalletItemComplete xmlns="http://ongoingsystems.se/Automation">
          <UserName>string</UserName>
          <Password>string</Password>
          <Operation>
             <PalletItemId>int</PalletItemId>
             <NewPalletItem>
                <OrderId>int</OrderId>
                <PalletType>
                   <PalletTypeCode>string</PalletTypeCode>
                   <PalletTypeName>string</PalletTypeName>
                   <PalletTypeId>int</PalletTypeId>
                   <Identification>PalletTypeId or PalletTypeCode</Identification>
                </PalletType>
                <LabelId>string</LabelId>
                <Serial>string</Serial>
                <Comment>string</Comment>
                <Weight>decimal</Weight>
                <Volume>decimal</Volume>
                <Length>decimal</Length>
                <Width>decimal</Width>
                <Height>decimal</Height>
                <LoadMeters>decimal</LoadMeters>
                <ParentPalletItemId>int</ParentPalletItemId>
                <TransportAdministrationType>None or Return or Delivery</TransportAdministrationType>
             </NewPalletItem>
             <PackItems>
                <PackOperation>
                   <OrderId>int</OrderId>
                   <ArticleDefId>int</ArticleDefId>
                   <NumberOfItemsToPack>decimal</NumberOfItemsToPack>
                   <PackedByUser xsi:nil="true" />
                   <PalletItemId>int</PalletItemId>
                   <OriginalArticleItemId>int</OriginalArticleItemId>
                   <Location>string</Location>
                   <OrderLineId>int</OrderLineId>
                   <AllowPackingLessThanNumberOfItemsToPack>boolean</AllowPackingLessThanNumberOfItemsToPack>
                   <Batch>string</Batch>
                </PackOperation>
                <PackOperation>
                   <OrderId>int</OrderId>
                   <ArticleDefId>int</ArticleDefId>
                   <NumberOfItemsToPack>decimal</NumberOfItemsToPack>
                   <PackedByUser xsi:nil="true" />
                   <PalletItemId>int</PalletItemId>
                   <OriginalArticleItemId>int</OriginalArticleItemId>
                   <Location>string</Location>
                   <OrderLineId>int</OrderLineId>
                   <AllowPackingLessThanNumberOfItemsToPack>boolean</AllowPackingLessThanNumberOfItemsToPack>
                   <Batch>string</Batch>
                </PackOperation>
             </PackItems>
             <CompletedByUser>
                <UserName>string</UserName>
             </CompletedByUser>
             <ComputerName>string</ComputerName>
          </Operation>
       </PalletItemComplete>
    </soap:Body>
</soap:Envelope>
+

Request specification

PalletItemComplete
UserName str(50) Req. Your username
Password str(50) Req. Your password
Operation object Req. An element of type Operation.
Operation
PalletItemId int Req. The pallet item id of the pallet item to complete.
NewPalletItem object Optional An element of type CreateOrderPalletItem
PackItems object Optional Contains eleemts of type Pack
CompletedByUser object Req. An element of type CompletedByUser.
ComputerName str(100) Optional Name of a computer defined in the system. Used when deciding which printer to print on.
CompletedByUser
UserName str(50) Req. The name of the user. Must be an actual user in Ongoing WMS. Pallet item will be marked as updated by this user.

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>
        <PalletItemCompleteResponse xmlns="http://ongoingsystems.se/Automation">
            <PalletItemCompleteResult>
                <Success>boolean</Success>
                <Errors>
                    <PalletItemCompleteError>
                        <Message>string</Message>
                        <ErrorType>UnknownError or LogonError or UserDoesNotExist or PalletItemIdDoesNotExist</ErrorType>
                    </PalletItemCompleteError>
                    <PalletItemCompleteError>
                        <Message>string</Message>
                        <ErrorType>UnknownError or LogonError or UserDoesNotExist or PalletItemIdDoesNotExist</ErrorType>
                    </PalletItemCompleteError>
                </Errors>
            </PalletItemCompleteResult>
        </PalletItemCompleteResponse>
    </soap:Body>
</soap:Envelope>
+

Response specification

PalletItemCompleteResult
Success bool True if successful, false otherwise.
Errors object A list of PalletItemCompleteError objects
PalletItemCompleteError
Message str(*) Message explaining the error.
ErrorType string The type of error:
- UnknownError
- LogonError
- UserDoesNotExist
- PalletItemIdDoesNotExist