src/Buy/Deal/V1/docs/Api/EventApi.md
# TNT\Ebay\Buy\Deal\V1\EventApi
All URIs are relative to https://api.ebay.com/buy/deal/v1.
Method | HTTP request | Description
------------- | ------------- | -------------
[**getEvent()**](EventApi.md#getEvent) | **GET** /event/{event_id} |
[**getEvents()**](EventApi.md#getEvents) | **GET** /event |
## `getEvent()`
```php
getEvent($x_ebay_c_marketplace_id, $event_id): \TNT\Ebay\Buy\Deal\V1\Model\Event
```
This method retrieves the details for an eBay event. The result set contains detailed information associated with the specified event ID, such as applicable coupons, start and end dates, and event terms. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: api_auth
$config = TNT\Ebay\Buy\Deal\V1\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new TNT\Ebay\Buy\Deal\V1\Api\EventApi(
// 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
);
$x_ebay_c_marketplace_id = 'x_ebay_c_marketplace_id_example'; // string | A header used to specify the eBay marketplace ID.
$event_id = 'event_id_example'; // string | The unique identifier for the eBay event.
try {
$result = $apiInstance->getEvent($x_ebay_c_marketplace_id, $event_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EventApi->getEvent: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_ebay_c_marketplace_id** | **string**| A header used to specify the eBay marketplace ID. |
**event_id** | **string**| The unique identifier for the eBay event. |
### Return type
[**\TNT\Ebay\Buy\Deal\V1\Model\Event**](../Model/Event.md)
### Authorization
[api_auth](../../README.md#api_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `getEvents()`
```php
getEvents($x_ebay_c_marketplace_id, $limit, $offset): \TNT\Ebay\Buy\Deal\V1\Model\EventSearchResponse
```
This method returns paginated results containing all eBay events for the specified marketplace. Request headers This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide. Restrictions This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions. eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: api_auth
$config = TNT\Ebay\Buy\Deal\V1\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new TNT\Ebay\Buy\Deal\V1\Api\EventApi(
// 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
);
$x_ebay_c_marketplace_id = 'x_ebay_c_marketplace_id_example'; // string | A header used to specify the eBay marketplace ID.
$limit = 'limit_example'; // string | The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100
$offset = 'offset_example'; // string | The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0
try {
$result = $apiInstance->getEvents($x_ebay_c_marketplace_id, $limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EventApi->getEvents: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_ebay_c_marketplace_id** | **string**| A header used to specify the eBay marketplace ID. |
**limit** | **string**| The maximum number of items, from the current result set, returned on a single page. Default: 20 Maximum Value: 100 | [optional]
**offset** | **string**| The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10, the method will retrieve items 1 through 10 from the list of items returned. If the offset is set to 10 and the limit is set to 10, the method will retrieve items 11 through 20 from the list of items returned. Default: 0 | [optional]
### Return type
[**\TNT\Ebay\Buy\Deal\V1\Model\EventSearchResponse**](../Model/EventSearchResponse.md)
### Authorization
[api_auth](../../README.md#api_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)