Products
Use the REST API to interact with the products in the application.
You should take into account when making your request
info
Remember that for some requests, you need to send the authentication token.
Header Parameters
{
"Authorization": "Bearer ...token..."
}
And the query parameters are as follows:
Query Parameters
{
"setting": {
"timezone": "America/Bogota",
"fromAdmin": true,
"appMode": "iadmin",
"authProvider": "local",
"locale": "en"
}
}
Do you want to see the changes made through the API?
info
After using the API to access products, it's important to update the cache to see the changes.
How to do it:
- Go to the upper-right corner and select the dropdown menu with your username.
- Click on 'Settings.'
- In the 'Actions' section, look for the 'Clear Cache' option.
- Click on 'Clear Cache' to update the information and view the updated products.
Create a Product
Use this endpoint to create a product.
POST/api/icommerce/v3/products
- Minimum
- Rest
{
"attributes": {
"category_id": "2", // This Id is the identification of the categories
"en": { // This depends on the server's language
"name": "Test",
"slug": "test",
"summary": "Summary",
"description": "Description" // You can use HTML for this field
}
}
}
{
"attributes": {
"status": 1,
"category_id": "2",
"categories": [
"2"
],
"sku": "SKU-15",
"quantity": 1,
"stock_status": 1,
"price": "1000",
"date_available": "2023/10/21",
"weight_class_id": 1,
"volume_class_id": 1,
"lenght_class_id": 1,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"minimum": 1,
"reference": "",
"shipping": true,
"show_price_is_call": "0",
"subtract": true,
"freeshipping": true,
"order_weight": 0,
"rating": 3,
"points": 0,
"related_products": [],
"product_options": [],
"price_lists": [],
"medias_single": {
"mainimage": 349
},
"medias_multi": {
"gallery": {
"files": [
335,
336,
342
],
"orders": "335,336,342"
}
},
"manufacturer_id": "3",
"meta_title": "test",
"meta_description": "test",
"featured": "1",
"is_call": "0",
"sort_order": "0",
"item_type_id": 1,
"custom_url": "",
"en": {
"name": "Test 20",
"slug": "test-20",
"summary": "Summary",
"description": "Description",
"meta_title": "test",
"meta_description": "test"
}
}
}
Response
{
"data": {
"id": 1,
"name": "Test",
"slug": "test",
"summary": "Summary",
"metaTitle": "",
"metaDescription": "",
"formattedPrice": "$0",
"description": "Description",
"createdAt": "2023-10-21 11:59:11",
"updatedAt": "2023-10-21 11:59:11",
"categoryId": 2,
"storeId": null,
"featured": "0",
"sortOrder": "0",
"visible": 0,
"url": "url/tienda/p/test",
"isCall": "0",
"showPriceIsCall": "0",
"totalTaxes": 0,
"mediaFiles": {
"mainimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"relativePath": "url/modules/icommerce/img/product/default.jpg",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "url/modules/icommerce/img/product/default.jpg",
"createdByUser": null,
"tags": [],
"thumbnails": [
{
"name": "smallThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "300x"
},
{
"name": "mediumThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "600x"
},
{
"name": "largeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "900x"
},
{
"name": "extraLargeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "1920x"
}
],
"smallThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeSmallThumb": "//modules/icommerce/img/product/default.jpg?u=",
"mediumThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeMediumThumb": "//modules/icommerce/img/product/default.jpg?u=",
"largeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeLargeThumb": "//modules/icommerce/img/product/default.jpg?u=",
"extraLargeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeExtraLargeThumb": "//modules/icommerce/img/product/default.jpg?u="
},
"gallery": [],
"secondaryimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"relativePath": "url/modules/icommerce/img/product/default.jpg",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "url/modules/icommerce/img/product/default.jpg",
"createdByUser": null,
"tags": [],
"thumbnails": [
{
"name": "smallThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "300x"
},
{
"name": "mediumThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "600x"
},
{
"name": "largeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "900x"
},
{
"name": "extraLargeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "1920x"
}
],
"smallThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeSmallThumb": "//modules/icommerce/img/product/default.jpg?u=",
"mediumThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeMediumThumb": "//modules/icommerce/img/product/default.jpg?u=",
"largeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeLargeThumb": "//modules/icommerce/img/product/default.jpg?u=",
"extraLargeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeExtraLargeThumb": "//modules/icommerce/img/product/default.jpg?u="
},
"quaternaryimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"relativePath": "url/modules/icommerce/img/product/default.jpg",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "url/modules/icommerce/img/product/default.jpg",
"createdByUser": null,
"tags": [],
"thumbnails": [
{
"name": "smallThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "300x"
},
{
"name": "mediumThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "600x"
},
{
"name": "largeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "900x"
},
{
"name": "extraLargeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "1920x"
}
],
"smallThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeSmallThumb": "//modules/icommerce/img/product/default.jpg?u=",
"mediumThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeMediumThumb": "//modules/icommerce/img/product/default.jpg?u=",
"largeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeLargeThumb": "//modules/icommerce/img/product/default.jpg?u=",
"extraLargeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeExtraLargeThumb": "//modules/icommerce/img/product/default.jpg?u="
}
},
"isNew": true,
"isAvailable": false,
"layoutId": null,
"isInternal": null,
"priceLists": []
}
}
Modify a Product
Use this endpoint to modify a product. You can send one or multiple values in the request. By default, the accepted value is the ID, but if you want to send another value, you need to include the following in the Query Parameters:
{
"filter": {
"field": "name" // The value by which the search will be conducted
}
}
PUT/api/icommerce/v3/products/{criteria}
- Minimum
- Rest
{
"attributes": {
"category_id": "2"
}
{
"attributes": {
"status": 1,
"category_id": "2",
"categories": [
"2"
],
"sku": "SKU-15",
"quantity": 1,
"stock_status": 1,
"price": "1000",
"date_available": "2023/10/21",
"weight_class_id": 1,
"volume_class_id": 1,
"lenght_class_id": 1,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"minimum": 1,
"reference": "",
"shipping": true,
"show_price_is_call": "0",
"subtract": true,
"freeshipping": true,
"order_weight": 0,
"rating": 3,
"points": 0,
"related_products": [],
"product_options": [],
"price_lists": [],
"medias_single": {
"mainimage": 349
},
"medias_multi": {
"gallery": {
"files": [
335,
336,
342
],
"orders": "335,336,342"
}
},
"manufacturer_id": "3",
"meta_title": "test",
"meta_description": "test",
"featured": "1",
"is_call": "0",
"sort_order": "0",
"item_type_id": 1,
"custom_url": "",
"en": {
"name": "Test 20",
"slug": "test-20",
"summary": "Summary",
"description": "Description",
"meta_title": "test",
"meta_description": "test"
}
}
}
Response
{
"data": "Item Updated"
}
Get Multiple Products
Use this endpoint to retrieve multiple products. You can filter the products, paginate them, and include additional data such as associated categories. The data that can be included is:
| Include | Description |
|---|---|
| categories | Fetches the categories associated with the product. |
| manufacturer | Fetches manufacturer data associated with the product. |
| tags | Fetches the tags associated with the product. |
Query Parameters:
GET/api/icommerce/v3/products
- Rest
{
"filter": {
"order": {
"field":"created_at",
"way":"desc"
}
},
"page": 1, // Page number of products
"take": 1, // Number of products to retrieve
"include": 'categories,manufacturer,tags'
}
Response
{
"data": [
{
"id": 1,
"name": "Test",
"slug": "test",
"summary": "This is a test",
"metaTitle": "",
"metaDescription": "",
"options": {
"masterRecord": 0,
"video": null
},
"sku": "HYUNG",
"quantity": 5,
"price": 2000,
"formattedPrice": "$2,000",
"dateAvailable": "2023-10-18",
"subtract": true,
"minimum": 1,
"description": "I don't know what else to add",
"createdAt": "2023-10-18 19:42:46",
"updatedAt": "2023-10-18 19:49:50",
"status": 1,
"stockStatus": 1,
"categoryId": 4,
"category": {
"id": 4,
"title": "World 1",
"h1Title": "",
"slug": "world-1",
"url": "...",
"newUrl": "...",
"description": "World 1",
"parentId": 0,
"showMenu": false,
"featured": false,
"sortOrder": "0",
"metaTitle": "World 1",
"metaDescription": "World 1",
"options": {
"masterRecord": "0",
"view": "1",
"descriptionIndex": null
},
"createdAt": "2023-09-21 17:44:59",
"updatedAt": "2023-09-21 17:44:59",
"status": "1",
"mediaFiles": {
"mainimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "...",
"relativePath": "...",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "..."
},
"secondaryimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "...",
"relativePath": "...",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "..."
},
"quaternaryimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "...",
"relativePath": "...",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "..."
},
"iconimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "...",
"relativePath": "...",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "..."
},
"bannerindeximage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "...",
"relativePath": "...",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "..."
},
"carouselindeximage": [],
"carouseltopindeximages": []
},
"layoutId": null
},
"storeId": null,
"featured": "1",
"sortOrder": "0",
"visible": 1,
"url": "...",
"isCall": "0",
"showPriceIsCall": "0",
"totalTaxes": 0,
"manufacturerId": 3,
"mediaFiles": {
...
},
"isNew": true,
"isAvailable": true,
"layoutId": null,
"isInternal": 0,
"advancedSummary": "Avanzado",
"priceLists": []
}
],
"meta": {
"page": {
"total": 8,
"lastPage": 8,
"perPage": 1,
"currentPage": 1
}
}
}
Get a Specific Product
Use this endpoint to retrieve a specific product.
GET/api/icommerce/v3/products/{criteria}
- Rest
{}
Response
{
"data": {
"id": 1,
"name": "Test",
"slug": "test",
"summary": "Resumen",
"metaTitle": "",
"metaDescription": "",
"formattedPrice": "$0",
"description": "Descripcion",
"createdAt": "2023-10-21 11:59:11",
"updatedAt": "2023-10-21 11:59:11",
"categoryId": 2,
"categories": [
{
"id": 1,
"title": "categoria",
"h1Title": "",
"slug": "categoria",
"url": "",
"newUrl": "",
"description": "categoria",
"parentId": 0,
"showMenu": false,
"featured": false,
"sortOrder": "0",
"metaTitle": "categoria",
"metaDescription": "categoria",
"options": {
"masterRecord": "0",
"view": "1",
"descriptionIndex": null
},
"createdAt": "2023-05-15 16:49:00",
"updatedAt": "2023-09-21 08:50:13",
"status": "1",
"mediaFiles": {...},
"layoutId": null
}
],
"storeId": null,
"featured": "0",
"sortOrder": "0",
"visible": 0,
"url": "url/tienda/p/test",
"isCall": "0",
"showPriceIsCall": "0",
"totalTaxes": 0,
"mediaFiles": {
"mainimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"relativePath": "url/modules/icommerce/img/product/default.jpg",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "url/modules/icommerce/img/product/default.jpg",
"createdByUser": null,
"tags": [],
"thumbnails": [
{
"name": "smallThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "300x"
},
{
"name": "mediumThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "600x"
},
{
"name": "largeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "900x"
},
{
"name": "extraLargeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "1920x"
}
],
"smallThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeSmallThumb": "//modules/icommerce/img/product/default.jpg?u=",
"mediumThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeMediumThumb": "//modules/icommerce/img/product/default.jpg?u=",
"largeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeLargeThumb": "//modules/icommerce/img/product/default.jpg?u=",
"extraLargeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeExtraLargeThumb": "//modules/icommerce/img/product/default.jpg?u="
},
"gallery": [],
"secondaryimage": {
"id": null,
"filename": null,
"mimeType": null,
"fileSize": null,
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"relativePath": "url/modules/icommerce/img/product/default.jpg",
"isImage": true,
"isVideo": false,
"isFolder": false,
"mediaType": false,
"folderId": null,
"description": null,
"alt": null,
"keywords": null,
"createdBy": null,
"createdAt": null,
"updatedAt": null,
"faIcon": "fa-file",
"disk": null,
"extension": null,
"url": "url/modules/icommerce/img/product/default.jpg",
"createdByUser": null,
"tags": [],
"thumbnails": [
{
"name": "smallThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "300x"
},
{
"name": "mediumThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "600x"
},
{
"name": "largeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "900x"
},
{
"name": "extraLargeThumb",
"path": "url/modules/icommerce/img/product/default.jpg?u=",
"size": "1920x"
}
],
"smallThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeSmallThumb": "//modules/icommerce/img/product/default.jpg?u=",
"mediumThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeMediumThumb": "//modules/icommerce/img/product/default.jpg?u=",
"largeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeLargeThumb": "//modules/icommerce/img/product/default.jpg?u=",
"extraLargeThumb": "url/modules/icommerce/img/product/default.jpg?u=",
"relativeExtraLargeThumb": "//modules/icommerce/img/product/default.jpg?u="
}
},
"isNew": true,
"isAvailable": false,
"layoutId": null,
"isInternal": null,
"priceLists": []
}
}
Delete a Product
Use this endpoint to delete a specific product by sending the product's ID.
DELETE/api/icommerce/v3/products/{id}
- Rest
{}
Response
{
"data": "Request successful"
}
Product Fields
| id | Type:IntegerDescription: This is the unique identification of the product, automatically generated each time it is created. |
| sku | Type:VarcharDescription: This is the product identification used in bulk synchronization, in addition to the ID. Maximum length of 191 characters. |
| status | Type:Boolean (0 | 1)Description: Product status: Inactive |
| category_id | Type:IntegerDescription: Identification of the category to which the product belongs. |
| quantity | Type:IntegerDescription: Available quantity of the product in inventory. |
| stock_status | Type:Boolean (0 | 1)Description: Product stock status: Out of stock |
| manufacturer_id | Type:IntegerDescription: Identification of the product's manufacturer. |
| shipping | Type:Boolean (0 | 1)Description: Indicates whether the product can be shipped: No |
| subtract | Type:Boolean (0 | 1)Description: Indicates whether the stock quantity is reduced when a sale is made: No |
| featured | Type:Boolean (0 | 1)Description: Indicates whether the product is featured: No |
| freeshipping | Type:Boolean (0 | 1)Description: Indicates whether the product's shipping is free: No |
| is_call | Type:Boolean (0 | 1)Description: Indicates whether the product can be quoted: No |
| show_price_is_call | Type:Boolean (0 | 1)Description: Indicates whether the product's price should be displayed: No |
| price | Type:double(30,2)Description: Product price. |
| points | Type:IntegerDescription: Points associated with the product. |
| date_available | Type:DateDescription: Date when the product will be available. |
| weight | Type:double(8,2)Description: Product weight. |
| length | Type:double(8,2)Description: Product length. |
| width | Type:double(8,2)Description: Product width. |
| height | Type:double(8,2)Description: Product height. |
| reference | Type:VarcharDescription: Reference associated with the product. |
| name | Type:TextDescription: Product name. Translatable. |
| sort_order | Type:IntegerDescription: Product sorting order. |
| custom_url | Type:VarcharDescription: Custom or friendly URL assigned to the product. |
| description | Type:TextDescription: Detailed product description. Translatable. |
| summary | Type:TextDescription: Product summary. Translatable. |
| slug | Type:VarcharDescription: Friendly URL or slug for the product. Translatable. Limit of 191 characters. |
| meta_title | Type:VarcharDescription: Meta title for the product. Translatable. Limit of 191 characters. |
| meta_description | Type:TextDescription: Meta description for the product. Translatable. Limit of 191 characters. |
| advanced_summary | Type:TextDescription: Advanced product summary. Translatable. |
| weight_class_id | Type:IntegerDescription: Id of WeightClass |
| lenght_class_id | Type:IntegerDescription: Id of LengthClass |
| volume_class_id | Type:IntegerDescription: Id of VolumeClass |
If you need further assistance or have any questions about how to fill out these fields, please don't hesitate to contact our support team.