Product by Category
Search for a product by Category ID.
zapiGetMerchandiseByCategoryId
GET https://{yourdomainname}.zaui.net/zapi/
Request Body
zapiToken*
integer
Token that must be used for a reseller to communicate with the supplier system.
categoryId*
integer
ID of the category.
methodName
string
The method being called.
zapiUserId*
integer
Generated by the supplier system when a new contact is created.
zapiAccountId*
integer
Generated by the supplier system.
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGetMerchandiseByCategoryId</methodName>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage/>
<categoryId>2</categoryId>
<products>
<product>
<pricePreTax>$5.00</pricePreTax>
<productId>6</productId>
<productName>
<![CDATA[Ski Poles]]>
</productName>
<productDescription>
<![CDATA[]]>
</productDescription>
<inventory>-2</inventory>
</product>
</products>
</methodResponse>
</response><request>
<zapiToken></zapiToken>
<zapiAccountId></zapiAccountId>
<zapiUserId></zapiUserId>
<zapiMethod>
<methodName>zapiGetMerchandiseByCategoryId</methodName>
<categoryId></categoryId>
</zapiMethod>
</request>Request
M
a-z, A-Z
7
Top level element
ZapiToken
M
a-z, A-Z, 0-9
40
The generated ZAPI token
ZapiUserId
M
2
Supplied user ID
ZapiMethod
M
0-9
All requests must have a method
MethodName
M
a-z, A-Z, 0-9
Variable
See documentation for options
CategoryID
M
0-9
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.0</zapiVersion>
<error>0</error>
<message>ZAPI Ok</message>
<methodResponse>
<methodName>zapiGetMerchandiseByCategoryId</methodName>
<products>
<product>
<productId></productId>
<productName></productName>
<productDescription></productDescription>
<pricePreTax></pricePreTax>
<priceWithTax></priceWithTax>
</product>
</products>
</methodResponse>
</response>Response
M
a-z, A-Z
Top level element
ZapiVersion
M
0-9
5
Error
M
0-9
2
Message
M
a-z, A-Z, 0-9
Variable
Error message details
Method Response
M
MethodName
M
a-z, A-Z, 0-9
Variable
See documentation for options
Items
M
Element
Variable
Item
Element
Variable
ProductID
M
0-9
Unique for the product
ProductName
M
a-z, A-Z, 0-9
Product name
Product
Description
M
a-z, A-Z, 0-9
Variable
Product description
PricePreTax
M
0-9.0-90-9
Float
Price pre-tax (based on qty of 1)
PriceWithTax
M
0-9.0-90-9
Float
Price with tax (based on qty of 1)
Last updated
Was this helpful?
