Read Channels

Retrieves the details of a Channels object that has been previously created.

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

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.

{
	"Channels": {
		"Channel": [{
				"ChannelId": "1",
				"ChannelName": "Channel Name1",
				"Location": "OAK",
				"PriceBook": "Bargains",
				"ChannelType": "eBay",
				"CreatedTime": "01-24-2020 05:01:35",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:05:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56"
			},
			{
				"ChannelId": "2",
				"ChannelName": "Channel Name2",
				"Location": "OAK",
				"PriceBook": "Bargains",
				"ChannelType": "AGILIRON B2C WebStore",
				"CreatedTime": "01-24-2020 05:01:35",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:05:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56"
			}
		]
	}
}

<Channels>
  <Channel>
    <ChannelId>1</ChannelId>
    <ChannelName>Channel Name1</ChannelName>
    <Location>OAK</Location>
    <PriceBook>Bargains</PriceBook>
    <ChannelType>eBay</ChannelType>
    <CreatedTime>01-24-2020 05:01:35</CreatedTime>
    <CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
    <ModifiedTime>01-24-2020 05:05:56</ModifiedTime>
    <ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
  </Channel>
  <Channel>
    <ChannelId>2</ChannelId>
    <ChannelName>Channel Name2</ChannelName>
    <Location>OAK</Location>
    <PriceBook>Bargains</PriceBook>
    <ChannelType>AGILIRON B2C WebStore</ChannelType>
    <CreatedTime>01-24-2020 05:01:35</CreatedTime>
    <CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
    <ModifiedTime>01-24-2020 05:05:56</ModifiedTime>
    <ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
  </Channel>
<Channels>

WADL

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