All URIs are relative to https://demo.channelengine.net/api
| Method | HTTP request | Description |
|---|---|---|
| productAcknowledgeDataChanges | POST /v2/products/data | This endpoint should be called after a call to GET 'v2/products/data'. After a call to this endpoint ChannelEngine 'knows' which products are known to the channel (and the last time they have been updated) and is therefore able to only return the products that really have changed since the last call to POST 'v2/products/data'. The supplied ChannelReference will be saved in our database and is supposed to be unique, the 'Updated' and 'Removed' fields consist of ChannelReferences which are sent in a previous call within the field 'Created'. |
| productAcknowledgeOfferChanges | POST /v2/products/offers | After a call to GET 'v2/products/offers' this endpoint should be called with the ChannelReference of the products that are successfully updated. Please see 'v2/products/data' and 'v2/products/data' for documentation. |
| productCreate | POST /v2/products | Create a product. The parent serves as the 'base' product of the children. For example, the children could be different sizes or colors of the parent product. For channels where every size and color are different products this does not make any difference (the children will just be sent separately, while ignoring the parent). But there are channels where the parent and the children need to be sent together, for example when there is one product with a list of sizes. In this case all the product information is retrieved from the parent product while the size list is generated from the children. Note that the parent itself is a 'blueprint' of the child products and we do our best to make sure it does not end up on the marketplaces itself. Only the children can be purchased. It's not possible to nest parent and children more than one level (A parent can have many children, but any child cannot itself also have children). The supplied MerchantProductReference needs to be unique. |
| productDelete | DELETE /v2/products/{merchantReference} | Deactivate a product based on the merchant reference. Note that we do not really delete a product, as the product might still be referenced by orders etc. |
| productGet | GET /v2/products/{merchantReference} | Retrieve a product based on the merchant reference. |
| productGetDataChanges | GET /v2/products/data | Get all products which have changes since the post http call to POST 'v2/products/data'. The response contains the products which should be created, updated or removed from the channel. After the products have been received and processed successfully 'v2/products/data' should be called with the merchant references of the products which have been processed (see POST 'v2/products/data'). ChannelEnginewill save this information to make sure that the next call to GET 'v2/products/data' only returns the products that really have changes (and therefore should be created, updated or deleted). A channel willing to integrate with channelengine should therefore only do the following things: 1. Periodically poll 'v2/products/data' for changes. 2. If any products are returned, save, update or remove these products. 3. Send the merchant references of the products that have succesfully been processed in step 2 to POST 'v2/products/data'. These three simple steps will make sure that the products on the channel will be synchronized with the products on ChannelEngine. ChannelEngine will use the API key to determine the customer whose products should be returned. |
| productGetOfferChanges | GET /v2/products/offers | GET 'v2/products/offers' and POST 'v2/products/offers' closely resemble GET 'v2/products/data' and POST 'v2/products/data'. See the 'v2/products/data' endpoints for documentation. The difference between both endpoints is that 'v2/products/offers' only returns Price and Stock updates and can (and should) therefore be called more often to keep this information (which might change frequently) up to date. |
\Swagger\Client\Model\Object productAcknowledgeDataChanges($changes)
This endpoint should be called after a call to GET 'v2/products/data'. After a call to this endpoint ChannelEngine 'knows' which products are known to the channel (and the last time they have been updated) and is therefore able to only return the products that really have changed since the last call to POST 'v2/products/data'. The supplied ChannelReference will be saved in our database and is supposed to be unique, the 'Updated' and 'Removed' fields consist of ChannelReferences which are sent in a previous call within the field 'Created'.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\ProductApi();
$changes = new \Swagger\Client\Model\ProcessedChanges(); // \Swagger\Client\Model\ProcessedChanges | The merchant references of the products which have been successfully created, updated or deleted (after a call to 'GetDataChanges')
try {
$result = $api_instance->productAcknowledgeDataChanges($changes);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductApi->productAcknowledgeDataChanges: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| changes | \Swagger\Client\Model\ProcessedChanges | The merchant references of the products which have been successfully created, updated or deleted (after a call to 'GetDataChanges') |
No authorization required
- Content-Type: application/json, text/json, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Object productAcknowledgeOfferChanges($changes)
After a call to GET 'v2/products/offers' this endpoint should be called with the ChannelReference of the products that are successfully updated. Please see 'v2/products/data' and 'v2/products/data' for documentation.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\ProductApi();
$changes = array(new string[]()); // string[] | The channel references of the updated products
try {
$result = $api_instance->productAcknowledgeOfferChanges($changes);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductApi->productAcknowledgeOfferChanges: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| changes | string[] | The channel references of the updated products |
No authorization required
- Content-Type: application/json, text/json, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ProductResponseViewModel productCreate($product_view)
Create a product. The parent serves as the 'base' product of the children. For example, the children could be different sizes or colors of the parent product. For channels where every size and color are different products this does not make any difference (the children will just be sent separately, while ignoring the parent). But there are channels where the parent and the children need to be sent together, for example when there is one product with a list of sizes. In this case all the product information is retrieved from the parent product while the size list is generated from the children. Note that the parent itself is a 'blueprint' of the child products and we do our best to make sure it does not end up on the marketplaces itself. Only the children can be purchased. It's not possible to nest parent and children more than one level (A parent can have many children, but any child cannot itself also have children). The supplied MerchantProductReference needs to be unique.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\ProductApi();
$product_view = new \Swagger\Client\Model\ProductRequestViewModel(); // \Swagger\Client\Model\ProductRequestViewModel |
try {
$result = $api_instance->productCreate($product_view);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductApi->productCreate: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| product_view | \Swagger\Client\Model\ProductRequestViewModel |
\Swagger\Client\Model\ProductResponseViewModel
No authorization required
- Content-Type: application/json, text/json, text/xml, application/x-www-form-urlencoded
- Accept: application/json, text/json, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Object productDelete($merchant_reference)
Deactivate a product based on the merchant reference. Note that we do not really delete a product, as the product might still be referenced by orders etc.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\ProductApi();
$merchant_reference = "merchant_reference_example"; // string |
try {
$result = $api_instance->productDelete($merchant_reference);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductApi->productDelete: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| merchant_reference | string |
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ProductResponseViewModel productGet($merchant_reference)
Retrieve a product based on the merchant reference.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\ProductApi();
$merchant_reference = "merchant_reference_example"; // string |
try {
$result = $api_instance->productGet($merchant_reference);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductApi->productGet: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| merchant_reference | string |
\Swagger\Client\Model\ProductResponseViewModel
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\ProductChangesViewModel productGetDataChanges()
Get all products which have changes since the post http call to POST 'v2/products/data'. The response contains the products which should be created, updated or removed from the channel. After the products have been received and processed successfully 'v2/products/data' should be called with the merchant references of the products which have been processed (see POST 'v2/products/data'). ChannelEnginewill save this information to make sure that the next call to GET 'v2/products/data' only returns the products that really have changes (and therefore should be created, updated or deleted). A channel willing to integrate with channelengine should therefore only do the following things: 1. Periodically poll 'v2/products/data' for changes. 2. If any products are returned, save, update or remove these products. 3. Send the merchant references of the products that have succesfully been processed in step 2 to POST 'v2/products/data'. These three simple steps will make sure that the products on the channel will be synchronized with the products on ChannelEngine. ChannelEngine will use the API key to determine the customer whose products should be returned.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\ProductApi();
try {
$result = $api_instance->productGetDataChanges();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductApi->productGetDataChanges: ', $e->getMessage(), PHP_EOL;
}
?>This endpoint does not need any parameter.
\Swagger\Client\Model\ProductChangesViewModel
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\OfferViewModel[] productGetOfferChanges()
GET 'v2/products/offers' and POST 'v2/products/offers' closely resemble GET 'v2/products/data' and POST 'v2/products/data'. See the 'v2/products/data' endpoints for documentation. The difference between both endpoints is that 'v2/products/offers' only returns Price and Stock updates and can (and should) therefore be called more often to keep this information (which might change frequently) up to date.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\ProductApi();
try {
$result = $api_instance->productGetOfferChanges();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductApi->productGetOfferChanges: ', $e->getMessage(), PHP_EOL;
}
?>This endpoint does not need any parameter.
\Swagger\Client\Model\OfferViewModel[]
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]