OpenAPI\Client\ProductsApi

All URIs are relative to https://api.voucherify.io, except if the operation defines another base path.

Method	HTTP request	Description
createProduct()	POST /v1/products	Create Product
createSku()	POST /v1/products/{productId}/skus	Create SKU
deleteProduct()	DELETE /v1/products/{productId}	Delete Product
deleteSku()	DELETE /v1/products/{productId}/skus/{skuId}	Delete SKU
getProduct()	GET /v1/products/{productId}	Get Product
getSku()	GET /v1/skus/{skuId}	Get SKU
importProductsUsingCsv()	POST /v1/products/importCSV	Import Products using CSV
importSkusUsingCsv()	POST /v1/skus/importCSV	Import SKUs using CSV
listProducts()	GET /v1/products	List Products
listSkusInProduct()	GET /v1/products/{productId}/skus	List SKUs in Product
updateProduct()	PUT /v1/products/{productId}	Update Product
updateProductsInBulk()	POST /v1/products/bulk/async	Update Products in Bulk
updateProductsMetadataInBulk()	POST /v1/products/metadata/async	Update Products' Metadata in Bulk
updateSku()	PUT /v1/products/{productId}/skus/{skuId}	Update SKU

`createProduct()`

createProduct($productsCreateRequestBody): \OpenAPI\Client\Model\ProductsCreateResponseBody

Create Product

Creates a product object. 📘 Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productsCreateRequestBody = {"source_id":"first_product","name":"Samsung Phone","price":200000,"attributes":["color","memory","processor"],"metadata":{"test":true,"vendor":"Online Store"},"image_url":"https://www.website.com/image.png"}; // \OpenAPI\Client\Model\ProductsCreateRequestBody | Specify the product parameters.

try {
    $result = $apiInstance->createProduct($productsCreateRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->createProduct: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productsCreateRequestBody	\OpenAPI\Client\Model\ProductsCreateRequestBody	Specify the product parameters.	[optional]

Return type

\OpenAPI\Client\Model\ProductsCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

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

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

`createSku()`

createSku($productId, $productsSkusCreateRequestBody): \OpenAPI\Client\Model\ProductsSkusCreateResponseBody

Create SKU

This method adds product variants to a created product. 📘 Upsert Mode If you pass an id or a source_id that already exists in the sku database, Voucherify will return a related sku object with updated fields.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productId = 'productId_example'; // string | A Voucherify product ID or product source ID.
$productsSkusCreateRequestBody = {"source_id":"first_product_sku_1","sku":"Samsung phone 256GB","price":1300,"currency":"USD","attributes":{"color":"vintage-black","memory":"256","processor":"Intel"},"image_url":"https://www.website.com/image.png","metadata":{"imported":true}}; // \OpenAPI\Client\Model\ProductsSkusCreateRequestBody | Specify the SKU parameters to be created.

try {
    $result = $apiInstance->createSku($productId, $productsSkusCreateRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->createSku: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productId	string	A Voucherify product ID or product source ID.
productsSkusCreateRequestBody	\OpenAPI\Client\Model\ProductsSkusCreateRequestBody	Specify the SKU parameters to be created.	[optional]

Return type

\OpenAPI\Client\Model\ProductsSkusCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

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

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

`deleteProduct()`

deleteProduct($productId, $force)

Delete Product

Deletes a product and all related SKUs. This operation cannot be undone. If the force parameter is set to false or not set at all, the product and all related SKUs will be moved to the bin.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productId = 'productId_example'; // string | A Voucherify product ID or source ID.
$force = True; // bool | If this flag is set to true, the product and all related SKUs will be removed permanently. If it is set to false or not set at all, the product and all related SKUs will be moved to the bin. Going forward, the user will be able to create another product with exactly the same source_id.

try {
    $apiInstance->deleteProduct($productId, $force);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->deleteProduct: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productId	string	A Voucherify product ID or source ID.
force	bool	If this flag is set to true, the product and all related SKUs will be removed permanently. If it is set to false or not set at all, the product and all related SKUs will be moved to the bin. Going forward, the user will be able to create another product with exactly the same source_id.	[optional]

Return type

void (empty response body)

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`deleteSku()`

deleteSku($productId, $skuId, $force)

Delete SKU

Deletes a product SKU. This operation cannot be undone. If the force parameter is set to false or not set at all, the SKU will be moved to the bin.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productId = 'productId_example'; // string | A unique Voucherify product ID or product source ID.
$skuId = 'skuId_example'; // string | A Voucherify SKU ID or SKU source ID.
$force = True; // bool | If this flag is set to true, the SKU will be removed permanently. If it is set to false or not set at all, the SKU will be moved to the bin. Going forward, the user will be able to create another SKU with exactly the same source_id.

try {
    $apiInstance->deleteSku($productId, $skuId, $force);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->deleteSku: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productId	string	A unique Voucherify product ID or product source ID.
skuId	string	A Voucherify SKU ID or SKU source ID.
force	bool	If this flag is set to true, the SKU will be removed permanently. If it is set to false or not set at all, the SKU will be moved to the bin. Going forward, the user will be able to create another SKU with exactly the same source_id.	[optional]

Return type

void (empty response body)

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`getProduct()`

getProduct($productId): \OpenAPI\Client\Model\ProductsGetResponseBody

Get Product

Retrieve product details.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productId = 'productId_example'; // string | A Voucherify product ID or source ID.

try {
    $result = $apiInstance->getProduct($productId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getProduct: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productId	string	A Voucherify product ID or source ID.

Return type

\OpenAPI\Client\Model\ProductsGetResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getSku()`

getSku($skuId): \OpenAPI\Client\Model\SkusGetResponseBody

Get SKU

Retrieve details of a SKU.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$skuId = 'skuId_example'; // string | A Voucherify SKU identifier or SKU source ID.

try {
    $result = $apiInstance->getSku($skuId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->getSku: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
skuId	string	A Voucherify SKU identifier or SKU source ID.

Return type

\OpenAPI\Client\Model\SkusGetResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`importProductsUsingCsv()`

importProductsUsingCsv($file): \OpenAPI\Client\Model\ProductsImportCsvCreateResponseBody

Import Products using CSV

Import products into the repository using a CSV file. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$file = "/path/to/file.txt"; // \SplFileObject | File path.

try {
    $result = $apiInstance->importProductsUsingCsv($file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->importProductsUsingCsv: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
file	\SplFileObject\SplFileObject	File path.	[optional]

Return type

\OpenAPI\Client\Model\ProductsImportCsvCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`importSkusUsingCsv()`

importSkusUsingCsv($file): \OpenAPI\Client\Model\SkusImportCsvCreateResponseBody

Import SKUs using CSV

Import SKUs into the repository using a CSV file. The CSV file has to include headers in the first line. All properties which cannot be mapped to standard SKU fields will be added to the metadata object. You can find an example template here. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$file = "/path/to/file.txt"; // \SplFileObject | File path.

try {
    $result = $apiInstance->importSkusUsingCsv($file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->importSkusUsingCsv: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
file	\SplFileObject\SplFileObject	File path.	[optional]

Return type

\OpenAPI\Client\Model\SkusImportCsvCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`listProducts()`

listProducts($limit, $page, $order, $startDate, $endDate): \OpenAPI\Client\Model\ProductsListResponseBody

List Products

Retrieve a list of products.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$limit = 56; // int | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
$page = 56; // int | Which page of results to return. The lowest value is 1.
$order = new \OpenAPI\Client\Model\ParameterOrder(); // ParameterOrder | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
$startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

try {
    $result = $apiInstance->listProducts($limit, $page, $order, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->listProducts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
limit	int	Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.	[optional]
page	int	Which page of results to return. The lowest value is 1.	[optional]
order	ParameterOrder	Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.	[optional]
startDate	\DateTime	Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.	[optional]
endDate	\DateTime	Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.	[optional]

Return type

\OpenAPI\Client\Model\ProductsListResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`listSkusInProduct()`

listSkusInProduct($productId, $limit, $page, $order, $startDate, $endDate): \OpenAPI\Client\Model\ProductsSkusListResponseBody

List SKUs in Product

Retrieve all SKUs for a given product.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productId = 'productId_example'; // string | A Voucherify product ID or product source ID.
$limit = 56; // int | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
$page = 56; // int | Which page of results to return. The lowest value is 1.
$order = new \OpenAPI\Client\Model\ParameterOrder(); // ParameterOrder | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
$startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

try {
    $result = $apiInstance->listSkusInProduct($productId, $limit, $page, $order, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->listSkusInProduct: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productId	string	A Voucherify product ID or product source ID.
limit	int	Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.	[optional]
page	int	Which page of results to return. The lowest value is 1.	[optional]
order	ParameterOrder	Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.	[optional]
startDate	\DateTime	Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.	[optional]
endDate	\DateTime	Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.	[optional]

Return type

\OpenAPI\Client\Model\ProductsSkusListResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`updateProduct()`

updateProduct($productId, $productsUpdateRequestBody): \OpenAPI\Client\Model\ProductsUpdateResponseBody

Update Product

Updates the specified product by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productId = 'productId_example'; // string | A Voucherify product ID or source ID.
$productsUpdateRequestBody = {"price":210000}; // \OpenAPI\Client\Model\ProductsUpdateRequestBody | Specify the parameters of the product that are to be updated.

try {
    $result = $apiInstance->updateProduct($productId, $productsUpdateRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->updateProduct: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productId	string	A Voucherify product ID or source ID.
productsUpdateRequestBody	\OpenAPI\Client\Model\ProductsUpdateRequestBody	Specify the parameters of the product that are to be updated.	[optional]

Return type

\OpenAPI\Client\Model\ProductsUpdateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

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

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

`updateProductsInBulk()`

updateProductsInBulk($productsUpdateInBulkRequestBody): \OpenAPI\Client\Model\ProductsUpdateInBulkResponseBody

Update Products in Bulk

Update products in one asynchronous operation. The request can include up to 10 MB of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is upserted. This is shown in the report file in the GET Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productsUpdateInBulkRequestBody = [{"source_id":"first_product","name":"Samsung Phone 1","price":220000,"attributes":["color","memory","processor"],"metadata":{"test":true,"vendor":"Online Store - 3"},"image_url":"https://voucherify-uploads.s3.amazonaws.com/org_2qt8DYlM/img_Z2qvs2KFnQyo2Ohz4uhsjGtf.png"},{"source_id":"second_product","name":"Samsung Phone 2","price":230000,"attributes":["color","memory","processor"],"metadata":{"test":true,"vendor":"Online Store - 4"},"image_url":"https://voucherify-uploads.s3.amazonaws.com/org_2qt8DYlM/img_Z2qvs2KFnQyo2Ohz4uhsjGtf.png"}]; // \OpenAPI\Client\Model\ProductsUpdateInBulkRequestBody[] | List the product fields to be updated in each customer object.

try {
    $result = $apiInstance->updateProductsInBulk($productsUpdateInBulkRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->updateProductsInBulk: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productsUpdateInBulkRequestBody	\OpenAPI\Client\Model\ProductsUpdateInBulkRequestBody[]	List the product fields to be updated in each customer object.	[optional]

Return type

\OpenAPI\Client\Model\ProductsUpdateInBulkResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

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

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

`updateProductsMetadataInBulk()`

updateProductsMetadataInBulk($productsMetadataUpdateInBulkRequestBody): \OpenAPI\Client\Model\ProductsMetadataUpdateInBulkResponseBody

Update Products' Metadata in Bulk

Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to 10 MB of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is upserted. This is shown in the report file in the GET Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productsMetadataUpdateInBulkRequestBody = {"source_ids":["123-567-3433","test_volleyball"],"metadata":{"label":true,"origin":"PL"}}; // \OpenAPI\Client\Model\ProductsMetadataUpdateInBulkRequestBody | List the source_ids of the products you would like to update with the metadata key/value pairs.

try {
    $result = $apiInstance->updateProductsMetadataInBulk($productsMetadataUpdateInBulkRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->updateProductsMetadataInBulk: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productsMetadataUpdateInBulkRequestBody	\OpenAPI\Client\Model\ProductsMetadataUpdateInBulkRequestBody	List the source_ids of the products you would like to update with the metadata key/value pairs.	[optional]

Return type

\OpenAPI\Client\Model\ProductsMetadataUpdateInBulkResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

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

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

`updateSku()`

updateSku($productId, $skuId, $productsSkusUpdateRequestBody): \OpenAPI\Client\Model\ProductsSkusUpdateResponseBody

Update SKU

Updates the specified SKU by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body schema wont be modified. Even if provided, they will be silently skipped.

Example

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


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ProductsApi(
    // 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
);
$productId = 'productId_example'; // string | A unique Voucherify product ID or product source ID.
$skuId = 'skuId_example'; // string | A Voucherify SKU ID or SKU source ID.
$productsSkusUpdateRequestBody = {"price":210000,"currency":"PLN"}; // \OpenAPI\Client\Model\ProductsSkusUpdateRequestBody | Specify the parameters to be updated.

try {
    $result = $apiInstance->updateSku($productId, $skuId, $productsSkusUpdateRequestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductsApi->updateSku: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
productId	string	A unique Voucherify product ID or product source ID.
skuId	string	A Voucherify SKU ID or SKU source ID.
productsSkusUpdateRequestBody	\OpenAPI\Client\Model\ProductsSkusUpdateRequestBody	Specify the parameters to be updated.	[optional]

Return type

\OpenAPI\Client\Model\ProductsSkusUpdateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

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

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

Files

ProductsApi.md

Latest commit

History

ProductsApi.md

File metadata and controls

OpenAPI\Client\ProductsApi

createProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

createSku()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSku()

Example

Parameters

Return type

Authorization

HTTP request headers

getProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

getSku()

Example

Parameters

Return type

Authorization

HTTP request headers

importProductsUsingCsv()

Example

Parameters

Return type

Authorization

HTTP request headers

importSkusUsingCsv()

Example

Parameters

Return type

Authorization

HTTP request headers

listProducts()

Example

Parameters

Return type

Authorization

HTTP request headers

listSkusInProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

updateProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

updateProductsInBulk()

Example

Parameters

Return type

Authorization

HTTP request headers

updateProductsMetadataInBulk()

`createProduct()`

`createSku()`

`deleteProduct()`

`deleteSku()`

`getProduct()`

`getSku()`

`importProductsUsingCsv()`

`importSkusUsingCsv()`

`listProducts()`

`listSkusInProduct()`

`updateProduct()`

`updateProductsInBulk()`

`updateProductsMetadataInBulk()`

`updateSku()`