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: PalletItemComplete, PalletItemCompleteOperation, CreateOrderPalletItemOperation, PackOperation, ByUser, CreateOrderPalletItemPalletTypeOperation, PalletItemCompleteResponse, PalletItemCompleteResult, PalletItemCompleteError, CreateOrderPalletItemResult, PackResult, CreateOrderPalletItemError, CreatedPalletItem, PackError

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>
              <UserName>string</UserName>
            </PackedByUser>
            <PalletItemId>int</PalletItemId>
            <OriginalArticleItemId>int</OriginalArticleItemId>
            <Location>string</Location>
            <OrderLineId>int</OrderLineId>
            <AllowPackingLessThanNumberOfItemsToPack>boolean</AllowPackingLessThanNumberOfItemsToPack>
            <Batch>string</Batch>
            <Comment>string</Comment>
          </PackOperation>
          <PackOperation>
            <OrderId>int</OrderId>
            <ArticleDefId>int</ArticleDefId>
            <NumberOfItemsToPack>decimal</NumberOfItemsToPack>
            <PackedByUser>
              <UserName>string</UserName>
            </PackedByUser>
            <PalletItemId>int</PalletItemId>
            <OriginalArticleItemId>int</OriginalArticleItemId>
            <Location>string</Location>
            <OrderLineId>int</OrderLineId>
            <AllowPackingLessThanNumberOfItemsToPack>boolean</AllowPackingLessThanNumberOfItemsToPack>
            <Batch>string</Batch>
            <Comment>string</Comment>
          </PackOperation>
        </PackItems>
        <CompletedByUser>
          <UserName>string</UserName>
        </CompletedByUser>
        <ComputerName>string</ComputerName>
      </Operation>
    </PalletItemComplete>
  </soap:Body>
</soap:Envelope>

Request specification

PalletItemComplete
UserName string(50) Req. Your username
Password string(50) Req. Your password
Operation PalletItemCompleteOperation Req. The operation object
PalletItemCompleteOperation
PalletItemId int Req. The pallet item id of the pallet item to complete.
NewPalletItem CreateOrderPalletItemOperation An element of type CreateOrderPalletItemOperation.
PackItems PackOperation[] Contains eleemts of type PackOperation
CompletedByUser ByUser Req. An element of type ByUser.
ComputerName string(100) Name of a computer defined in the system. Used when deciding which printer to print on.
CreateOrderPalletItemOperation
OrderId int Req. The order id of the order to connect the pallet item to.
PalletType CreateOrderPalletItemPalletTypeOperation Req. An element of type CreateOrderPalletItemPalletTypeOperation.
LabelId string(30) The pallet item label. Usually SSCC or some other kind of serial number.
Serial string(100) Secondary serial number. It is usually preferred to use LabelId.
Comment string(300) An optional comment.
Weight decimal The weight of the pallet item in kilograms (Kg).
Volume decimal The volume of the pallet item in qubic meters (m3).
Length decimal The Length of the pallet item in meters (m).
Width decimal The Width of the pallet item in meters (m).
Height decimal The Height of the pallet item in meters (m).
LoadMeters decimal The load meters of the pallet item
ParentPalletItemId int The pallet item id of the parent of this pallet item. Can be used for e.g. packages that is being placed on a pallet.
TransportAdministrationType enum Req. Determines if the pallet item is used as a transport administration pallet item that contains package number for shipping purposes:
- None
- Return
- Deliver
PackOperation
OrderId int Req. The order id of the order to pack.
ArticleDefId int Req. The article id of the article to pack.
NumberOfItemsToPack decimal Req. The number of items to pack.
PackedByUser ByUser Req. An element of type ByUser. Designates which user did the packing.
PalletItemId int The pallet item id of a pallet item that the article was packed on/in. Can be used if you want to specify which package an article was packed in.
OriginalArticleItemId int The original article item id of an article item. Used to specify a specific article item to pack. A use case for this is when you want to assign specific serial numbers to an order.
Location string(50) The location to pack from.
OrderLineId int The order line id of an order line. Used if you want to specify which order line to pack. If left empty, Ongoing WMS will match to an order line with the specified article.
AllowPackingLessThanNumberOfItemsToPack boolean Set to false if you want to get an error message if you try to pack more than is allocated to an order. If set to true it will still only pack at most the allocated number of items but no error will be caused. The result will contain the actual number of packed items. True is the default value.
Batch string(50) Filter by batch. If multiple batches of an article are allocated this will specify which batch to pack. Useful when there is need to track which batch is placed in which pallet item.
Comment string
ByUser
UserName string(50) Req. The name of the user. Must be an actual user in Ongoing WMS. Will be set as the user that performed the packing.
CreateOrderPalletItemPalletTypeOperation
PalletTypeCode string
PalletTypeName string
PalletTypeId int
Identification enum An element of type CreateOrderPalletItemPalletTypeIdentification.

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>
    <PalletItemCompleteResponse xmlns="http://ongoingsystems.se/Automation">
      <PalletItemCompleteResult>
        <Success>boolean</Success>
        <Errors>
          <PalletItemCompleteError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or UserDoesNotExist or PalletItemIdDoesNotExist or NoNewPalletItemAndNoPalletItemIdSpecified or BothNewPalletItemAndPalletItemIdSpecified or ErrorCreatingPalletItem or ErrorPackingArticleItem</ErrorType>
          </PalletItemCompleteError>
          <PalletItemCompleteError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or UserDoesNotExist or PalletItemIdDoesNotExist or NoNewPalletItemAndNoPalletItemIdSpecified or BothNewPalletItemAndPalletItemIdSpecified or ErrorCreatingPalletItem or ErrorPackingArticleItem</ErrorType>
          </PalletItemCompleteError>
        </Errors>
        <NewPalletItemResult>
          <Errors>
            <CreateOrderPalletItemError>
              <Message>string</Message>
              <ErrorType>UnknownError or LogonError or GoodsOwnerIsDeleted or OrderIdDoesNotExist or PalletTypeNotFound or ParentPalletItemIdDoesNotExist</ErrorType>
            </CreateOrderPalletItemError>
            <CreateOrderPalletItemError>
              <Message>string</Message>
              <ErrorType>UnknownError or LogonError or GoodsOwnerIsDeleted or OrderIdDoesNotExist or PalletTypeNotFound or ParentPalletItemIdDoesNotExist</ErrorType>
            </CreateOrderPalletItemError>
          </Errors>
          <Success>boolean</Success>
          <CreatedPalletItem>
            <PalletItemId>int</PalletItemId>
            <LabelId>string</LabelId>
            <Serial>string</Serial>
          </CreatedPalletItem>
        </NewPalletItemResult>
        <PackItemsResults>
          <PackResult>
            <Errors>
              <PackError>
                <Message>string</Message>
                <ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleNotOnOrder or GoodsOwnerIsDeleted or OrderIdNotFound or OrderLineIdMissMatch or NumberOfItemsToPackGreaterThanLeftToPackOnOrder or PalletItemIdNotFound or ErrorWhileSaving or PackedByUserError</ErrorType>
              </PackError>
              <PackError>
                <Message>string</Message>
                <ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleNotOnOrder or GoodsOwnerIsDeleted or OrderIdNotFound or OrderLineIdMissMatch or NumberOfItemsToPackGreaterThanLeftToPackOnOrder or PalletItemIdNotFound or ErrorWhileSaving or PackedByUserError</ErrorType>
              </PackError>
            </Errors>
            <Success>boolean</Success>
            <PackedNumberOfItems>decimal</PackedNumberOfItems>
          </PackResult>
          <PackResult>
            <Errors>
              <PackError>
                <Message>string</Message>
                <ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleNotOnOrder or GoodsOwnerIsDeleted or OrderIdNotFound or OrderLineIdMissMatch or NumberOfItemsToPackGreaterThanLeftToPackOnOrder or PalletItemIdNotFound or ErrorWhileSaving or PackedByUserError</ErrorType>
              </PackError>
              <PackError>
                <Message>string</Message>
                <ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleNotOnOrder or GoodsOwnerIsDeleted or OrderIdNotFound or OrderLineIdMissMatch or NumberOfItemsToPackGreaterThanLeftToPackOnOrder or PalletItemIdNotFound or ErrorWhileSaving or PackedByUserError</ErrorType>
              </PackError>
            </Errors>
            <Success>boolean</Success>
            <PackedNumberOfItems>decimal</PackedNumberOfItems>
          </PackResult>
        </PackItemsResults>
      </PalletItemCompleteResult>
    </PalletItemCompleteResponse>
  </soap:Body>
</soap:Envelope>

Response specification

PalletItemCompleteResponse
PalletItemCompleteResult PalletItemCompleteResult
PalletItemCompleteResult
Success boolean True if successful, false otherwise.
Errors PalletItemCompleteError[] A list of PalletItemCompleteError objects
NewPalletItemResult CreateOrderPalletItemResult An element of type CreateOrderPalletItemResult.
PackItemsResults PackResult[]
PalletItemCompleteError
Message string Message explaining the error.
ErrorType enum The type of error:
- UnknownError
- LogonError
- UserDoesNotExist
- PalletItemIdDoesNotExist
CreateOrderPalletItemResult
Errors CreateOrderPalletItemError[] A list of CreateOrderPalletItemError objects
Success boolean True if successful, false otherwise.
CreatedPalletItem CreatedPalletItem An element of type CreatedPalletItem.
PackResult
Errors PackError[]
Success boolean True if successful, false otherwise.
PackedNumberOfItems decimal Confirmation of how many items that were packed.
CreateOrderPalletItemError
Message string Message explaining the error.
ErrorType enum The type of error:
- UnknownError
- LogonError
- GoodsOwnerIsDeleted
- OrderIdDoesNotExist
- PalletTypeNotFound
- ParentPalletItemIdDoesNotExist
CreatedPalletItem
PalletItemId int The internal id of the created pallet item.
LabelId string The label of the created pallet item. Usually SSCC or some other kind of serial number.
Serial string The serial of the pallet item. Usually used as a secondary serial after LabelId
PackError
Message string Message explaining the error.
ErrorType enum The type of error:
  • UnknownError
  • LogonError
  • LocationNotFound
  • ArticleNotFound
  • ArticleNotOnOrder
  • GoodsOwnerIsDeleted
  • OrderIdNotFound
  • OrderLineIdMissMatch
  • NumberOfItemsToPackGreaterThanLeftToPackOnOrder
  • PalletItemIdNotFound
  • ErrorWhileSaving
  • PackedByUserError