IM Transfer (XML)

Owned by Kati Huttunen (Unlicensed)
Last updated: Dec 18, 2020 by Emma Greenwood
11 min read
ElementParentRequiredData TypeDescriptionValid Values
TransactionHeader
Yes


TransactionTypeTransactionHeaderYesVARCHAR(20)This is the type of transaction that is being integrated.Transfer
TransactionClassIDTransactionHeaderNoVARCHAR(50)This is the ID of the inventory transaction class the transaction belongs to. The default transaction class is used, if the value is not provided. 
TransactionIDTransactionHeaderNoVARCHAR(50)This is the transaction number. If a transaction number is passed and this transaction exists we will add the items to the transaction. If the transaction does not exist we will create it. If this is empty we will use the next number.
TransactionStatusNameTransactionHeaderNoVARCHAR(25)This is the status that the transaction should be integrated as. If no status is passed, "New" will be used.New, Released, In Process, Staging, Loading, Shipped, Approved, Ready To Post
FromSiteIDTransactionHeaderYesVARCHAR(20)This is the site ID that the transaction is being sent from.
ToSiteIDTransactionHeaderYesVARCHAR(20)This is the site ID that the transaction is being sent to.
TransactionDateTransactionHeaderYesDATETIMEThis is the date the transaction affects inventory.
TrackingNumberTransactionHeaderNoVARCHAR(50)This is an optional TrackingNumber for the transfer.
ContainerTransactionHeaderNoVARCHAR(50)This is an optional container number for the transfer.
CarrierIDTransactionHeaderNoVARCHAR(50)This is an optional field for carrier which must match a valid carrier setup in the system.
BOLNumberTransactionHeaderNoVARCHAR(50)This is an optional field for BOL number if BOL numbers are being used.
UserIDTransactionHeaderNoVARCHAR(110)This is the user who is completing the transaction. Does not have to be a valid NS user.
CompanyIDTransactionHeaderYesVARCHAR(15)This is the company ID where the transaction is being created.
TransactionDetailTransactionHeaderYes


ItemSortTransactionDetailNoIntegerThis is the sequence of the items on the transaction. If not passed we will sequence them. If a sequence conflict comes up we will override with the new information.
ItemIDTransactionDetailYesVARCHAR(50)This is the item ID for the inventory item being adjusted. This must be a valid Sales/Inventory item type.
TransactionUnitsTransactionDetailNoNUMERIC(18,5)This is the number of units for this line on the transaction. If an item is managed by units only or units and weight this value must be passed.
UnitsUOMIDTransactionDetailNoVARCHAR(10)This is the unit of measure for the units on the transaction. It is required if TransactionUnits is being used.
TransactionWeightTransactionDetailNoNUMERIC(18,5)

This is the weight value for this line on the transaction. If an item is managed by weight only this value must be passed. If an item is managed by units and weight, and no weight value is provided it will be calculated based on the item's unit of measure schedule and conversions per the number of units provided for the line on the transaction. 

Note: For uniform weight items, if the user does not pass the correct weight value per the item's unit of measure schedule, we will automatically fix it to avoid any integration errors. 


WeightUOMIDTransactionDetailNoVARCHAR(10)This is the unit of measure for the weight on the transaction. It is required if TransactionWeight is being used.
LotTransactionDetailNoVARCHAR(50)This is the Production batch (aka: lot number) for this line of the transaction if lots are being managed.
WarehouseLotTransactionDetailNoVARCHAR(50)This is the Warehouse Lot value for this line of the transaction if warehouse lots are being managed.
ToWarehouseLotTransactionDetailNoVARCHAR(50)This is the To Warehouse Lot value for this line of the transaction if warehouse lots are being managed.
OwnerTransactionDetailNoVARCHAR(25)This is the name of the owner assigned to the lot and must be a valid owner name configured in the system. This value will default to the value assigned to the "Default Owner" preference if not provided in the XML.
AttributesTransactionDetailNo


TransactionAttributeListAttributesNo
Child element of Attributes.
TransactionAttributeTransactionAttributeListNo
Child element of TransactionAttributeList.
NameTransactionAttributeNoVARCHAR(25)This is the attribute name associated with the Transfer transaction. 
ValueTransactionAttributeNoVARCHAR(200)This is the attribute value for the associated transaction attribute.
LotAttributeListAttributesNo
Child element of Attributes.
LotAttributeLotAttributeListNo
Child element of LotAttributeList.
ItemIDLotAttributeNoVARCHAR(50)This is the Item ID of the item for the associated production batch (lot) that the attributes are to be assigned to. This must be a valid item that is setup in the inventory items master file and should match the ItemID entered in the TransactionDetail.
LotLotAttributeNoVARCHAR(50)This is the production batch (or "lot") number associated with the item that the attributes are to be assigned to. This can either be a new or existing lot, but should match the Lot entered in the TransactionDetail. 
SiteIDLotAttributeNoVARCHAR(20)This is the Site ID associated with the item and lot that the attributes are to be assigned to.   This value should match the SiteID entered in the TransactionHeader.
OwnerLotAttributeNoVARCHAR(25)This is the name of the owner assigned to the lot.  This must be a valid owner name configured in the system and should match the Owner entered in the TransactionDetail.
AttributesListLotAttributeNo
Child element of LotAttribute.
AttributeAttributesListNo
Child element of AttributesList.
AttributeNameAttributeNoVARCHAR(25)This is the attribute name associated with the production batch (Lot) configured in the Attributes master file for production batches.
AttributeValueAttributeNoVARCHAR(200)This is the attribute value for the associated production batch (lot) attribute.  Valid values are dependent upon what type of attribute the value is associated to.  For List type attributes the value entered must exist as an option in the list, for Date type attributes the value entered must be a valid date and format. 
PalletsTransactionDetailNo


ItemPalletPalletsNo
Child element of Pallets.
ItemIDItemPalletNoVARCHAR(50)This is the Item ID of the item that is associated to the Pallet. This must be a valid item that is setup in the inventory items master file and should match the ItemID entered in the TransactionDetail.
LotItemPalletNoVARCHAR(50)This is the production batch (or "lot") number associated with the item on the Pallet. This can either be a new or existing lot, but should match the Lot entered in the TransactionDetail. 
SiteIDItemPalletNoVARCHAR(20)This is the Site ID associated with the item and lot on the Pallet.   This value should match the SiteID entered in the TransactionHeader.
OwnerItemPalletNoVARCHAR(25)This is the name of the owner assigned to the lot on the Pallet.  This must be a valid owner name configured in the system and should match the Owner entered in the TransactionDetail.
PalletListItemPalletNo
Child element of ItemPallet.
PalletPalletListNo
Child element of PalletList. 
NumberPalletNoVARCHAR(50)This is the Pallet Number assigned to the pallet. 
UnitsPalletNoNUMERIC(18,5)This is the quantity of Units for the item on the pallet. If an item is managed by units only or units and weight this value must be passed.
UnitsUOMIDPalletNoVARCHAR(10)This is the unit of measure for the item's units on the pallet. 
WeightPalletNoNUMERIC(18,5)This is the weight value for the item on the pallet.  If an item is managed by weight only or units and weight this value must be passed.
WeightUOMIDPalletNoVARCHAR(10)This is the unit of measure for the item's weight on the pallet. 
CertificationsTransactionDetailNo


LotCertificationsListCertificationsNo
Child element of Certifications.
LotCertificationLotCertificationsListNo
Child element of LotCertificationsList.
ItemIDLotCertificationNoVARCHAR(50)This is the Item ID of the item that the certifications are to be assigned to. This must be a valid item that is setup in the inventory items master file and should match the ItemID entered in the TransactionDetail.
LotLotCertificationNoVARCHAR(50)This is the production batch (or "lot") number associated with the item that the certifications are to be assigned to. This can either be a new or existing lot, but should match the Lot entered in the TransactionDetail. 
SiteIDLotCertificationNoVARCHAR(20)This is the Site ID associated with the item and lot that the certifications are to be assigned to.   This value should match the SiteID entered in the TransactionHeader.
OwnerLotCertificationNoVARCHAR(25)This is the name of the owner assigned to the lot.  This must be a valid owner name configured in the system and should match the Owner entered in the TransactionDetail.
CertificationsListCertificationsNo
Child element of Certifications.
CertificationCertificationsListNo
Child element of CertificationsList.
CertificationNameCertificationNoVARCHAR(25)This is the certification name associated with the production batch (Lot) configured in the Lot Certifications master file. If no certification is provided "No" is implied.  
CertificationValueCertificationNoVARCHAR(3)This is the certification value for the associated production batch (lot) certificate.  Valid values are "Yes" or "No".  If no value is provided "No" is implied.  Yes or No (not case sensitive)
Example Transfer XML
<TransactionHeader>   
    <TransactionType>Transfer</TransactionType> 
    <TransactionClassID>Default</TransactionClassID>             
    <TransactionID>XFR00005</TransactionID>     
    <TransactionStatusName>New</TransactionStatusName>        
    <FromSiteID>SOUTH</FromSiteID>      
    <ToSiteID>NORTH</ToSiteID>          
    <TransactionDate>2020-01-20</TransactionDate>        
    <TrackingNumber>12345789</TrackingNumber>          
    <Container /> 
    <CarrierID>YellowFreight</CarrierID> 
    <BOLNumber>12345789</BOLNumber>            
    <UserID>Integrated</UserID>
    <CompanyID>XYZ</CompanyID>           
    <TransactionDetail>    
        <ItemSort>1</ItemSort>         
        <ItemID>1234321</ItemID>  
        <TransactionUnits>1.000000</TransactionUnits>
        <UnitsUOMID>CASE</UnitsUOMID>
        <TransactionWeight>10.55000</TransactionWeight>
        <WeightUOMID>LB</WeightUOMID>
        <Lot>18001</Lot> 
        <WarehouseLot>WH1</WarehouseLot>
		<ToWarehouseLot>WH4</ToWarehouseLot>
        <Owner>NLP</Owner>     
    </TransactionDetail>  
 	<Attributes>
        <TransactionAttributeList>
            <TransactionAttribute>
                <Name>My Lookup Attribute</Name>
                <Value>Red</Value>
            </TransactionAttribute>
            <TransactionAttribute>
                <Name>My Text Attribute</Name>
                <Value>425-949-3313</Value>
            </TransactionAttribute>
            <TransactionAttribute>
                <Name>My Date Attribute</Name>
                <Value>2020-01-20</Value>
            </TransactionAttribute>
        </TransactionAttributeList>
        <LotAttributeList>
            <LotAttribute>
                <ItemID>1234321</ItemID>
                <Lot>18001</Lot>
                <SiteID>ABC</SiteID>
                <Owner>NLP</Owner>
                <AttributesList>
                    <Attribute>
                        <AttributeName>My Lot Lookup Attribute</AttributeName>
                        <AttributeValue>Red</AttributeValue>
                    </Attribute>
                    <Attribute>
                        <AttributeName>My Lot Text Attribute</AttributeName>
                        <AttributeValue>425-949-3313</AttributeValue>
                    </Attribute>
                    <Attribute>
                        <AttributeName>My Lot Date Attribute</AttributeName>
                        <AttributeValue>2020-01-20</AttributeValue>
                    </Attribute>
                </AttributesList>
            </LotAttribute>
        </LotAttributeList>
    </Attributes>
    <Pallets>
      <ItemPallet>
         <ItemID>1234321</ItemID>
         <Lot>18001</Lot>
         <SiteID>ABC</SiteID>
         <Owner>NLP</Owner>
         <PalletList>
            <Pallet>
               <Number>12345</Number>
               <Units>2</Units>
               <UnitsUOMID>CASE</UnitsUOMID>
               <Weight>60</Weight>
               <WeightUOMID>LB</WeightUOMID>
            </Pallet>
            <Pallet>
               <Number>23456</Number>
               <Units>2</Units>
               <UnitsUOMID>CASE</UnitsUOMID>
               <Weight>60</Weight>
               <WeightUOMID>LB</WeightUOMID>
            </Pallet>
            <Pallet>
               <Number>34567</Number>
               <Units>1</Units>
               <UnitsUOMID>CASE</UnitsUOMID>
               <Weight>30.55</Weight>
               <WeightUOMID>LB</WeightUOMID>
            </Pallet>
         </PalletList>
      </ItemPallet>
   </Pallets>
   <Certifications>
      <LotCertificationsList>
         <LotCertification>
            <ItemID>1234321</ItemID>
            <Lot>18001</Lot>
            <SiteID>ABC</SiteID>
            <Owner>NLP</Owner>
            <CertificationsList>
               <Certification>
                  <CertificationName>MSC</CertificationName>
                  <CertificationValue>Yes</CertificationValue>
               </Certification>
               <Certification>
                  <CertificationName>Kosher</CertificationName>
                  <CertificationValue>No</CertificationValue>
               </Certification>
               <Certification>
                  <CertificationName>Vegan</CertificationName>
                  <CertificationValue><!--The absence of a value implies No --></CertificationValue>
               </Certification>
               <!--   The absence of a whole certification implies No          
               <Certification>
                  <CertificationName>Peanut</CertificationName>
                  <CertificationValue>No</CertificationValue>
               </Certification>
               -->
            </CertificationsList>
         </LotCertification>
      </LotCertificationsList>
   </Certifications>
</TransactionHeader>