API ReferenceGuides
Guides
Home

Read Product BinLocations

Retrieves the details of a Products BinLocation 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/ProductsBinLocations will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/ProductsBinLocations
Query Params
filter:string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. ProductCode,eq,Products Code

1. To fetch Products BinLocations with Product Code equal to Cream and Location equal to OAK, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/ProductsBinLocations?filter=ProductCode,eq,Cream;Location,eq,OAK&key=xyzkeyList of condition abbrevations to be used:
"cs": contain string (string contains value)
"sw": start with (string starts with value)
"ew": end with (string end with value)
"neq": not equal (string or number should not match)
"eq": equal (string or number matches exactly)
"lt": lower than (number is lower than value)
"le": lower or equal (number is lower than or equal to value)
"ge": greater or equal (number is higher than or equal to value)
"gt": greater than (number is higher than value)
"bt": between (number is between two comma separated values)
page:string
In this parameter page number needs to be provided to fetch related page details.For eg. To fetch Product BinLocations with productcode contains abc and page number 3 , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ProductsBinLocations?filter=ProductCode,cs,abc&page=3&key=xyzkey
pageSize:string
In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch Product BinLocations with productcode contains abc and page size 10 , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ProductsBinLocations?filter=ProductCode,cs,abc&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 

{
    "ProductsBinLocations": {
        "ProductsBinLocation": [
            {
                "BinLocationId": "11",
                "ProductCode": "Product-1",
                "ProductName": "Product1",
                "StockLocation": "OAK",
                "BinLocation": "BinLocation A",
                "Quantity": "25",
                "MatrixSKUCode": null,
                "CreatedBy": "admin",
                "CreatedTime": "11-22-2021 11:54:29",
                "ModifiedTime": "11-22-2021 11:54:29"
            },
            {
                "BinLocationId": "12",
                "ProductCode": "Product-1",
                "ProductName": "Product1",
                "StockLocation": "OAK",
                "BinLocation": "BinLocation B",
                "Quantity": "25",
                "MatrixSKUCode": null,
                "CreatedBy": "admin",
                "CreatedTime": "11-22-2021 11:54:29",
                "ModifiedTime": "11-22-2021 11:54:29"
            },
            {
                "BinLocationId": "13",
                "ProductCode": "Product-1",
                "ProductName": "Product1",
                "StockLocation": "OAK",
                "BinLocation": "BinLocation C",
                "Quantity": "25",
                "MatrixSKUCode": null,
                "CreatedBy": "admin",
                "CreatedTime": "11-22-2021 11:54:29",
                "ModifiedTime": "11-22-2021 11:54:29"
            }
        ],
        "TotalRecords": "3",
        "CurrentPage": "1",
        "TotalPages": "1",
        "PageSize": "50"
    }
}

<ProductsBinLocations>
    <ProductsBinLocation>
        <BinLocationId>11</BinLocationId>
        <ProductCode>Product-1</ProductCode>
        <ProductName>Product1</ProductName>
        <StockLocation>OAK</StockLocation>
        <BinLocation>BinLocation A</BinLocation>
        <Quantity>25</Quantity>
        <MatrixSKUCode />
        <CreatedBy>admin</CreatedBy>
        <CreatedTime>11-22-2021 11:54:29</CreatedTime>
        <ModifiedTime>11-22-2021 11:54:29</ModifiedTime>
    </ProductsBinLocation>
    <ProductsBinLocation>
        <BinLocationId>12</BinLocationId>
        <ProductCode>Product-1</ProductCode>
        <ProductName>Product1</ProductName>
        <StockLocation>OAK</StockLocation>
        <BinLocation>BinLocation B</BinLocation>
        <Quantity>25</Quantity>
        <MatrixSKUCode />
        <CreatedBy>admin</CreatedBy>
        <CreatedTime>11-22-2021 11:54:29</CreatedTime>
        <ModifiedTime>11-22-2021 11:54:29</ModifiedTime>
    </ProductsBinLocation>
    <ProductsBinLocation>
        <BinLocationId>13</BinLocationId>
        <ProductCode>Product-1</ProductCode>
        <ProductName>Product1</ProductName>
        <StockLocation>OAK</StockLocation>
        <BinLocation>BinLocation C</BinLocation>
        <Quantity>25</Quantity>
        <MatrixSKUCode />
        <CreatedBy>admin</CreatedBy>
        <CreatedTime>11-22-2021 11:54:29</CreatedTime>
        <ModifiedTime>11-22-2021 11:54:29</ModifiedTime>
    </ProductsBinLocation>
    <TotalRecords>3</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</ProductsBinLocations>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="ProductsBinLocations"> 
       <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 11 days ago