Catalog Product API
Product API
Create Simple Product API
API Endpoint: /api/pim/catalog/product/create
Method: POST
Request
{
"seller_sku": "w-tshirt-for-wm-2000",
"type_id": "simple",
"category": 1462,
"name": "White Tshirt For Women/Men",
"status": "enable",
"price": 500,
"quantity": 500,
"special_from_date": "2021-08-14 00:00:00",
"special_price": 250,
"special_to_date": "2025-01-01 00:00:00",
"description": "This is long description text",
"short_description": "This is short_description text",
"brand_name": "No brand",
"color": "Black",
"fit": "Relaxed fit",
"ideal_for": "Men",
"main_image": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BEIGE.jpg",
"image1": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BROWN.jpg",
"image2": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000GREEN.jpg",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"materials": "Cotton",
"occasion": "Work",
"product_type": "Tee",
"sleeves": "Half",
"pattern": "",
"length": "",
"warranty_type": "No Warranty",
"warranty_period": "",
"return_exchange": "Yes",
"whats_in_the_box": "",
"weight": 1.5,
"product_has_weight": "",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "White Tee For Women/Men|T-shirts|Sastodeal",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
]
}
Response
HTTP_STATUS: 200
{
"detail": "Successfully saved changes.",
"item": {
"_id": "62d748cf586ecfda503d6584",
"sku": "sd-275846-1462-w-tshirt-for-wm-2000",
"brand_name": "No brand",
"category": [
1456,
1459,
1462
],
"color": "Black",
"created_at": "2022-07-20 00:14:07",
"description": "This is long description text",
"fit": "Relaxed fit",
"gallery": [
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/e/SHS1000BEIGE.jpg",
"types": [
"image",
"small_image",
"thumbnail"
]
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/r/SHS1000BROWN.jpg",
"types": []
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/g/r/SHS1000GREEN.jpg",
"types": []
}
],
"ideal_for": "Men",
"image1": "",
"image2": "",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"inventory": [
{
"source_code": "KTDU",
"quantity": 500
}
],
"length": "",
"main_image": "",
"materials": "Cotton",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "White Tee For Women/Men|T-shirts|Sastodeal",
"name": "White Tshirt For Women/Men",
"occasion": "Work",
"pattern": "",
"price": 500,
"product_has_weight": "",
"product_type": "Tee",
"return_exchange": "Yes",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
],
"seller_sku": "w-tshirt-for-wm-2000",
"short_description": "This is short_description text",
"sleeves": "Half",
"special_from_date": "2021-08-14 00:00:00",
"special_price": 250,
"special_to_date": "2025-01-01 00:00:00",
"status": "enable",
"type_id": "simple",
"updated_at": "2022-07-20 00:14:07",
"url_key": "sd-275846-1462-w-tshirt-for-wm-2000",
"warranty_period": "",
"warranty_type": "No Warranty",
"weight": 1.5,
"whats_in_the_box": ""
}
}
Create Variable Product API
API Endpoint: /api/pim/catalog/product/create
Method: POST
Request
{
"seller_sku": "cf-tshirt-for-wm-4000",
"type_id": "variable",
"category": 1462,
"name": "Color full TShirt For Women/Men",
"status": "enable",
"variable_products": [
{
"name": "Black TShirt For Women/Men",
"seller_sku": "cf-tshirt-for-wm-4000-b",
"status": "enable",
"main_image": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BEIGE.jpg",
"image1": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BROWN.jpg",
"image2": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000GREEN.jpg",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"price": 800,
"quantity": 500,
"special_from_date": "2021-08-14 00:00:00",
"special_price": 720,
"special_to_date": "2025-01-01 00:00:00",
"color": "Black"
},
{
"name": "White TShirt For Women/Men",
"seller_sku": "cf-tshirt-for-wm-4000-w",
"status": "enable",
"main_image": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BEIGE.jpg",
"image1": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BROWN.jpg",
"image2": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000GREEN.jpg",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"price": 800,
"quantity": 500,
"special_from_date": "2021-08-14 00:00:00",
"special_price": 720,
"special_to_date": "2025-01-01 00:00:00",
"color": "White"
}
],
"brand_name": "No brand",
"description": "This is long description text",
"short_description": "This is short_description text",
"fit": "Relaxed fit",
"ideal_for": "Men",
"main_image": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BEIGE.jpg",
"image1": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BROWN.jpg",
"image2": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000GREEN.jpg",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"materials": "Cotton",
"occasion": "Work",
"product_type": "Tee",
"sleeves": "Half",
"pattern": "",
"length": "",
"warranty_type": "No Warranty",
"warranty_period": "",
"return_exchange": "Yes",
"whats_in_the_box": "",
"weight": 1.5,
"product_has_weight": "",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "Color full Tee For Women/Men|T-shirts|Sastodeal",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
]
}
Response
HTTP_STATUS: 200
{
"detail": "Successfully saved changes.",
"item": {
"_id": "62d74a12586ecfda503d7dc7",
"sku": "sd-275846-1462-cf-tshirt-for-wm-4000",
"brand_name": "No brand",
"category": [
1456,
1459,
1462
],
"created_at": "2022-07-20 00:19:30",
"description": "This is long description text",
"fit": "Relaxed fit",
"gallery": [
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/e/SHS1000BEIGE.jpg",
"types": [
"image",
"small_image",
"thumbnail"
]
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/r/SHS1000BROWN.jpg",
"types": []
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/g/r/SHS1000GREEN.jpg",
"types": []
}
],
"ideal_for": "Men",
"image1": "",
"image2": "",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"length": "",
"main_attributes": [],
"main_image": "",
"materials": "Cotton",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "Color full Tee For Women/Men|T-shirts|Sastodeal",
"name": "Color full TShirt For Women/Men",
"occasion": "Work",
"pattern": "",
"product_has_weight": "",
"product_type": "Tee",
"return_exchange": "Yes",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
],
"seller_sku": "cf-tshirt-for-wm-4000",
"short_description": "This is short_description text",
"sleeves": "Half",
"status": "enable",
"type_id": "variable",
"updated_at": "2022-07-20 00:19:30",
"url_key": "sd-275846-1462-cf-tshirt-for-wm-4000",
"variable_products": [
{
"name": "Black TShirt For Women/Men",
"seller_sku": "cf-tshirt-for-wm-4000-b",
"status": "enable",
"main_image": "",
"image1": "",
"image2": "",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"price": 800,
"special_from_date": "2021-08-14 00:00:00",
"special_price": 720,
"special_to_date": "2025-01-01 00:00:00",
"color": "Black",
"inventory": [
{
"source_code": "KTDU",
"quantity": 500
}
],
"sku": "sd-275846-1462-cf-tshirt-for-wm-4000-b",
"url_key": "sd-275846-1462-cf-tshirt-for-wm-4000-b",
"gallery": [
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/e/SHS1000BEIGE.jpg",
"types": [
"image",
"small_image",
"thumbnail"
]
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/r/SHS1000BROWN.jpg",
"types": []
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/g/r/SHS1000GREEN.jpg",
"types": []
}
]
},
{
"name": "White TShirt For Women/Men",
"seller_sku": "cf-tshirt-for-wm-4000-w",
"status": "enable",
"main_image": "",
"image1": "",
"image2": "",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"price": 800,
"special_from_date": "2021-08-14 00:00:00",
"special_price": 720,
"special_to_date": "2025-01-01 00:00:00",
"color": "White",
"inventory": [
{
"source_code": "KTDU",
"quantity": 500
}
],
"sku": "sd-275846-1462-cf-tshirt-for-wm-4000-w",
"url_key": "sd-275846-1462-cf-tshirt-for-wm-4000-w",
"gallery": [
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/e/SHS1000BEIGE.jpg",
"types": [
"image",
"small_image",
"thumbnail"
]
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/r/SHS1000BROWN.jpg",
"types": []
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/g/r/SHS1000GREEN.jpg",
"types": []
}
]
}
],
"warranty_period": "",
"warranty_type": "No Warranty",
"weight": 1.5,
"whats_in_the_box": ""
}
}
Product List API
API Endpoint: /api/pim/catalog/product
Method: GET
Response
HTTP_STATUS: 200
{
"data_collection": {
"meta": {
"per_page": 20,
"result_count": 1,
"total_count": 1,
"last_page": 1,
"current_page": 1,
"from": 0,
"to": 20
},
"results": [
{
"_id": "62d748cf586ecfda503d6584",
"sku": "sd-275846-1462-w-tshirt-for-wm-2000",
"brand_name": "No brand",
"category": [
1456,
1459,
1462
],
"color": "Black",
"created_at": "2022-07-20 00:14:07",
"description": "This is long description text",
"fit": "Relaxed fit",
"gallery": [
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/e/SHS1000BEIGE.jpg",
"types": [
"image",
"small_image",
"thumbnail"
]
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/r/SHS1000BROWN.jpg",
"types": []
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/g/r/SHS1000GREEN.jpg",
"types": []
}
],
"ideal_for": "Men",
"image1": "",
"image2": "",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"inventory": [
{
"source_code": "KTDU",
"quantity": 500
}
],
"length": "",
"main_image": "",
"materials": "Cotton",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "White Tee For Women/Men|T-shirts|Sastodeal",
"name": "White Tshirt For Women/Men",
"occasion": "Work",
"pattern": "",
"price": 500,
"product_has_weight": "",
"product_type": "Tee",
"return_exchange": "Yes",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
],
"seller_sku": "w-tshirt-for-wm-2000",
"short_description": "This is short_description text",
"sleeves": "Half",
"special_from_date": "2021-08-14 00:00:00",
"special_price": 250,
"special_to_date": "2025-01-01 00:00:00",
"status": "enable",
"type_id": "simple",
"updated_at": "2022-07-20 00:14:07",
"url_key": "sd-275846-1462-w-tshirt-for-wm-2000",
"warranty_period": "",
"warranty_type": "No Warranty",
"weight": 1.5,
"whats_in_the_box": ""
}
]
}
}
Update Product API
API Endpoint: /api/pim/catalog/product/{{sku / seller_sku}}
API Endpoint: /api/pim/catalog/product/w-tshirt-for-wm-2000
Method: POST
Request
{
"seller_sku": "w-tshirt-for-wm-2000",
"type_id": "simple",
"category": 1462,
"name": "White Tshirt For Women/Men - updated",
"status": "enable",
"price": 500,
"quantity": 500,
"special_from_date": "2021-08-14 00:00:00",
"special_price": 250,
"special_to_date": "2025-01-01 00:00:00",
"description": "This is long description text",
"short_description": "This is short_description text",
"brand_name": "No brand",
"color": "Black",
"fit": "Relaxed fit",
"ideal_for": "Men",
"main_image": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BEIGE.jpg",
"image1": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000BROWN.jpg",
"image2": "https://cdn.sastodeal.com/catalog/product/18678/SHACKET(SHS1000)-01/SHS1000GREEN.jpg",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"materials": "Cotton",
"occasion": "Work",
"product_type": "Tee",
"sleeves": "Half",
"pattern": "",
"length": "",
"warranty_type": "No Warranty",
"warranty_period": "",
"return_exchange": "Yes",
"whats_in_the_box": "",
"weight": 1.5,
"product_has_weight": "",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "White Tee For Women/Men|T-shirts|Sastodeal",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
]
}
Response
HTTP_STATUS: 200
{
"detail": "Successfully saved changes.",
"item": {
"_id": "62d748cf586ecfda503d6584",
"sku": "sd-275846-1462-w-tshirt-for-wm-2000",
"brand_name": "No brand",
"category": [
1456,
1459,
1462
],
"color": "Black",
"created_at": "2022-07-20 00:14:07",
"description": "This is long description text",
"fit": "Relaxed fit",
"gallery": [
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/e/SHS1000BEIGE.jpg",
"types": [
"image",
"small_image",
"thumbnail"
]
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/r/SHS1000BROWN.jpg",
"types": []
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/g/r/SHS1000GREEN.jpg",
"types": []
}
],
"ideal_for": "Men",
"image1": "",
"image2": "",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"inventory": [
{
"source_code": "KTDU",
"quantity": 500
}
],
"length": "",
"main_image": "",
"materials": "Cotton",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "White Tee For Women/Men|T-shirts|Sastodeal",
"name": "White Tshirt For Women/Men - updated",
"occasion": "Work",
"pattern": "",
"price": 500,
"product_has_weight": "",
"product_type": "Tee",
"return_exchange": "Yes",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
],
"seller_sku": "w-tshirt-for-wm-2000",
"short_description": "This is short_description text",
"sleeves": "Half",
"special_from_date": "2021-08-14 00:00:00",
"special_price": 250,
"special_to_date": "2025-01-01 00:00:00",
"status": "enable",
"type_id": "simple",
"updated_at": "2022-07-20 00:31:12",
"url_key": "sd-275846-1462-w-tshirt-for-wm-2000",
"warranty_period": "",
"warranty_type": "No Warranty",
"weight": 1.5,
"whats_in_the_box": ""
}
}
Single Product View API
API Endpoint: /api/pim/catalog/product/{{sku / seller_sku}}
API Endpoint: /api/pim/catalog/product/w-tshirt-for-wm-2000
Method: GET
Response
HTTP_STATUS: 200
{
"item": {
"_id": "62d748cf586ecfda503d6584",
"sku": "sd-275846-1462-w-tshirt-for-wm-2000",
"brand_name": "No brand",
"category": [
1456,
1459,
1462
],
"color": "Black",
"created_at": "2022-07-20 00:14:07",
"description": "This is long description text",
"fit": "Relaxed fit",
"gallery": [
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/e/SHS1000BEIGE.jpg",
"types": [
"image",
"small_image",
"thumbnail"
]
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/b/r/SHS1000BROWN.jpg",
"types": []
},
{
"media_type": "image",
"title": "",
"path_name": "/media/seller/275846/s/h/s/g/r/SHS1000GREEN.jpg",
"types": []
}
],
"ideal_for": "Men",
"image1": "",
"image2": "",
"image3": null,
"image4": null,
"image5": null,
"image6": null,
"image7": null,
"image8": null,
"inventory": [
{
"source_code": "KTDU",
"quantity": 500
}
],
"length": "",
"main_image": "",
"materials": "Cotton",
"meta_keyword": "Apparel,Sports wear,Tshirt,Tees,Pants,Joggers",
"meta_title": "White Tee For Women/Men|T-shirts|Sastodeal",
"name": "White Tshirt For Women/Men - updated",
"occasion": "Work",
"pattern": "",
"price": 500,
"product_has_weight": "",
"product_type": "Tee",
"return_exchange": "Yes",
"seller_attributes": [
{
"code": "new_one_attr",
"label": "New one Attr",
"value": "Value 1"
},
{
"code": "new_two_attr",
"label": "New two Attr",
"value": "Value 2"
}
],
"seller_sku": "w-tshirt-for-wm-2000",
"short_description": "This is short_description text",
"sleeves": "Half",
"special_from_date": "2021-08-14 00:00:00",
"special_price": 250,
"special_to_date": "2025-01-01 00:00:00",
"status": "enable",
"type_id": "simple",
"updated_at": "2022-07-20 00:31:12",
"url_key": "sd-275846-1462-w-tshirt-for-wm-2000",
"warranty_period": "",
"warranty_type": "No Warranty",
"weight": 1.5,
"whats_in_the_box": ""
}
}
Bulk Product Price Update API
API Endpoint: /api/pim/catalog/product-bulk/price
Method: POST
Request
{
"items": [
{
"seller_sku": "w-tshirt-for-wm-2000",
"price": 400
},
{
"sku": "sd-275846-1462-cf-tshirt-for-wm-4000-b",
"price": 600,
"special_price": 500,
"special_from_date": "2021-07-16 00:00:00",
"special_to_date": "2024-07-16 00:00:00"
},
{
"seller_sku": "cf-tshirt-for-wm-4000-w",
"price": 700,
"special_price": null,
"special_from_date": null,
"special_to_date": null
}
]
}
Response
HTTP_STATUS: 200
{
"detail": "Successfully saved changes."
}
Error Response
HTTP_STATUS: 400
{
"title": "An error occurred in few records",
"status": 400,
"detail": "An error occurred in few records",
"bulk_errors": [
{
"array_key": 2,
"array_data": {
"seller_sku": "cf-tshirt-for-wm-4000-w-non-existing",
"price": 700,
"special_price": null,
"special_from_date": null,
"special_to_date": null
},
"errors": {
"increment_id": {
"errors": [
"cf-tshirt-for-wm-4000-w-non-existing Seller sku not exist."
]
}
}
}
]
}
About bulk price update API
skuorseller_skucan be used to update product price.- Directly
skuorseller_skuof variable product can be used. - If the value is
null, field will be unset.
| Field Name | Description |
|---|---|
| sku | Sku of Product |
| seller_sku | Sku provided by seller |
| price | Price of Product |
| special_price | Discount price offered by seller. To unset value need to pass null value. |
| special_to_date | Discount Price start date, suppoted format (yyyy-mm-dd h:i:s), To unset value need to pass null value. |
| special_from_date | Discount Price to date suppoted format (yyyy-mm-dd h:i:s) To unset value need to pass null value. |
Bulk Product Stock Update API
API Endpoint: /api/pim/catalog/product-bulk/stock
Method: POST
Request
{
"items": [
{
"seller_sku": "w-tshirt-for-wm-2000",
"quantity": 10
},
{
"sku": "sd-275846-1462-cf-tshirt-for-wm-4000-b",
"quantity": 20
}
]
}
Response
HTTP_STATUS: 200
{
"detail": "Successfully saved changes."
}
Error Response
HTTP_STATUS: 400
{
"title": "An error occurred in few records",
"status": 400,
"detail": "An error occurred in few records",
"bulk_errors": [
{
"array_key": 2,
"array_data": {
"seller_sku": "cf-tshirt-for-wm-4000-w-non-existing",
"quantity": 30
},
"errors": {
"general": {
"errors": [
"Couldn't find document to update."
]
}
}
}
]
}
About bulk stock update API
skuorseller_skucan be used to update product price.- Directly
skuorseller_skuof variable product can be used. - If the value is
null, field will be unset.
| Field Name | Description |
|---|---|
| sku | Sku of Product |
| seller_sku | Sku provided by seller |
| quantity | Stock quantity of Product |