# Swagger\Client\CatalogApi All URIs are relative to *https://sellingpartnerapi-na.amazon.com/* Method | HTTP request | Description ------------- | ------------- | ------------- [**getCatalogItem**](CatalogApi.md#getcatalogitem) | **GET** /catalog/v0/items/{asin} | [**listCatalogCategories**](CatalogApi.md#listcatalogcategories) | **GET** /catalog/v0/categories | [**listCatalogItems**](CatalogApi.md#listcatalogitems) | **GET** /catalog/v0/items | # **getCatalogItem** > \Swagger\Client\Models\GetCatalogItemResponse getCatalogItem($marketplace_id, $asin) Returns a specified item and its attributes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. ### Example ```php setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner $config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM $config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM $config->setApiKey("region", 'us-east-1'); //region of MarketPlace country $apiInstance = new Swagger\Client\Api\CatalogApiDeprecated( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. $asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. try { $result = $apiInstance->getCatalogItem($marketplace_id, $asin); print_r($result); } catch (Exception $e) { echo 'Exception when calling CatalogApi->getCatalogItem: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for the item. | **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | ### Return type [**\Swagger\Client\Models\GetCatalogItemResponse**](../Model/GetCatalogItemResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **listCatalogCategories** > \Swagger\Client\Models\ListCatalogCategoriesResponse listCatalogCategories($marketplace_id, $asin, $seller_sku) Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. ### Example ```php setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner $config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM $config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM $config->setApiKey("region", 'us-east-1'); //region of MarketPlace country $apiInstance = new Swagger\Client\Api\CatalogApiDeprecated( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for the item. $asin = "asin_example"; // string | The Amazon Standard Identification Number (ASIN) of the item. $seller_sku = "seller_sku_example"; // string | Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. try { $result = $apiInstance->listCatalogCategories($marketplace_id, $asin, $seller_sku); print_r($result); } catch (Exception $e) { echo 'Exception when calling CatalogApi->listCatalogCategories: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for the item. | **asin** | **string**| The Amazon Standard Identification Number (ASIN) of the item. | [optional] **seller_sku** | **string**| Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | [optional] ### Return type [**\Swagger\Client\Models\ListCatalogCategoriesResponse**](../Model/ListCatalogCategoriesResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **listCatalogItems** > \Swagger\Client\Models\ListCatalogItemsResponse listCatalogItems($marketplace_id, $query, $query_context_id, $seller_sku, $upc, $ean, $isbn, $jan) Returns a list of items and their attributes, based on a search query or item identifiers that you specify. When based on a search query, provide the Query parameter and optionally, the QueryContextId parameter. When based on item identifiers, provide a single appropriate parameter based on the identifier type, and specify the associated item value. MarketplaceId is always required. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. ### Example ```php setAccessToken('Atza|IwEBxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); //access token of Selling Partner $config->setApiKey("accessKey", 'AKIA2xxxxxxxxxxxxx'); // Access Key of IAM $config->setApiKey("secretKey", '94U4Gi81Tpxxxxxxxxxxxxxxx'); // Secret Key of IAM $config->setApiKey("region", 'us-east-1'); //region of MarketPlace country $apiInstance = new Swagger\Client\Api\CatalogApiDeprecated( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $marketplace_id = "marketplace_id_example"; // string | A marketplace identifier. Specifies the marketplace for which items are returned. $query = "query_example"; // string | Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. $query_context_id = "query_context_id_example"; // string | An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. $seller_sku = "seller_sku_example"; // string | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. $upc = "upc_example"; // string | A 12-digit bar code used for retail packaging. $ean = "ean_example"; // string | A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. $isbn = "isbn_example"; // string | The unique commercial book identifier used to identify books internationally. $jan = "jan_example"; // string | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. try { $result = $apiInstance->listCatalogItems($marketplace_id, $query, $query_context_id, $seller_sku, $upc, $ean, $isbn, $jan); print_r($result); } catch (Exception $e) { echo 'Exception when calling CatalogApi->listCatalogItems: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **marketplace_id** | **string**| A marketplace identifier. Specifies the marketplace for which items are returned. | **query** | **string**| Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'. | [optional] **query_context_id** | **string**| An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. | [optional] **seller_sku** | **string**| Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | [optional] **upc** | **string**| A 12-digit bar code used for retail packaging. | [optional] **ean** | **string**| A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. | [optional] **isbn** | **string**| The unique commercial book identifier used to identify books internationally. | [optional] **jan** | **string**| A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | [optional] ### Return type [**\Swagger\Client\Models\ListCatalogItemsResponse**](../Model/ListCatalogItemsResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)