Sajari\PromotionsApi

All URIs are relative to https://api.search.io.

Method	HTTP request	Description
createPromotion()	POST /v4/collections/{collection_id}/promotions	Create promotion
deletePromotion()	DELETE /v4/collections/{collection_id}/promotions/{promotion_id}	Delete promotion
getPromotion()	GET /v4/collections/{collection_id}/promotions/{promotion_id}	Get promotion
listPromotions()	GET /v4/collections/{collection_id}/promotions	List promotions
updatePromotion()	PATCH /v4/collections/{collection_id}/promotions/{promotion_id}	Update promotion

`createPromotion()`

createPromotion($collection_id, $promotion, $account_id): \Sajari\Model\Promotion

Create promotion

Create a new promotion in a collection.

Example

<?php
require_once __DIR__ . "/vendor/autoload.php";

// Configure HTTP basic authorization: BasicAuth
$config = Sajari\Configuration::getDefaultConfiguration()
  ->setUsername("YOUR_USERNAME")
  ->setPassword("YOUR_PASSWORD");

$apiInstance = new Sajari\Api\PromotionsApi(
  // 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
);
$collection_id = "collection_id_example"; // string | The collection to create a promotion in, e.g. `my-collection`.
$promotion = new \Sajari\Model\Promotion(); // \Sajari\Model\Promotion | The promotion to create.
$account_id = "account_id_example"; // string | The account that owns the collection, e.g. `1618535966441231024`.

try {
  $result = $apiInstance->createPromotion(
    $collection_id,
    $promotion,
    $account_id
  );
  print_r($result);
} catch (Exception $e) {
  echo "Exception when calling PromotionsApi->createPromotion: ",
    $e->getMessage(),
    PHP_EOL;
}

Parameters

Name	Type	Description	Notes
collection_id	string	The collection to create a promotion in, e.g. `my-collection`.
promotion	\Sajari\Model\Promotion	The promotion to create.
account_id	string	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

\Sajari\Model\Promotion

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deletePromotion()`

deletePromotion($collection_id, $promotion_id, $account_id): mixed

Delete promotion

Delete a promotion and all of its associated data. > Note: This operation cannot be reversed.

Example

<?php
require_once __DIR__ . "/vendor/autoload.php";

// Configure HTTP basic authorization: BasicAuth
$config = Sajari\Configuration::getDefaultConfiguration()
  ->setUsername("YOUR_USERNAME")
  ->setPassword("YOUR_PASSWORD");

$apiInstance = new Sajari\Api\PromotionsApi(
  // 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
);
$collection_id = "collection_id_example"; // string | The collection the promotion belongs to, e.g. `my-collection`.
$promotion_id = "promotion_id_example"; // string | The promotion to delete, e.g. `1234`.
$account_id = "account_id_example"; // string | The account that owns the collection, e.g. `1618535966441231024`.

try {
  $result = $apiInstance->deletePromotion(
    $collection_id,
    $promotion_id,
    $account_id
  );
  print_r($result);
} catch (Exception $e) {
  echo "Exception when calling PromotionsApi->deletePromotion: ",
    $e->getMessage(),
    PHP_EOL;
}

Parameters

Name	Type	Description	Notes
collection_id	string	The collection the promotion belongs to, e.g. `my-collection`.
promotion_id	string	The promotion to delete, e.g. `1234`.
account_id	string	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

mixed

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPromotion()`

getPromotion($collection_id, $promotion_id, $account_id): \Sajari\Model\Promotion

Get promotion

Retrieve the details of a promotion.

Example

<?php
require_once __DIR__ . "/vendor/autoload.php";

// Configure HTTP basic authorization: BasicAuth
$config = Sajari\Configuration::getDefaultConfiguration()
  ->setUsername("YOUR_USERNAME")
  ->setPassword("YOUR_PASSWORD");

$apiInstance = new Sajari\Api\PromotionsApi(
  // 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
);
$collection_id = "collection_id_example"; // string | The collection that owns the promotion, e.g. `my-collection`.
$promotion_id = "promotion_id_example"; // string | The promotion to retrieve, e.g. `1234`.
$account_id = "account_id_example"; // string | The account that owns the collection, e.g. `1618535966441231024`.

try {
  $result = $apiInstance->getPromotion(
    $collection_id,
    $promotion_id,
    $account_id
  );
  print_r($result);
} catch (Exception $e) {
  echo "Exception when calling PromotionsApi->getPromotion: ",
    $e->getMessage(),
    PHP_EOL;
}

Parameters

Name	Type	Description	Notes
collection_id	string	The collection that owns the promotion, e.g. `my-collection`.
promotion_id	string	The promotion to retrieve, e.g. `1234`.
account_id	string	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

\Sajari\Model\Promotion

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listPromotions()`

listPromotions($collection_id, $account_id, $page_size, $page_token, $view): \Sajari\Model\ListPromotionsResponse

List promotions

Retrieve a list of promotions in a collection. Promotion pins, exclusions and filter boosts are not returned in this call.

Example

<?php
require_once __DIR__ . "/vendor/autoload.php";

// Configure HTTP basic authorization: BasicAuth
$config = Sajari\Configuration::getDefaultConfiguration()
  ->setUsername("YOUR_USERNAME")
  ->setPassword("YOUR_PASSWORD");

$apiInstance = new Sajari\Api\PromotionsApi(
  // 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
);
$collection_id = "collection_id_example"; // string | The collection that owns this set of promotions, e.g. `my-collection`.
$account_id = "account_id_example"; // string | The account that owns the collection, e.g. `1618535966441231024`.
$page_size = 56; // int | The maximum number of promotions to return. The service may return fewer than this value.  If unspecified, at most 50 promotions are returned.  The maximum value is 1000; values above 1000 are coerced to 1000.
$page_token = "page_token_example"; // string | A page token, received from a previous [ListPromotions](/docs/api#operation/ListPromotions) call.  Provide this to retrieve the subsequent page.  When paginating, all other parameters provided to [ListPromotions](/docs/api#operation/ListPromotions) must match the call that provided the page token.
$view = "PROMOTION_VIEW_UNSPECIFIED"; // string | The amount of information to include in each retrieved promotion.   - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view.  - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects.  - FULL: Returns all information about a promotion. This is the default value.

try {
  $result = $apiInstance->listPromotions(
    $collection_id,
    $account_id,
    $page_size,
    $page_token,
    $view
  );
  print_r($result);
} catch (Exception $e) {
  echo "Exception when calling PromotionsApi->listPromotions: ",
    $e->getMessage(),
    PHP_EOL;
}

Parameters

Name	Type	Description	Notes
collection_id	string	The collection that owns this set of promotions, e.g. `my-collection`.
account_id	string	The account that owns the collection, e.g. `1618535966441231024`.	[optional]
page_size	int	The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions are returned. The maximum value is 1000; values above 1000 are coerced to 1000.	[optional]
page_token	string	A page token, received from a previous ListPromotions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPromotions must match the call that provided the page token.	[optional]
view	string	The amount of information to include in each retrieved promotion. - PROMOTION_VIEW_UNSPECIFIED: The default / unset value. The API defaults to the `FULL` view. - BASIC: Include basic information including name, start time and end time, but not detailed information about the promotion effects. - FULL: Returns all information about a promotion. This is the default value.	[optional] [default to 'PROMOTION_VIEW_UNSPECIFIED']

Return type

\Sajari\Model\ListPromotionsResponse

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updatePromotion()`

updatePromotion($collection_id, $promotion_id, $update_mask, $promotion, $account_id): \Sajari\Model\Promotion

Update promotion

Update the details of a promotion. Pass each field that you want to update in the request body. Also specify the name of each field that you want to update in the update_mask in the request URL query string. Separate multiple fields with a comma. Fields included in the request body, but not included in the field mask are not updated. For example, to update the display_name and start_time fields, make a PATCH request to the URL: /v4/collections/{collection_id}/promotions/{promotion_id}?update_mask=display_name,start_time With the JSON body: { \"display_name\": \"new value\", \"start_time\": \"2006-01-02T15:04:05Z07:00\", \"end_time\": \"2006-01-02T15:04:05Z07:00\" } > Note: In this example end_time is not updated because it is not specified in the update_mask.

Example

<?php
require_once __DIR__ . "/vendor/autoload.php";

// Configure HTTP basic authorization: BasicAuth
$config = Sajari\Configuration::getDefaultConfiguration()
  ->setUsername("YOUR_USERNAME")
  ->setPassword("YOUR_PASSWORD");

$apiInstance = new Sajari\Api\PromotionsApi(
  // 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
);
$collection_id = "collection_id_example"; // string | The collection the promotion belongs to, e.g. `my-collection`.
$promotion_id = "promotion_id_example"; // string | The promotion to update, e.g. `1234`.
$update_mask = "update_mask_example"; // string | The list of fields to be updated, separated by a comma, e.g. `field1,field2`.  Each field should be in snake case, e.g. `display_name`, `filter_boosts`.  For each field that you want to update, provide a corresponding value in the promotion object containing the new value.
$promotion = new \Sajari\Model\Promotion(); // \Sajari\Model\Promotion | Details of the promotion to update.
$account_id = "account_id_example"; // string | The account that owns the collection, e.g. `1618535966441231024`.

try {
  $result = $apiInstance->updatePromotion(
    $collection_id,
    $promotion_id,
    $update_mask,
    $promotion,
    $account_id
  );
  print_r($result);
} catch (Exception $e) {
  echo "Exception when calling PromotionsApi->updatePromotion: ",
    $e->getMessage(),
    PHP_EOL;
}

Parameters

Name	Type	Description	Notes
collection_id	string	The collection the promotion belongs to, e.g. `my-collection`.
promotion_id	string	The promotion to update, e.g. `1234`.
update_mask	string	The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`, `filter_boosts`. For each field that you want to update, provide a corresponding value in the promotion object containing the new value.
promotion	\Sajari\Model\Promotion	Details of the promotion to update.
account_id	string	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

\Sajari\Model\Promotion

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PromotionsApi.md

PromotionsApi.md

Sajari\PromotionsApi

`createPromotion()`

Example

Parameters

Return type

Authorization

HTTP request headers

`deletePromotion()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getPromotion()`

Example

Parameters

Return type

Authorization

HTTP request headers

`listPromotions()`

Example

Parameters

Return type

Authorization

HTTP request headers

`updatePromotion()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

PromotionsApi.md

Latest commit

History

PromotionsApi.md

File metadata and controls

Sajari\PromotionsApi

createPromotion()

Example

Parameters

Return type

Authorization

HTTP request headers

deletePromotion()

Example

Parameters

Return type

Authorization

HTTP request headers

getPromotion()

Example

Parameters

Return type

Authorization

HTTP request headers

listPromotions()

Example

Parameters

Return type

Authorization

HTTP request headers

updatePromotion()

Example

Parameters

Return type

Authorization

HTTP request headers

`createPromotion()`

`deletePromotion()`

`getPromotion()`

`listPromotions()`

`updatePromotion()`