',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
#### Error Responses
| Status Code | Error Type | FIeld | Description |
| ----------- | ---------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 401 | Request Failed | | Required product type for creating product using api is not created. |
| 400 | Validation Error | bundle\_id | Bundle id is required.
This field may not be blank.
Produt with same bundle id is already exist.
|
| 400 | Validation Error | name | This field is required.
This field may not be blank.
Ensure this field has no more than 200 characters.
|
| 400 | Validation Error | bundle\_name\_translations | This field is required.
Bundle Name for en language is required.
|
| 400 | Validation Error | description\_translations | This field is required.
Description of en language is required.
|
| 400 | Validation Error | short\_description\_translations | This field is required.
A short description of en language is required.
|
| 400 | Validation Error | varients | This field is required.
You can't possible add a product under the requested product type. Select a product type have only Price, Whole sale price and Product name as varients.
One of the varient object is not valid, check each varient objects contains price,product-name,whole-sale-price and product-sku.
At least one varient is required.
Product id should be a unique value.
Product id may not be a null value. Same product id's recieved.
|
| 400 | Validation Error | attributes | This field is required.
You cant possible to add product under the requested product type. Select a product type have only Business-volume, Pointes and Cumulative-volume as attributes.
Attribute should contains Business-volume, Points and Cumulative-volume, not include another attributes.
Business-volume is required.
Points is required.
Cumulative-volume is required.
Attribute must contains Business-volume, Points and Cumulative-volume.
|
## Update Product
`POST` `https://///commerce/product/update/`
This API endpoint will update a product bundle if it's an external-api-product type .
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------ |
| apikey\* | string | apikey |
| Authorization\* | string | Access token |
#### Request Body
| Name | Type | Description |
| ------------------------------------------------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bundle\_id\* | string | Product bundle unique id |
| name\* | string | New name or existing name for bundle. |
| bundle\_name\_translations\* | string | Existing or New Translations for a product bundle. |
| description\_translations\* | string | Existing or New Translations for Product description |
| short\_description\_translations\* | string | Existing or New Translations for Product short description, |
| varients\* | string | Varient must contain price, product-name, and whole-sale-price. Additionally, add a key product-sku with aexisting sku as a value if u want to update existing variant or give new sku as a value to add new product varient. |
| attributes\* | string | The attribute must contain business-volume, points, and, cumulative-volume. |
{% tabs %}
{% tab title="200 " %}
```markup
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {}
}
```
{% endtab %}
{% endtabs %}
**Note**:-
By using this API endpoint you can update a product that is under external-api-product.
Additionally, add a key product-sku with a existing id as a value if you want to update the existing varient*.* Give new id as a value of product-sku for adding a new product varient.
Body Parameters are JSON.stringify, Refer below block for the body parameter structure, and also refer sample code.
```markup
{
"bundle_id":"",
"name":"",
"bundle_name_translations":{"en": "","de": ""},
"description_translations":{"en": "","de": ""},
"short_description_translations":{"en": "","de": ""},
"varients":[{"price":,"product-name":"","whole-sale-price":,"product-sku":},{"price":,"product-name":"","whole-sale-price":,"product-sku":}],
"attributes":{"business-volume":, "points":, "cumulative-volume":}
}
```
#### Sample Code
**Node**
```php
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://///commerce/product/update/',
'headers': {
'apikey': '',
'Authorization': 'Bearer ',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"bundle_id":"",
"name":"",
"bundle_name_translations":{"en": "","de": ""},
"description_translations":{"en": "","de": ""},
"short_description_translations":{"en": "","de": ""},
"varients":[{"price":,"product-name":"","whole-sale-price":,"product-sku":},{"price":,"product-name":"","whole-sale-price":,"product-sku":}],
"attributes":{"business-volume":, "points":, "cumulative-volume":}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
**PHP**
```php
'https://///commerce/product/update/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"bundle_id":"",
"name":"",
"bundle_name_translations":{"en": "","de": ""},
"description_translations":{"en": "","de": ""},
"short_description_translations":{"en": "","de": ""},
"varients":[{"price":,"product-name":"","whole-sale-price":,"product-sku":},{"price":,"product-name":"","whole-sale-price":,"product-sku":}],
"attributes":{"business-volume":, "points":, "cumulative-volume":}
}',
CURLOPT_HTTPHEADER => array(
'apikey: ',
'Authorization: Bearer ',
'Content-Type: application/json',
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
#### Error Responses
| Status Code | Error Type | FIeld | Description |
| ----------- | ---------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400 | Invalid Input | bundle\_id | Bundle id is required.
This field may not be blank.
Bundle does not exist.
Requested bundle is not under the external api product category.
|
| 400 | Validation Error | name | This field is required.
This field may not be blank.
Ensure this field has no more than 200 characters.
|
| 400 | Validation Error | description\_translations | This field is required.
Description of en language is required.
|
| 400 | Validation Error | short\_description\_translations | This field is required.
A short description of en language is required.
|
| 400 | Validation Error | varients | You can't possible add a product under the requested product type. Select a product type have only Price, Whole sale price and Product name as varients.
One of the varient object is not valid, check each varient objects contains price,product-name,whole-sale-price and product-sku.
At least one varient is required.
Product sku should be a unique value. Product sku may not be a null value. Same product sku's recieved.
|
| 400 | Validation Error | attributes | You cant possible to add product under the requested product type. Select a product type have only Business-volume, Pointes and Cumulative-volume as attributes.
Attribute should contains Business-volume, Points and Cumulative-volume, not include another attributes.
Business-volume is required.
Points is required.
Cumulative-volume is required.
Attribute must contains Business-volume, Points and Cumulative-volume.
|
## Delete Product Bundle
`DELETE` `https://///commerce/product/delete/`
This API endpoint will delete a product bundle if it's an external-api-product type.
#### Query Parameters
| Name | Type | Description |
| -------------------------------------------- | ------ | ----------- |
| bundle\_id\* | string | Bundle id |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| apikey\* | string | apikey |
| Authorization\* | string | Bearer access token |
{% tabs %}
{% tab title="200 " %}
```markup
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {}
}
```
{% endtab %}
{% endtabs %}
#### Sample Code
**Node**
```php
var request = require('request');
var options = {
'method': 'DELETE',
'url': 'https://///commerce/product/delete/?bundle_id=',
'headers': {
'apikey': '',
'Authorization': 'Bearer '
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
**PHP**
```php
'https://///commerce/product/delete/?bundle_id=',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'apikey: ',
'Authorization: Bearer '
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
#### Error Responses
| Status Code | Error Type | FIeld | Description |
| ----------- | -------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400 | Invalid Input | bundle\_id | Bundle id is required.
This field may not be blank.
Product Bundle does not exist.
Product Bundle is not a external-api-product type.
|
| 401 | Request Failed | | The product contains in a order that is not completed yet.
The package purchased by some users.
|
## Delete Product Varient
`DELETE` `https://///commerce/product/delete/product-varient/`
This API endpoint will delete a varient (product) from the product bundle if it's an external-api-product type.
#### Query Parameters
| Name | Type | Description |
| ---------------------------------------------- | ------ | ------------ |
| bundle\_id\* | string | Bundle id |
| product\_sku\* | string | Product sku. |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| apikey\* | string | apikey |
| Authorization\* | string | Bearer access token |
{% tabs %}
{% tab title="200 " %}
```
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {}
}
```
{% endtab %}
{% endtabs %}
#### Sample Code
#### Node
```php
var request = require('request');
var options = {
'method': 'DELETE',
'url': 'https://///commerce/product/delete/product-varient/',
'headers': {
'apikey': '',
'Authorization': 'Bearer '
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
#### PHP
```php
'https://///commerce/product/delete/product-varient/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'apikey: ',
'Authorization: Bearer ',
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
#### Error Responses
| Status Code | Error Type | FIeld | Description |
| ----------- | ---------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400 | Validation Error | product\_sku | This field is required.
This field may not be blank.
Product sku is not valid.
Product does not exist.
|
| 400 | Validation Error | bundle\_id | This field is required.
This field may not be blank.
|
| 401 | Request Failed | | Only one varient left under the product bundle, can't delete it.
You can delete a product under the external-api-product not athor category product.
Only one varient left under the prouct bundle, can't delete it.
|
## List Products
`GET` `https://///commerce/product/list/`
This API endpoint List product bundle with product details.
#### Query Parameters
| Name | Type | Description |
| -------- | ------ | ------------------- |
| offset | string | |
| limit | string | |
| name | string | Product Bundle name |
| category | string | Product type |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| apikey\* | string | apikey |
| Authorization\* | string | Bearer access token |
{% tabs %}
{% tab title="200 " %}
```markup
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {
"results": [
{
"name": "",
"product_type": "",
"status": ,
"products": [
{
"product_id": "",
"name": "",
"product_type": "",
"base_price": "",
"status": ,
"image": ""
}
],
"bundle_id": ""
},
...
],
"count": ,
"previous": ,
"next":
}
}
```
{% endtab %}
{% endtabs %}
#### Sample Code
**Node**
```php
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://///commerce/product/list/',
'headers': {
'apikey': '',
'Authorization': 'Bearer '
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
**PHP**
```php
'https://///commerce/product/list/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'apikey: ',
'Authorization: Bearer '
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
## Create Bulk Products
`POST` `https://///commerce/product/bulk/create/`
This API endpoint will create bulk product.
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| apikey\* | string | Apikey |
| Authorization\* | string | Bearer access token |
{% tabs %}
{% tab title="200 " %}
```markup
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {
"Product_creation_failed": {
"same_bundle_id": [],
"bundle_id_null": [],
"bundle_id_not_found": []
}
}
}
```
{% endtab %}
{% endtabs %}
#### Body params :- JSON.stringify
```php
[
{
"bundle_id":"",
"name":"",
"bundle_name_translations":{"en": "","de": ""},
"description_translations":{"en": "","de": ""},
"short_description_translations":{"en": "","de": ""},
"varients":[{"price":,"product-name":"","whole-sale-price":,"product-sku":""},{"price":,"product-name":"","whole-sale-price":,"product-sku":""}],
"attributes":{"business-volume":, "points":, "cumulative-volume":}
},
{
"bundle_id":"",
"name":"",
"bundle_name_translations":{"en": "","de": ""},
"description_translations":{"en": "","de": ""},
"short_description_translations":{"en": "","de": ""},
"varients":[{"price":,"product-name":"","whole-sale-price":,"product-sku":""},{"price":,"product-name":"","whole-sale-price":,"product-sku":""}],
"attributes":{"business-volume":, "points":, "cumulative-volume":}
},
...
]
```
#### Sample Code
**Node**
```javascript
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://///commerce/product/bulk/create/',
'headers': {
'apikey': '',
'Authorization': 'Bearer ',
'Content-Type': 'application/json',
},
body: JSON.stringify([{
"bundle_id":"",
"name":"",
"bundle_name_translations":{"en": "","de": ""},
"description_translations":{"en": "","de": ""},
"short_description_translations":{"en": "","de": ""},
"varients":[{"price":,"product-name":"","whole-sale-price":,"product-sku":"