# Sylius\WishlistApi

Resource &#39;Wishlist&#39; operations.

All URIs are relative to http://localhost, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**syliusWishlistAdminGetWishlists()**](WishlistApi.md#syliusWishlistAdminGetWishlists) | **GET** /api/v2/admin/wishlists | Retrieves the collection of Wishlist resources. |
| [**syliusWishlistShopAddProductToWishlist()**](WishlistApi.md#syliusWishlistShopAddProductToWishlist) | **PATCH** /api/v2/shop/wishlists/{token}/product | Updates the Wishlist resource. |
| [**syliusWishlistShopAddProductVariantToWishlist()**](WishlistApi.md#syliusWishlistShopAddProductVariantToWishlist) | **PATCH** /api/v2/shop/wishlists/{token}/variant | Updates the Wishlist resource. |
| [**syliusWishlistShopCreateWishlist()**](WishlistApi.md#syliusWishlistShopCreateWishlist) | **POST** /api/v2/shop/wishlists | Creates a Wishlist resource. |
| [**syliusWishlistShopGetWishlist()**](WishlistApi.md#syliusWishlistShopGetWishlist) | **GET** /api/v2/shop/wishlists/{token} | Retrieves a Wishlist resource. |
| [**syliusWishlistShopRemoveProductFromWishlist()**](WishlistApi.md#syliusWishlistShopRemoveProductFromWishlist) | **DELETE** /api/v2/shop/wishlists/{token}/products/{productId} | Removes the Wishlist resource. |
| [**syliusWishlistShopRemoveProductVariantFromWishlist()**](WishlistApi.md#syliusWishlistShopRemoveProductVariantFromWishlist) | **DELETE** /api/v2/shop/wishlists/{token}/productVariants/{productVariantId} | Removes the Wishlist resource. |
| [**syliusWishlistShopRemoveWishlist()**](WishlistApi.md#syliusWishlistShopRemoveWishlist) | **DELETE** /api/v2/shop/wishlists/{token} | Removes the Wishlist resource. |


## `syliusWishlistAdminGetWishlists()`

```php
syliusWishlistAdminGetWishlists($page, $items_per_page, $accept_language): \Sylius\Model\SyliusWishlistAdminGetWishlists200Response
```

Retrieves the collection of Wishlist resources.

Retrieves the collection of Wishlist resources.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$page = 1; // int | The collection page number
$items_per_page = 30; // int | The number of items per page
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $result = $apiInstance->syliusWishlistAdminGetWishlists($page, $items_per_page, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistAdminGetWishlists: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **page** | **int**| The collection page number | [optional] [default to 1] |
| **items_per_page** | **int**| The number of items per page | [optional] [default to 30] |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

[**\Sylius\Model\SyliusWishlistAdminGetWishlists200Response**](../Model/SyliusWishlistAdminGetWishlists200Response.md)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/ld+json`, `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusWishlistShopAddProductToWishlist()`

```php
syliusWishlistShopAddProductToWishlist($token, $wishlist_add_product_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch, $accept_language): \Sylius\Model\WishlistJsonld
```

Updates the Wishlist resource.

Updates the Wishlist resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$token = 'token_example'; // string | Wishlist identifier
$wishlist_add_product_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch = new \Sylius\Model\WishlistAddProductToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch(); // \Sylius\Model\WishlistAddProductToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch | The updated Wishlist resource
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $result = $apiInstance->syliusWishlistShopAddProductToWishlist($token, $wishlist_add_product_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistShopAddProductToWishlist: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **token** | **string**| Wishlist identifier | |
| **wishlist_add_product_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch** | [**\Sylius\Model\WishlistAddProductToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch**](../Model/WishlistAddProductToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch.md)| The updated Wishlist resource | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

[**\Sylius\Model\WishlistJsonld**](../Model/WishlistJsonld.md)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: `application/merge-patch+json`
- **Accept**: `application/ld+json`, `application/json`, `application/problem+json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusWishlistShopAddProductVariantToWishlist()`

```php
syliusWishlistShopAddProductVariantToWishlist($token, $wishlist_add_product_variant_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch, $accept_language): \Sylius\Model\WishlistJsonld
```

Updates the Wishlist resource.

Updates the Wishlist resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$token = 'token_example'; // string | Wishlist identifier
$wishlist_add_product_variant_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch = new \Sylius\Model\WishlistAddProductVariantToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch(); // \Sylius\Model\WishlistAddProductVariantToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch | The updated Wishlist resource
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $result = $apiInstance->syliusWishlistShopAddProductVariantToWishlist($token, $wishlist_add_product_variant_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistShopAddProductVariantToWishlist: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **token** | **string**| Wishlist identifier | |
| **wishlist_add_product_variant_to_wishlist_sylius_wishlist_shop_wishlist_add_product_json_merge_patch** | [**\Sylius\Model\WishlistAddProductVariantToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch**](../Model/WishlistAddProductVariantToWishlistSyliusWishlistShopWishlistAddProductJsonMergePatch.md)| The updated Wishlist resource | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

[**\Sylius\Model\WishlistJsonld**](../Model/WishlistJsonld.md)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: `application/merge-patch+json`
- **Accept**: `application/ld+json`, `application/json`, `application/problem+json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusWishlistShopCreateWishlist()`

```php
syliusWishlistShopCreateWishlist($wishlist_create_wishlist_sylius_wishlist_shop_wishlist_create, $accept_language): \Sylius\Model\WishlistJsonld
```

Creates a Wishlist resource.

Creates a Wishlist resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$wishlist_create_wishlist_sylius_wishlist_shop_wishlist_create = new \Sylius\Model\WishlistCreateWishlistSyliusWishlistShopWishlistCreate(); // \Sylius\Model\WishlistCreateWishlistSyliusWishlistShopWishlistCreate | The new Wishlist resource
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $result = $apiInstance->syliusWishlistShopCreateWishlist($wishlist_create_wishlist_sylius_wishlist_shop_wishlist_create, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistShopCreateWishlist: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **wishlist_create_wishlist_sylius_wishlist_shop_wishlist_create** | [**\Sylius\Model\WishlistCreateWishlistSyliusWishlistShopWishlistCreate**](../Model/WishlistCreateWishlistSyliusWishlistShopWishlistCreate.md)| The new Wishlist resource | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

[**\Sylius\Model\WishlistJsonld**](../Model/WishlistJsonld.md)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: `application/ld+json`, `application/json`
- **Accept**: `application/ld+json`, `application/json`, `application/problem+json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusWishlistShopGetWishlist()`

```php
syliusWishlistShopGetWishlist($token, $accept_language): \Sylius\Model\WishlistJsonldSyliusWishlistShopWishlistRead
```

Retrieves a Wishlist resource.

Retrieves a Wishlist resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$token = 'token_example'; // string | Wishlist identifier
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $result = $apiInstance->syliusWishlistShopGetWishlist($token, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistShopGetWishlist: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **token** | **string**| Wishlist identifier | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

[**\Sylius\Model\WishlistJsonldSyliusWishlistShopWishlistRead**](../Model/WishlistJsonldSyliusWishlistShopWishlistRead.md)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/ld+json`, `application/json`, `application/problem+json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusWishlistShopRemoveProductFromWishlist()`

```php
syliusWishlistShopRemoveProductFromWishlist($token, $product_id, $accept_language)
```

Removes the Wishlist resource.

Removes the Wishlist resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$token = 'token_example'; // string | Wishlist identifier
$product_id = 'product_id_example'; // string | Wishlist identifier
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $apiInstance->syliusWishlistShopRemoveProductFromWishlist($token, $product_id, $accept_language);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistShopRemoveProductFromWishlist: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **token** | **string**| Wishlist identifier | |
| **product_id** | **string**| Wishlist identifier | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

void (empty response body)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/ld+json`, `application/problem+json`, `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusWishlistShopRemoveProductVariantFromWishlist()`

```php
syliusWishlistShopRemoveProductVariantFromWishlist($token, $product_variant_id, $accept_language)
```

Removes the Wishlist resource.

Removes the Wishlist resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$token = 'token_example'; // string | Wishlist identifier
$product_variant_id = 'product_variant_id_example'; // string | Wishlist identifier
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $apiInstance->syliusWishlistShopRemoveProductVariantFromWishlist($token, $product_variant_id, $accept_language);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistShopRemoveProductVariantFromWishlist: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **token** | **string**| Wishlist identifier | |
| **product_variant_id** | **string**| Wishlist identifier | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

void (empty response body)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/ld+json`, `application/problem+json`, `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `syliusWishlistShopRemoveWishlist()`

```php
syliusWishlistShopRemoveWishlist($token, $accept_language)
```

Removes the Wishlist resource.

Removes the Wishlist resource.

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JWT
$config = Sylius\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Sylius\Api\WishlistApi(
    // 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
);
$token = 'token_example'; // string | Wishlist identifier
$accept_language = 'accept_language_example'; // string | Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop.

try {
    $apiInstance->syliusWishlistShopRemoveWishlist($token, $accept_language);
} catch (Exception $e) {
    echo 'Exception when calling WishlistApi->syliusWishlistShopRemoveWishlist: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **token** | **string**| Wishlist identifier | |
| **accept_language** | **string**| Locales in this enum are all locales defined in the shop and only enabled ones will work in the given channel in the shop. | [optional] |

### Return type

void (empty response body)

### Authorization

[JWT](../../README.md#JWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/ld+json`, `application/problem+json`, `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
