Allocate

This function lets you allocate article items to a specific order line.

Please note that there are many ways an allocation could fail. It can fail either entirely or partially. In the response, there is a field called AllocatedNumberOfItemsInThisTransaction which tells you exactly how many items were actually able to be allocated in the call. We recommend that your integration check this value and handle any partial allocations.

Tags: Allocate, AllocateOperation, ByUser, AllocateIdentification, AllocateLocationIdentification, AllocateResponse, AllocateResult, AllocateError, AllocationResult

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

<?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>
    <Allocate xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Operation>
        <OrderId>int</OrderId>
        <OrderLineId>int</OrderLineId>
        <NumberOfItemsToAllocate>decimal</NumberOfItemsToAllocate>
        <AllocatedByUser>
          <UserName>string</UserName>
        </AllocatedByUser>
        <Filter>
          <OriginalArticleItemId>int</OriginalArticleItemId>
          <ArticleItemId>int</ArticleItemId>
          <Location>
            <LocationId>int</LocationId>
            <LocationName>string</LocationName>
          </Location>
        </Filter>
      </Operation>
    </Allocate>
  </soap:Body>
</soap:Envelope>

Request specification

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>
    <AllocateResponse xmlns="http://ongoingsystems.se/Automation">
      <AllocateResult>
        <Errors>
          <AllocateError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or LocationNotFound or GoodsOwnerIsDeleted or OrderStatusWrong or OrderIdNotFound or OrderLineMismatch or OrderLineNotFound or FilterNotSpecified or ErrorWhileSaving or PickedByUserError or CouldNotObtainLock or ArticleKindMismatch</ErrorType>
          </AllocateError>
          <AllocateError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or LocationNotFound or GoodsOwnerIsDeleted or OrderStatusWrong or OrderIdNotFound or OrderLineMismatch or OrderLineNotFound or FilterNotSpecified or ErrorWhileSaving or PickedByUserError or CouldNotObtainLock or ArticleKindMismatch</ErrorType>
          </AllocateError>
        </Errors>
        <Success>boolean</Success>
        <Results>
          <AllocationResult>
            <ArticleItemId>int</ArticleItemId>
            <NumberOfItems>decimal</NumberOfItems>
            <ArticleItemIdCreatedByDivide>int</ArticleItemIdCreatedByDivide>
          </AllocationResult>
          <AllocationResult>
            <ArticleItemId>int</ArticleItemId>
            <NumberOfItems>decimal</NumberOfItems>
            <ArticleItemIdCreatedByDivide>int</ArticleItemIdCreatedByDivide>
          </AllocationResult>
        </Results>
        <AllocatedNumberOfItemsInThisTransaction>decimal</AllocatedNumberOfItemsInThisTransaction>
      </AllocateResult>
    </AllocateResponse>
  </soap:Body>
</soap:Envelope>

Response specification