Here are the most common questions that may come up during CAPI setup. If a question is not answered here, please contact your account manager or support@channelpilot.com
What kind of API is it?
What kind of API is it?
The CAPI (short for Channel Pilot Pro API) is a REST API that provides basic functions for import. Data can be pushed directly to Channel Pilot Pro and does not have to be provided via URL or (s)FTP.
Can all CAPI functions be used immediately?
Can all CAPI functions be used immediately?
No!
For security reasons, the following functions are disabled by default and must be specially enabled by Channel Pilot Pro first:
Creation of new articles
Creation of new attributes on the article
Deletion of articles
Can any amount of data be transmitted at once?
Can any amount of data be transmitted at once?
No!
The limit is 10,000 SKU (articles) per request and 60 requests per minute. Larger requests are not partially processed but rejected directly by CAPI.
Is CAPI compatible with other imports?
Is CAPI compatible with other imports?
Yes!
The CAPI can be used alone or in combination with other imports. Especially if, for example, the article master data are updated only very rarely, it is possible to send them via a standard import (via URL or FTP) and add new data via the CAPI.
It is also a good idea to push stock and price data, as well as other data that changes frequently, via the CAPI to ensure rapid updating.
Some requests do not lead to any change or run into errors, what to do?
Some requests do not lead to any change or run into errors, what to do?
It can happen that executed requests have no effect on the database or run directly to an error. The error message could then look as follows:
{
"type": "feedDataJob",
"result": {
"globalFeedId": "test-feed-id",
"status": "FAILED",
"received": "2023-05-31T17:04:55+0200",
"articles": 0,
"successful": 0,
"invalidatedArticles": [
{
"articleError": "UNKNOWN_SKU",
"sku": "any-test-product",
"definedSkuDataField": "product-id"
}
],
"operationMethod": "PATCH"
},
"success": false
}
In most cases, this indicates that the CAPI connection is not yet fully configured. One of the two following steps is therefore necessary:
generally release the CAPI for the feed/shop
if the CAPI connection is active, the release of a permission is missing
In this case please contact your account manager or support@channelpilot.com.
The CAPI is enabled, but a PUT/PATCH/DELETE request is rejected. What is the reason for this?
The CAPI is enabled, but a PUT/PATCH/DELETE request is rejected. What is the reason for this?
This can have different causes and depends on the error message. Typical error sources can be:
an IP release is necessary on customer side or at CPP
the sent request contains too many SKUs
the sent request contains unknown SKUs
If it is a problem with an IP address, in some cases this can be seen in the logbook (log in to the account and check the log entries at https://go.channelpilot.com/tools/logbook).
If a request exceeds the allowed maximum SKU count, it will be automatically rejected. Please check if the limit of 10.000 SKU per request / 1 request per second is respected.
If the request contains unknown SKUs, these should be created automatically if the CAPI connection has been configured correctly. If this is not the case, please contact your account manager or support@channelpilot.com to have the missing CAPI functions activated.