Allocate Inventory

Allocate Inventory

The Allocate Inventory API allows an organization to move inventory to its sub organizations in the following way:

• In both directions – up or down

• From any organization to any child organization

• Using a single value (start values)

• Using ranges (start and end values)

• The case, box, bundle and retail pack numbers depend on the way the cards were initial created in the system using the Process Order API (Not in this documents scope).

Input Parameters:

Name	Required	Definition	Comments
FromEntityName	Y	Format: Alphanumeric, 60 Description: name of org/user/store/terminal
FromEntityType	Y	Format: Alphanumeric, 20 Description:ORGANZATION, STORE, USER or TERMINAL Defines what kind of limit should be updated
EndBoxId	N	Format: Alphanumeric, 20
EndBundleId	N	Format: Alphanumeric, 20
EndCaseId	N	Format: Alphanumeric, 20
EndRetailPackId	Y	Format: Pattern: 12-5-1-1. 1..12digits-1..5digits-1digit-1 digit
RetailPackId	Y	Format: Pattern: 12-5-1-1. 1..12digits-1..5digits-1digit-1 digit Description: Praxell Retail pack identifier
StartBoxId	Y	Format: Alphanumeric, 20
StartBundleId	Y	Format: Alphanumeric, 20
StartCaseId	Y	Format: Alphanumeric, 20
ToEntityName	Y	Format: Alphanumeric, 60 Description: name of org/user/store/terminal ORGANIZATION
ToEntityType	Y	Format: Alphanumeric, 20 Description:ORGANZATION, STORE, USER or TERMINAL Defines what kind of limit should be updated

Output Parameters:

XML Samples

Input XML

<?xml version="1.0" ?>
<PraxellXMLRequest>
  <AuthenticationDetails>
    <UserName>FE_PM_MGR</UserName>
    <UserPassword>1q2w3e4r</UserPassword>
    <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
  <ServiceDetails>
    <ServiceName>AllocateInventory</ServiceName>
    <UniqueRequestId>1211757445</UniqueRequestId>
  </ServiceDetails>
  <Origin>
    <OriginType>ExtAPI</OriginType>
  </Origin>
  <ServiceParams>
    <FromEntityName>FE PM 0001</FromEntityName>
    <FromEntityType>ORGANIZATION</FromEntityType>
    <ToEntityName>FE_MER_01</ToEntityName>
    <ToEntityType>ORGANIZATION</ToEntityType>
    <RetailPackId>38065</RetailPackId>
    <EndRetailPackId>38065</EndRetailPackId>
    <StartCaseId></StartCaseId>
    <EndCaseId></EndCaseId>
    <StartBoxId></StartBoxId>
    <EndBoxId></EndBoxId>
    <StartBundleId></StartBundleId>
    <EndBundleId></EndBundleId>
  </ServiceParams>
</PraxellXMLRequest>

<?xml version="1.0"?>
   <PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>AllocateInventory</ServiceName>
        <SessionId>74038908200828014</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2008-01-20 08:28:47</ServiceDate>
        <ServiceId>74038908200828014</ServiceId>
    </ResponseDetails>
   <ResponseParams>
   </ResponseParams>
</PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>AllocateInventory</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70029</StatusCode>
    <StatusName>Data not found (cardholder not found)</StatusName>
    <StatusDescription>Data not found (cardholder not found)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>