Add Product To Channel

Use this operation to add existing Product to Channel object.

Parameters

Body Params
JSON:	json Details of Product needs to be passed as body parameter,it should be in JSON format.
XML:	string Details of Product 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/Channels will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Channels
Channel Name:	string Channel Name Parameter The Channel Name must be passed directly in the URL path and not as a query parameter or request parameter. URL Format: https://xyzcompany.agiliron.net/agiliron/api-40.php/Channels/{ChannelName}?key=APIKEY

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

Channel Name:

string
Channel Name Parameter

The Channel Name must be passed directly in the URL path and not as a query parameter or request parameter.

URL Format:

https://xyzcompany.agiliron.net/agiliron/api-40.php/Channels/{ChannelName}?key=APIKEY

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

{
  "Product": {
   "ProductCode": "ProductCode",
   "Qty": "30"
   }
}

<Product>
<ProductCode>ProductCode</ProductCode>
<Qty>30</Qty>
</Product>

Sample Response

{
    "MCM": {
        "response": {
            "objectType": "Products",
            "syncTime": "2021-06-10 03:23:14"
        },
        "parameters": {
            "results": {
                "message": {
                    "status": "Success",
                    "success_message": {
                        "Message": "Product updated to channel."
                    }
                }
            }
        }
    }
}

<MCM>
  <response>
    <objectType>Products</objectType>
    <syncTime>2021-06-10 03:23:14</syncTime>
  </response>
  <parameters>
    <results>
      <message>
        <status>Success</status>
        <success_message>
          <Message>Product updated to channel.</Message>
        </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="Channels">
       <method name="POST">
         <resource path="{ChannelName}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="ProductCode" type="xsd:string" style="body" required="true"/>
           <param name="Qty" type="xsd:int" style="body"/>
         </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 4 days ago