Add Package

Use this operation to add new Package object.

Parameters

Body Params

JSON:

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

XML:

string Package 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/Package

** will change to **

https://xyzcompany.agiliron.net/agiliron/api-40.php/Package

**

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.

{
    "Packages": {
        "Package": {
            "OrderNo": "2037",
            "PackageNo": "8",
            "Length": "20.00",
            "Width": "10.00",
            "Height": "21.00",
            "Weight": "25.00",
            "PackageLineItems": {
                "PackageLineItem": [
                    {
                        "LineItemId": "25",
                        "ProductId": "499",
                        "ProductName": "ECG Electrodes",
                        "ProductCode": "415",
                        "Quantity": "1"
                    },
                    {
                        "LineItemId": "25",
                        "ProductId": "499",
                        "ProductName": "ECG Electrodes",
                        "ProductCode": "415",
                        "Quantity": "1"
                    }
                ]
            }
        },
        "TotalRecords": "1",
        "CurrentPage": "1",
        "TotalPages": "1",
        "PageSize": "50"
    }
}
<Packages>
    <Package>
        <OrderNo>2037</OrderNo>
        <PackageNo>8</PackageNo>
        <Length>20.00</Length>
        <Width>10.00</Width>
        <Height>21.00</Height>
        <Weight>25.00</Weight>
        <PackageLineItems>
            <PackageLineItem>
                <LineItemId>25</LineItemId>
                <ProductId>499</ProductId>
                <ProductName>ECG Electrodes</ProductName>
                <ProductCode>415</ProductCode>
                <Quantity>1</Quantity>
            </PackageLineItem>
            <PackageLineItem>
                <LineItemId>25</LineItemId>
                <ProductId>499</ProductId>
                <ProductName>ECG Electrodes</ProductName>
                <ProductCode>415</ProductCode>
                <Quantity>1</Quantity>
            </PackageLineItem>
        </PackageLineItems>
    </Package>
    <TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</Packages>

Sample Response

{
    "MCM": {
        "response": {
            "objectType": "Products",
            "syncTime": "2025-09-04 07:36:35"
        },
        "parameters": {
            "results": {
                "message": {
                    "status": "Success",
                    "success_message": {
                        "order_no": "2037",
                        "package_no": "15"
                    }
                }
            }
        }
    }
}
<MCM>
    <response>
        <objectType>Products</objectType>
        <syncTime>2025-09-04 07:36:35</syncTime>
    </response>
    <parameters>
        <results>
            <message>
                <status>Success</status>
                <success_message>
                    <order_no>2037</order_no>
                    <package_no>15</package_no>
                </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="Package">
       <method name="POST">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="OrderNo" type="xsd:int" style="body" required="true"/>
           <param name="PackageNo" type="xsd:int" style="body" required="true"/>
           <param name="Length" type="xsd:decimal" style="body"/>
           <param name="Width" type="xsd:decimal" style="body"/>
           <param name="Height" type="xsd:decimal" style="body"/>
           <param name="Weight" type="xsd:decimal" style="body"/>
           <param name="PackageLineItems">
            <param name="LineItemId" type="xsd:int" style="body" />
            <param name="ProductId" type="xsd:int" style="body" required="true"/>
            <param name="ProductName" type="xsd:string" style="body" />
            <param name="ProductCode" type="xsd:string" style="body" />
            <param name="Quantity" type="xsd:int" 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>

© Copyright 2022 Agiliron - All Rights Reserved.