Add Product to Pricebook
Use this operation to add an existing Product object to a Pricebook.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"ProductPricebooks": {
"ProductPricebook": [
{
"ProductCode": "ProductCode1",
"PriceBook": "Retail PriceBook",
"Price": "20.00"
},
{
"ProductCode": "ProductCode1",
"PriceBook": "Specials PriceBook",
"Price": "30.00"
},
{
"ProductCode": "ProductCode1",
"PriceBook": "Volume PriceBook",
"Price": "1:20.00;11:30.00;15:60.00"
}
]
}
}
<ProductPricebooks>
<ProductPricebook>
<ProductCode>ProductCode1</ProductCode>
<PriceBook>Retail PriceBook</PriceBook>
<Price>20.00</Price>
</ProductPricebook>
<ProductPricebook>
<ProductCode>ProductCode1</ProductCode>
<PriceBook>Specials PriceBook</PriceBook>
<Price>30.00</Price>
</ProductPricebook>
<ProductPricebook>
<ProductCode>ProductCode1</ProductCode>
<PriceBook>Volume PriceBook</PriceBook>
<Price>1:20.00;11:30.00;15:60.00</Price>
</ProductPricebook>
</ProductPricebooks>
{
"ProductPricebooks": {
"ProductPricebook": [
{
"ProductCode": "ProductCode1",
"PriceBook": "Retail PriceBook",
"Price": "20.00",
"PricebookMatrixItems": {
"PricebookMatrixItem": [
{
"PricebookMatrixSKUCode": "563245",
"PricebookMatrixPrice": "20.00"
},
{
"PricebookMatrixSKUCode": "563246",
"PricebookMatrixPrice": "20.00"
}
]
}
},
{
"ProductCode": "ProductCode1",
"PriceBook": "Specials PriceBook",
"Price": "30.00",
"PricebookMatrixItems": {
"PricebookMatrixItem": [
{
"PricebookMatrixSKUCode": "563245",
"PricebookMatrixPrice": "30.00"
},
{
"PricebookMatrixSKUCode": "563246",
"PricebookMatrixPrice": "30.00"
}
]
}
},
{
"ProductCode": "ProductCode1",
"PriceBook": "Volume PriceBook",
"Price": "1:20.00;11:30.00;15:60.00",
"PricebookMatrixItems": {
"PricebookMatrixItem": [
{
"PricebookMatrixSKUCode": "563245",
"PricebookMatrixPrice": "1:20.00;11:30.00;15:60.00"
},
{
"PricebookMatrixSKUCode": "563246",
"PricebookMatrixPrice": "1:20.00;11:30.00;15:60.00"
}
]
}
}
]
}
}
<ProductPricebooks>
<ProductPricebook>
<ProductCode>ProductCode1</ProductCode>
<PriceBook>Retail PriceBook</PriceBook>
<Price>20.00</Price>
<PricebookMatrixItems>
<PricebookMatrixItem>
<PricebookMatrixSKUCode>563245</PricebookMatrixSKUCode>
<PricebookMatrixPrice>20.00</PricebookMatrixPrice>
</PricebookMatrixItem>
<PricebookMatrixItem>
<PricebookMatrixSKUCode>563246</PricebookMatrixSKUCode>
<PricebookMatrixPrice>20.00</PricebookMatrixPrice>
</PricebookMatrixItem>
</PricebookMatrixItems>
</ProductPricebook>
<ProductPricebook>
<ProductCode>ProductCode1</ProductCode>
<PriceBook>Specials PriceBook</PriceBook>
<Price>30.00</Price>
<PricebookMatrixItems>
<PricebookMatrixItem>
<PricebookMatrixSKUCode>563245</PricebookMatrixSKUCode>
<PricebookMatrixPrice>30.00</PricebookMatrixPrice>
</PricebookMatrixItem>
<PricebookMatrixItem>
<PricebookMatrixSKUCode>563246</PricebookMatrixSKUCode>
<PricebookMatrixPrice>30.00</PricebookMatrixPrice>
</PricebookMatrixItem>
</PricebookMatrixItems>
</ProductPricebook>
<ProductPricebook>
<ProductCode>ProductCode1</ProductCode>
<PriceBook>Volume PriceBook</PriceBook>
<Price>1:20.00;11:30.00;15:60.00</Price>
<PricebookMatrixItems>
<PricebookMatrixItem>
<PricebookMatrixSKUCode>563245</PricebookMatrixSKUCode>
<PricebookMatrixPrice>1:20.00;11:30.00;15:60.00</PricebookMatrixPrice>
</PricebookMatrixItem>
<PricebookMatrixItem>
<PricebookMatrixSKUCode>563246</PricebookMatrixSKUCode>
<PricebookMatrixPrice>1:20.00;11:30.00;15:60.00</PricebookMatrixPrice>
</PricebookMatrixItem>
</PricebookMatrixItems>
</ProductPricebook>
</ProductPricebooks>
Sample Response
{
"MCM": {
"response": {
"objectType": "Products",
"syncTime": "2021-06-11 05:31:14"
},
"parameters": {
"results": {
"message": {
"ProductsPriceBook": {
"SuccessNumber": 3,
"FailureNumber": 0
}
}
}
}
}
}
<MCM>
<response>
<objectType>Products</objectType>
<syncTime>2021-06-11 05:31:14</syncTime>
</response>
<parameters>
<results>
<message>
<ProductsPriceBook>
<SuccessNumber>3</SuccessNumber>
<FailureNumber>0</FailureNumber>
</ProductsPriceBook>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="ProductsPriceBook">
<method name="POST">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="ProductCode" type="xsd:string" style="body" required="true"/>
<param name="PriceBook" type="xsd:string" style="body" required="true"/>
<param name="Price" type="xsd:decimal" 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>
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-22/">
<resource path="ProductsPriceBook">
<method name="POST">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="ProductCode" type="xsd:string" style="body" required="true"/>
<param name="PriceBook" type="xsd:string" style="body" required="true"/>
<param name="Price" type="xsd:decimal" style="body"/>
<param name="PricebookMatrixSKUCode" type="xsd:string" style="body"/>
<param name="PricebookMatrixPrice" 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 about 22 hours ago