API ReferenceGuides
Guides
Home

Read Inventory Adjustment

Retrieves the Inventory Adjustment details of Product object that has been previously created.

Suggest Edits

Parameters

Path Params
yourCompany:string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/InventoryAdjustment will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/InventoryAdjustment
productCode:string
In this parameter unique identification of Product need to be passed to fetch related details.For eg. Product Code, If Inventory Adjustment for Product Code TNP needs to be fetch, then the url will be
https://{your_company}.agiliron.net/agiliron/api-40.php/InventoryAdjustment/TNP

NOTE: For InventoryAdjustment,
ProductCode can be passed in either Path params or in query params using filter.

Query Params
filter:string
In this parameter ProductCode needs to be provided with condition and value
to fetch related details.for eg. ProductCode,eq,TNP

1) To fetch InventoryAdjustment with product code equal to TNP , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/InventoryAdjustment?filter=ProductCode,eq,TNP&key=xyzkey

2) To fetch InventoryAdjustment with AdjustmentDate between 01-15-2020 to 01-31-2020 (Use | between two dates), the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/InventoryAdjustment?filter=AdjustmentDate,bt,01-15-2020 | 01-31-2020&key=xyzkey
page:int
Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch InventoryAdjustment with product code equal to TNP and page equal to 10 , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/InventoryAdjustment?filter=ProductCode,eq,TNP&page=10&key=xyzkey
pageSize:int
In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch InventoryAdjustment with product code equal to TNP and page size equal to 10 , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/InventoryAdjustment?filter=ProductCode,eq,TNP&pageSize=10&key=xyzkey
Header Params
Accept:string
Response header need to be passed for eg. application/json or application/xml.
Query Auth
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.
Header Auth
apiKey:string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code 

{
	"InventoryAdjustments": {
		"InventoryAdjustment": [{
			"ProductCode": "TNP1",
			"StockLocation": "OAK",
			"QtyAdjustment": "5",
			"AdjustmentReason": "Damage",
			"AdjustmentDate": "01-24-2020 05:38:58",
			"AdjustmentDateUTC": "01-24-2020 15:01:35",
			"AdjustmentDescription": "Description Goes Here."
		}],
		"TotalRecords": "1",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}

<InventoryAdjustments>
    <InventoryAdjustment>
        <ProductCode>TNP1</ProductCode>
        <StockLocation>OAK</StockLocation>
        <QtyAdjustment>5</QtyAdjustment>
        <AdjustmentReason>Damage</AdjustmentReason>
        <AdjustmentDate>01-24-2020 05:38:58</AdjustmentDate>
      	<AdjustmentDateUTC>01-24-2020 15:01:35</AdjustmentDateUTC>
        <AdjustmentDescription>Description Goes Here.</AdjustmentDescription>
    </InventoryAdjustment>
  	<TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</InventoryAdjustments>

{
	"InventoryAdjustments": {
		"InventoryAdjustment": [{
			"ProductCode": "TNP1",
			"StockLocation": "OAK",
			"QtyAdjustment": "5",
			"AdjustmentReason": "Damage",
			"AdjustmentDate": "01-24-2020 05:38:58",
			"AdjustmentDateUTC": "01-24-2020 15:01:35",
			"AdjustmentDescription": "Description Goes Here.",
			"SKUStockId": "1232"
		}],
		"TotalRecords": "1",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}

<InventoryAdjustments>
    <InventoryAdjustment>
        <ProductCode>TNP1</ProductCode>
        <StockLocation>OAK</StockLocation>
        <QtyAdjustment>5</QtyAdjustment>
        <AdjustmentReason>Damage</AdjustmentReason>
        <AdjustmentDate>01-24-2020 05:38:58</AdjustmentDate>
      	<AdjustmentDateUTC>01-24-2020 15:01:35</AdjustmentDateUTC>
        <AdjustmentDescription>Description Goes Here.</AdjustmentDescription>
      	<SKUStockId>1232</SKUStockId>
    </InventoryAdjustment>
  	<TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</InventoryAdjustments>

{
	"InventoryAdjustments": {
		"InventoryAdjustment": [{
			"ProductCode": "TNP1",
			"StockLocation": "OAK",
			"QtyAdjustment": "5",
			"AdjustmentReason": "Damage",
			"AdjustmentDate": "01-24-2020 05:38:58",
			"AdjustmentDateUTC": "01-24-2020 15:01:35",
			"AdjustmentDescription": "Description Goes Here.",
			"LotNumber": "4332"
		}],
		"TotalRecords": "1",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}

<InventoryAdjustments>
    <InventoryAdjustment>
        <ProductCode>TNP1</ProductCode>
        <StockLocation>OAK</StockLocation>
        <QtyAdjustment>5</QtyAdjustment>
        <AdjustmentReason>Damage</AdjustmentReason>
        <AdjustmentDate>01-24-2020 05:38:58</AdjustmentDate>
      	<AdjustmentDateUTC>01-24-2020 15:01:35</AdjustmentDateUTC>
        <AdjustmentDescription>Description Goes Here.</AdjustmentDescription>
      	<LotNumber>4332</LotNumber>
    </InventoryAdjustment>
  	<TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</InventoryAdjustments>

{
	"InventoryAdjustments": {
		"InventoryAdjustment": [{
			"ProductCode": "TNP1",
			"StockLocation": "OAK",
			"QtyAdjustment": "5",
			"AdjustmentReason": "Damage",
			"AdjustmentDate": "01-24-2020 05:38:58",
			"AdjustmentDateUTC": "01-24-2020 15:01:35",
			"AdjustmentDescription": "Description Goes Here.",
			"SerialNo": "34312"
		}],
		"TotalRecords": "1",
		"CurrentPage": "1",
		"TotalPages": "1",
		"PageSize": "50"
	}
}

<InventoryAdjustments>
    <InventoryAdjustment>
        <ProductCode>TNP1</ProductCode>
        <StockLocation>OAK</StockLocation>
        <QtyAdjustment>5</QtyAdjustment>
        <AdjustmentReason>Damage</AdjustmentReason>
        <AdjustmentDate>01-24-2020 05:38:58</AdjustmentDate>
      	<AdjustmentDateUTC>01-24-2020 15:01:35</AdjustmentDateUTC>
        <AdjustmentDescription>Description Goes Here.</AdjustmentDescription>
      	<SerialNo>34312</SerialNo>
    </InventoryAdjustment>
  	<TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</InventoryAdjustments>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="ProductsVendorPricebook">
       <method name="GET">
	   <resource path="{ProductCode}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>

Updated over 1 year ago

© Copyright 2022 Agiliron - All Rights Reserved.