API ReferenceGuides
Guides
Home
Start typing to search…

Update Receiving

Use this operation to receive existing PurchaseOrder/SalesReturn object.

Parameters

Body Params

JSON:

json
Receiving details needs to be passed as body parameter,it should be in JSON format.

XML:

string
Receiving details needs to be passed as body parameter,it should be in XML format.

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/Receiving will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Receiving

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
NOTE: For Receiving ,

  • If OrderDetails not passed in XML/JSON the order will be marked as fully received, for partial receiving use OrderDetails in XML/JSON.
  • In case of partial receiving if any errors found in OrderDetails the order line items above that line item in which error is encountered will get received as per there mentioned receiving quantity.
  • ProductsQuantityReceived will be current receiving quantity which user needs to receive.
{
    "Receiving": {
        "ReceivedDate": "01-24-2020",
        "OrderNo": "2922",
        "ShippingCarrier": "USPS",
        "ShippingMethod": "Priority Mail 2-Day Flat",
        "TrackingNumber": "AZ_UPS-1111343",
        "ShippingCost": "10.00",
        "DeliverTo": "OAK",
        "InvoiceNo": "239823",
        "OrderDetails": {
            "OD": [
                {
                    "ProductCode": "TNP1",
                    "ProductsQuantityReceived": "3",
                    "OrderLineNo": "0",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                },
                {
                    "ProductCode": "TNP2",
                    "ProductsQuantityReceived": "3",
                    "OrderLineNo": "1",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                }
            ]
        }
    }
}
<Receiving>
	<ReceivedDate>01-24-2020</ReceivedDate>
	<OrderNo>2922</OrderNo>
	<ShippingCarrier>USPS</ShippingCarrier>
	<ShippingMethod>Priority Mail 2-Day Flat</ShippingMethod>
	<TrackingNumber>AZ_UPS-1111343</TrackingNumber>
	<ShippingCost>10.00</ShippingCost>
	<DeliverTo>OAK</DeliverTo>
	<InvoiceNo>239823</InvoiceNo>
    <OrderDetails>
      <OD>
        <ProductCode>TNP1</ProductCode>
        <ProductsQuantityReceived>3</ProductsQuantityReceived>
        <OrderLineNo>0</OrderLineNo>
        <ProductNotes>Notes goes here</ProductNotes>
        <BinLocation>BinLocation goes here</BinLocation>
        <LineItemStatus>Created,Received</LineItemStatus>
        <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
      <OD>
        <ProductCode>TNP2</ProductCode>
        <ProductsQuantityReceived>3</ProductsQuantityReceived>
        <OrderLineNo>1</OrderLineNo>
        <ProductNotes>Notes goes here</ProductNotes>
        <BinLocation>BinLocation goes here</BinLocation>
        <LineItemStatus>Created,Received</LineItemStatus>
        <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
    </OrderDetails>
</Receiving>
{
    "Receiving": {
        "ReceivedDate": "01-24-2020",
        "OrderNo": "2922",
        "ShippingCarrier": "USPS",
        "ShippingMethod": "Priority Mail 2-Day Flat",
        "TrackingNumber": "AZ_UPS-1111343",
        "ShippingCost": "10.00",
        "DeliverTo": "OAK",
        "InvoiceNo": "239823",
        "OrderDetails": {
            "OD": [
                {
                    "ProductCode": "TNP1",
                    "ProductsQuantityReceived": "3",
                    "SKUCode": "1230",
                    "OrderLineNo": "0",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                },
                {
                    "ProductCode": "TNP2",
                    "ProductsQuantityReceived": "3",
                    "SKUCode": "1231",
                    "OrderLineNo": "1",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                }
            ]
        }
    }
}
<Receiving>
	<ReceivedDate>01-24-2020</ReceivedDate>
	<OrderNo>2922</OrderNo>
	<ShippingCarrier>USPS</ShippingCarrier>
	<ShippingMethod>Priority Mail 2-Day Flat</ShippingMethod>
	<TrackingNumber>AZ_UPS-1111343</TrackingNumber>
	<ShippingCost>10.00</ShippingCost>
	<DeliverTo>OAK</DeliverTo>
	<InvoiceNo>239823</InvoiceNo>
    <OrderDetails>
      <OD>
        <ProductCode>TNP1</ProductCode>
        <ProductsQuantityReceived>3</ProductsQuantityReceived>
        <SKUCode>1230</SKUCode>
        <OrderLineNo>0</OrderLineNo>
        <ProductNotes>Notes goes here</ProductNotes>
        <BinLocation>BinLocation goes here</BinLocation>
        <LineItemStatus>Created,Received</LineItemStatus>
        <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
      <OD>
        <ProductCode>TNP2</ProductCode>
        <ProductsQuantityReceived>3</ProductsQuantityReceived>
        <SKUCode>1231</SKUCode>
        <OrderLineNo>1</OrderLineNo>
        <ProductNotes>Notes goes here</ProductNotes>
        <BinLocation>BinLocation goes here</BinLocation>
        <LineItemStatus>Created,Received</LineItemStatus>
        <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
    </OrderDetails>
</Receiving>
{
    "Receiving": {
        "ReceivedDate": "01-24-2020",
        "OrderNo": "2922",
        "ShippingCarrier": "USPS",
        "ShippingMethod": "Priority Mail 2-Day Flat",
        "TrackingNumber": "AZ_UPS-1111343",
        "ShippingCost": "10.00",
        "DeliverTo": "OAK",
        "InvoiceNo": "239823",
        "OrderDetails": {
            "OD": [
                {
                    "ProductCode": "TNP1",
                    "ProductsQuantityReceived": "3",
                    "SerialNo": "1111",
                    "OrderLineNo": "0",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                },
                {
                    "ProductCode": "TNP2",
                    "ProductsQuantityReceived": "3",
                    "SerialNo": "2222",
                    "OrderLineNo": "1",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                }
            ]
        }
    }
}
<Receiving>
	<ReceivedDate>01-24-2020</ReceivedDate>
	<OrderNo>2922</OrderNo>
	<ShippingCarrier>USPS</ShippingCarrier>
	<ShippingMethod>Priority Mail 2-Day Flat</ShippingMethod>
	<TrackingNumber>AZ_UPS-1111343</TrackingNumber>
	<ShippingCost>10.00</ShippingCost>
	<DeliverTo>OAK</DeliverTo>
	<InvoiceNo>239823</InvoiceNo>
    <OrderDetails>
      <OD>
        <ProductCode>TNP1</ProductCode>
        <ProductsQuantityReceived>3</ProductsQuantityReceived>
        <SerialNo>1111</SerialNo>
        <OrderLineNo>0</OrderLineNo>
        <ProductNotes>Notes goes here</ProductNotes>
        <BinLocation>BinLocation goes here</BinLocation>
        <LineItemStatus>Created,Received</LineItemStatus>
        <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
      <OD>
        <ProductCode>TNP2</ProductCode>
        <ProductsQuantityReceived>3</ProductsQuantityReceived>
        <SerialNo>2222</SerialNo>
        <OrderLineNo>1</OrderLineNo>
        <ProductNotes>Notes goes here</ProductNotes>
        <BinLocation>BinLocation goes here</BinLocation>
        <LineItemStatus>Created,Received</LineItemStatus>
        <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
    </OrderDetails>
</Receiving>
{
    "Receiving": {
        "ReceivedDate": "01-24-2020",
        "OrderNo": "2922",
        "ShippingCarrier": "USPS",
        "ShippingMethod": "Priority Mail 2-Day Flat",
        "TrackingNumber": "AZ_UPS-1111343",
        "ShippingCost": "10.00",
        "DeliverTo": "OAK",
        "InvoiceNo": "239823",
        "OrderDetails": {
            "OD": [
                {
                    "ProductCode": "TNP1",
                    "ProductsQuantityReceived": "3",
                    "ProductLots": {
                        "ProductLot": [
                            {
                                "LotExpiry": "01-24-2020",
                                "LotNo": "4321",
                                "LotQty": "1"
                            },
                            {
                                "LotExpiry": "01-25-2020",
                                "LotNo": "4322",
                                "LotQty": "2"
                            }
                        ]
                    },
                    "OrderLineNo": "0",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                },
                {
                    "ProductCode": "TNP2",
                    "ProductsQuantityReceived": "3",
                    "ProductLots": {
                        "ProductLot": [
                            {
                                "LotExpiry": "01-24-2020",
                                "LotNo": "4323",
                                "LotQty": "1"
                            },
                            {
                                "LotExpiry": "01-25-2020",
                                "LotNo": "4324",
                                "LotQty": "2"
                            }
                        ]
                    },
                    "OrderLineNo": "1",
                    "ProductNotes": "Notes goes here",
                    "BinLocation": "BinLocation goes here",
                    "LineItemStatus": "Created,Received",
                    "LineItemBinLocation": "BinLocation-A:2,BinLocation-B:1"
                }
            ]
        }
    }
}
<Receiving>
   <ReceivedDate>01-24-2020</ReceivedDate>
   <OrderNo>2922</OrderNo>
   <ShippingCarrier>USPS</ShippingCarrier>
   <ShippingMethod>Priority Mail 2-Day Flat</ShippingMethod>
   <TrackingNumber>AZ_UPS-1111343</TrackingNumber>
   <ShippingCost>10.00</ShippingCost>
   <DeliverTo>OAK</DeliverTo>
   <InvoiceNo>239823</InvoiceNo>
   <OrderDetails>
      <OD>
         <ProductCode>TNP1</ProductCode>
         <ProductsQuantityReceived>3</ProductsQuantityReceived>
         <ProductLots>
            <ProductLot>
               <LotExpiry>01-24-2020</LotExpiry>
               <LotNo>4321</LotNo>
               <LotQty>1</LotQty>
            </ProductLot>
            <ProductLot>
               <LotExpiry>01-24-2020</LotExpiry>
               <LotNo>4322</LotNo>
               <LotQty>2</LotQty>
            </ProductLot>
         </ProductLots>
         <OrderLineNo>0</OrderLineNo>
         <ProductNotes>Notes goes here</ProductNotes>
         <BinLocation>BinLocation goes here</BinLocation>
         <LineItemStatus>Created,Received</LineItemStatus>
         <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
      <OD>
         <ProductCode>TNP2</ProductCode>
         <ProductsQuantityReceived>3</ProductsQuantityReceived>
         <ProductLots>
            <ProductLot>
               <LotExpiry>01-24-2020</LotExpiry>
               <LotNo>4323</LotNo>
               <LotQty>1</LotQty>
            </ProductLot>
            <ProductLot>
               <LotExpiry>01-24-2020</LotExpiry>
               <LotNo>4324</LotNo>
               <LotQty>2</LotQty>
            </ProductLot>
         </ProductLots>
         <OrderLineNo>1</OrderLineNo>
         <ProductNotes>Notes goes here</ProductNotes>
         <BinLocation>BinLocation goes here</BinLocation>
         <LineItemStatus>Created,Received</LineItemStatus>
         <LineItemBinLocation>BinLocation-A:2,BinLocation-B:1</LineItemBinLocation>
      </OD>
   </OrderDetails>
</Receiving>

Sample Response

{
    "MCM": {
        "response": {
            "objectType": "Receiving",
            "syncTime": "2021-06-10 08:08:57"
        },
        "parameters": {
            "results": {
                "message": {
                    "status": "Success",
                    "success_message": {
                        "order_no": "6448",
                        "order_id": "203066",
                        "warning": {}
                    }
                }
            }
        }
    }
}
<MCM>
  <response>
    <objectType>Receiving</objectType>
    <syncTime>2021-06-10 08:08:57</syncTime>
  </response>
  <parameters>
    <results>
      <message>
        <status>Success</status>
        <success_message>
          <order_id>203066</order_id>
          <order_no>6448</order_no>
          <warning></warning>
        </success_message>
      </message>
    </results>
  </parameters>
</MCM>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="Receiving">
       <method name="PUT">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="ReceivedDate" type="xsd:date" style="body" required="true"/>
           <param name="OrderNo" type="xsd:int" style="body" required="true"/>
           <param name="ShippingCarrier" type="xsd:string"/>
           <param name="ShippingMethod" type="xsd:string" style="body"/>
           <param name="TrackingNumber" type="xsd:string" style="body"/>
           <param name="ShippingCost" type="xsd:decimal" style="body"/>
           <param name="DeliverTo" type="xsd:string" style="body"/>
           <param name="InvoiceNo" type="xsd:string" style="body"/>
           <param name="OrderDetails">
             <param name="ProductCode" type="xsd:string" style="body" required="true"/>
             <param name="ProductsQuantityReceived" type="xsd:int" style="body" required="true"/>
             <param name="OrderLineNo" type="xsd:int" style="body" required="true"/>
             <param name="ProductNotes" type="xsd:string" style="body"/>
             <param name="BinLocation" type="xsd:string" style="body"/>
           </param>
         </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 about 22 hours ago

© Copyright 2022 Agiliron - All Rights Reserved.