Sync Product Pricing or Inventory
Use this operation to sync Product pricing or inventory of an existing Product added to an Channel object.
Parameters
.
Body Params | |
---|---|
JSON: | json If syncType is ProductPricing then Product details needs to be passed as body parameter,it should be in JSON format. If syncType is ProductInventory then no need to pass anything in body parameter |
XML: | string If syncType is ProductPricing then Product details needs to be passed as body parameter,it should be in XML format. If syncType is ProductInventory then no need to pass anything in body parameter |
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/ChannelsSync will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/ChannelsSync |
syncType: | string Sync type need to be passed as parameter for eg. pricing or inventory. |
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. |
{
"PriceBooks": {
"PriceBook": [
"POS",
"test pricebook"
]
}
}
<PriceBooks>
<PriceBook>POS</PriceBook>
<PriceBook>test pricebook</PriceBook>
</PriceBooks>
Sample Response
{
"MCM": {
"response": {
"objectType": "Products",
"syncTime": "2021-06-10 03:23:14"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"Message": "Product Inventory Sync Initiated."
}
}
}
}
}
}
<MCM>
<response>
<objectType>Products</objectType>
<syncTime>2021-06-10 03:23:14</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<Message>Product Inventory Sync Initiated.</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="ChannelsSync">
<method name="POST">
<resource path="{SyncType}">
<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