-
Introduction 1
-
Introduction (video) 02 minLecture1.1
-
API2Cart: Benefits for developers 02 minLecture1.2
-
Industries that can benefit from API2Cart 04 minLecture1.3
-
Quiz yourself 3 questionsQuiz1.1
-
-
Start Building Your Integration 1
-
How to Get Started with API2Cart 06 minLecture2.1
-
API methods to work with carts 04 minLecture2.2
-
API methods to work with products from stores 04 minLecture2.3
-
API methods to work with orders from stores and shipments 04 minLecture2.4
-
API2Cart: Use Case (example) 03 minLecture2.5
-
Quiz yourself 2 6 questionsQuiz2.1
-
-
Frequently asked questions during integration development 0
-
How to update the credit card number in the subscription? 04 minLecture3.1
-
Is there a timeout set for the request from API2Cart server to the store? 02 minLecture3.2
-
What is the reason for appearing of 404-error on the integration bridge page even after clearing all the cache and rebuilding the indexes? 02 minLecture3.3
-
Why is it better to integrate with multiple shopping platforms via a unified API of API2Cart than to build the integration with each platform separately on my own? 04 minLecture3.4
-
How to install Magento 2 Plugin? 01 minLecture3.5
-
API methods to work with products from stores
The main API methods to work with products from stores. With their help, you can count items, get and update product lists and details, add variants and options together with currencies, taxes and manufacturers, etc.
1. product.list
This method lets API2Cart users get the list of products from the store. It returns 10 products by default.
Response structure:
{
"return_code": int,
"return_message": string,
"result":{
"products_count": int,
"product":[ array
{
"id": string,
"type": string,
"u_model": string,
"u_sku": string,
"name": string,
"description": string,
"short_description": string,
"price": decimal,
"quantity": int,
"u_brand": string,
"categories_ids": string,
"stores_ids": string,
"url": string,
"seo_url": string,
"meta_title": string,
"meta_keywords": string,
"meta_description": string,
"avail_sale": string,
"avail_view": string,
"weight": decimal,
"sort_order": int,
"backorders": string,
"manage_stock": string,
"create_at": string,
"modified_at": string,
"tax_class_id": string,
"dimensions_unit": string,
"width": decimal,
"height": decimal,
"length": decimal,
"special_price":[ array
{
"value": decimal,
"avail": string,
"created_at": string,
"modified_at": string,
"expired_at": string
}
],
"tier_price":[ array
{
"tier_price_count1": int,
"tier_price_value1": decimal,
"tier_prices_count": int
...
}
],
"group_price":[ array
{
"id": string,
"group_id": string,
"price": decimal,
"store_id": string,
"quantity": decimal,
"start_time": string,
"expire_time": string
},
...
],
"images":[ array
{
"item":[ array
{
"http_path": string,
"type": string,
"mime-type": string,
"alt": string,
"avail": string,
"file_name": string,
"create_at": string,
"modified_at": string,
"size": int
},
...
]
}
],
"product_options":[ array,
{
"option":[ array
{
"id": string,
"product_option_id": string,
"name": string,
"type": string,
"required": string,
"option_value":[ array
{
"value":[ array
{
"id": string,
"product_option_value_id": string,
"name": string,
"price": decimal,
"type_price": string,
"quantity": int
},
...
]
}
]
},
...
]
}
],
"product_variants":[ array,
{
"product_variant":[ array
{
"id": string,
"attribute_set_name": string,
"type": string,
"u_model": string,
"u_sku": string,
"name": string,
"description": string,
"price": decimal,
"quantity": int,
"u_brand_id": string,
"u_brand": string,
"categories_ids": string,
"url": string,
"seo_url": string,
"meta_title": string,
"meta_keywords": string,
"meta_description": string,
"avail_sale": string,
"avail_view": string,
"weight": decimal,
"sort_order": int,
"create_at": string,
"modified_at": string,
"special_price":[ array
{
"value": decimal,
"avail": string,
"created_at": string,
"modified_at": string,
"expired_at": string
}
],
"tax_class_id": string,
"images": array,
"u_upc": string,
"u_mpn": string,
"categories": deprecated,
"combinations":[ array
{
"combination":[ array
{
"name": string,
"option_id": string,
"value_id": string
},
{
"name": string,
"option_id": string,
"value_id": string
}
...
]
}
]
},
...
]
}
],
"u_upc": string,
"u_mpn": string,
"categories": deprecated,
"related_products_ids": string,
"tax_class":[ deprecated
{
"tax_class_id": string,
"name": string,
"created_at": string,
"modified_at": string,
"value": deprecated,
"avail": string,
"value_type": int,
"tax_rates":[ array
{
"tax_rate":[ array
{
"tax_rate_id": string,
"name": string,
"type": int,
"value": decimal,
"create_at": string,
"modified_at": string
},
...
]
}
]
}
],
},
...
]
}
}
2. product.info
This method allows retrieving products with related information, including name, description, price, category and all needed data.
Response structure:
{
"return_code": int,
"return_message": string,
"result":{
"id": string,
"type": string,
"u_model": string,
"u_sku": string,
"name": string,
"description": string,
"short_description": string,
"price": decimal,
"quantity": int,
"u_brand": string,
"categories_ids": string,
"stores_ids": string,
"url": string,
"seo_url": string,
"meta_title": string,
"meta_keywords": string,
"meta_description": string,
"avail_sale": string,
"avail_view": string,
"weight": decimal,
"sort_order": int,
"backorders": string,
"manage_stock": string,
"create_at": string,
"modified_at": string,
"tax_class_id": string,
"dimensions_unit": string,
"width": decimal,
"height": decimal,
"length": decimal,
"special_price":[ array
{
"value": decimal,
"avail": string,
"created_at": string,
"modified_at": string,
"expired_at": string
}
],
"tier_price":[ array
{
"tier_price_count1": int,
"tier_price_value1": decimal,
"tier_prices_count": int
...
}
],
"group_price":[ array
{
"id": string,
"group_id": string,
"price": decimal,
"store_id": string,
"quantity": decimal,
"start_time": string,
"expire_time": string
},
...
],
"images":[ array
{
"item":[ array
{
"http_path": string,
"type": string,
"mime-type": string,
"alt": string,
"avail": string,
"file_name": string,
"create_at": string,
"modified_at": string,
"size": int
},
...
]
}
],
"product_options":[ array,
{
"option":[ array
{
"id": string,
"product_option_id": string,
"name": string,
"type": string,
"required": string,
"option_value":[ array
{
"value":[ array
{
"id": string,
"product_option_value_id": string,
"name": string,
"price": decimal,
"type_price": string,
"quantity": int
},
...
]
}
]
},
...
]
}
],
"product_variants":[ array,
{
"product_variant":[ array
{
"id": string,
"attribute_set_name": string,
"type": string,
"u_model": string,
"u_sku": string,
"name": string,
"description": string,
"price": decimal,
"quantity": int,
"u_brand_id": string,
"u_brand": string,
"categories_ids": string,
"url": string,
"seo_url": string,
"meta_title": string,
"meta_keywords": string,
"meta_description": string,
"avail_sale": string,
"avail_view": string,
"weight": decimal,
"sort_order": int,
"create_at": string,
"modified_at": string,
"special_price":[ array
{
"value": decimal,
"avail": string,
"created_at": string,
"modified_at": string,
"expired_at": string
}
],
"tax_class_id": string,
"images": array,
"u_upc": string,
"u_mpn": string,
"categories": deprecated,
"combinations":[ array
{
"combination":[ array
{
"name": string,
"option_id": string,
"value_id": string
},
{
"name": string,
"option_id": string,
"value_id": string
}
...
]
}
]
},
...
]
}
],
"u_upc": string,
"u_mpn": string,
"categories": deprecated,
"related_products_ids": string,
"tax_class":[ deprecated
{
"tax_class_id": string,
"name": string,
"created_at": string,
"modified_at": string,
"value": deprecated,
"avail": string,
"value_type": int,
"tax_rates":[ array
{
"tax_rate":[ array
{
"tax_rate_id": string,
"name": string,
"type": int,
"value": decimal,
"create_at": string,
"modified_at": string
},
...
]
}
]
}
]
}
}
3. product.add
This method allows adding products to the store.
Response structure:
{
"return_code": int,
"return_message": string,
"result":{
"product_id": string
}
}
4. product.delete
This method provides you with the possibility to delete products from the store.
Response structure:
{
"return_code": int,
"return_message": string,
"result":{
"delete_items": int
}
}
The whole list of API methods to work with products and their details you can find here: Product