# Product by Category

## zapiGetMerchandiseByCategoryId

<mark style="color:blue;">`GET`</mark> `https://{yourdomainname}.zaui.net/zapi/`

#### Request Body

| Name                                            | Type    | Description                                                                     |
| ----------------------------------------------- | ------- | ------------------------------------------------------------------------------- |
| zapiToken<mark style="color:red;">\*</mark>     | integer | Token that must be used for a reseller to communicate with the supplier system. |
| categoryId<mark style="color:red;">\*</mark>    | integer | ID of the category.                                                             |
| methodName                                      | string  | The method being called.                                                        |
| zapiUserId<mark style="color:red;">\*</mark>    | integer | Generated by the supplier system when a new contact is created.                 |
| zapiAccountId<mark style="color:red;">\*</mark> | integer | Generated by the supplier system.                                               |

{% tabs %}
{% tab title="200: OK " %}

```xml
<?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>
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Request" %}

```xml
<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiGetMerchandiseByCategoryId</methodName>
		<categoryId></categoryId>
	</zapiMethod>
</request>
```

<table><thead><tr><th align="center">Element</th><th width="150" align="center">M/O/C</th><th width="150" align="center">Format</th><th width="150" align="center">Length</th><th align="center">Details</th></tr></thead><tbody><tr><td align="center"><strong>Request</strong></td><td align="center">M</td><td align="center">a-z, A-Z</td><td align="center">7</td><td align="center">Top level element</td></tr><tr><td align="center"><strong>ZapiToken</strong></td><td align="center">M</td><td align="center">a-z, A-Z, 0-9</td><td align="center">40</td><td align="center">The generated ZAPI token</td></tr><tr><td align="center"><strong>ZapiUserId</strong></td><td align="center">M</td><td align="center"></td><td align="center">2</td><td align="center">Supplied user ID</td></tr><tr><td align="center"><strong>ZapiMethod</strong></td><td align="center">M</td><td align="center">0-9</td><td align="center"></td><td align="center">All requests must have a method</td></tr><tr><td align="center"><strong>MethodName</strong></td><td align="center">M</td><td align="center">a-z, A-Z, 0-9</td><td align="center">Variable</td><td align="center">See documentation for options</td></tr><tr><td align="center"><strong>CategoryID</strong></td><td align="center">M</td><td align="center">0-9</td><td align="center"></td><td align="center"></td></tr></tbody></table>
{% endtab %}

{% tab title="Response" %}

```xml
<?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>
```

<table><thead><tr><th width="172.3951717822972" align="center">Element</th><th width="150" align="center">M/O/C</th><th width="150" align="center">Format</th><th width="200" align="center">Length</th><th align="center">Details</th></tr></thead><tbody><tr><td align="center"><strong>Response</strong></td><td align="center">M</td><td align="center">a-z, A-Z</td><td align="center"></td><td align="center">Top level element</td></tr><tr><td align="center"><strong>ZapiVersion</strong></td><td align="center">M</td><td align="center">0-9</td><td align="center">5</td><td align="center"></td></tr><tr><td align="center"><strong>Error</strong></td><td align="center">M</td><td align="center">0-9</td><td align="center">2</td><td align="center"></td></tr><tr><td align="center"><strong>Message</strong></td><td align="center">M</td><td align="center">a-z, A-Z, 0-9</td><td align="center">Variable</td><td align="center">Error message details</td></tr><tr><td align="center"><strong>Method Response</strong></td><td align="center">M</td><td align="center"></td><td align="center"></td><td align="center"></td></tr><tr><td align="center"><strong>MethodName</strong></td><td align="center">M</td><td align="center">a-z, A-Z, 0-9</td><td align="center">Variable</td><td align="center">See documentation for options</td></tr><tr><td align="center"><strong>Items</strong></td><td align="center">M</td><td align="center">Element</td><td align="center">Variable</td><td align="center"></td></tr><tr><td align="center"><strong>Item</strong></td><td align="center"></td><td align="center">Element</td><td align="center">Variable</td><td align="center"></td></tr><tr><td align="center"><strong>ProductID</strong></td><td align="center">M</td><td align="center">0-9</td><td align="center"></td><td align="center">Unique for the product</td></tr><tr><td align="center"><strong>ProductName</strong></td><td align="center">M</td><td align="center">a-z, A-Z, 0-9</td><td align="center"></td><td align="center">Product name</td></tr><tr><td align="center"><p><strong>Product</strong></p><p><strong>Description</strong></p></td><td align="center">M</td><td align="center">a-z, A-Z, 0-9</td><td align="center">Variable</td><td align="center">Product description</td></tr><tr><td align="center"><strong>PricePreTax</strong></td><td align="center">M</td><td align="center">0-9.0-90-9</td><td align="center">Float</td><td align="center">Price pre-tax (based on qty of 1)</td></tr><tr><td align="center"><strong>PriceWithTax</strong></td><td align="center">M</td><td align="center">0-9.0-90-9</td><td align="center">Float</td><td align="center">Price with tax (based on qty of 1)</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
