Magento 2 Custom Stock Status API & Examples
GETGet label, image product
{{magento_base_url}}/rest/V1/products?searchCriteria[filter_groups][0][filters][0][field]
=sku&searchCriteria[filter_groups][0][filters][0][value]
=24-WB01&searchCriteria[filter_groups][0][filters][0][condition_type]
=eq
AUTHORIZATIONBearer Token
Token
<token>
HEADERS
Content-Type
application/json
Authorization
Bearer {{admin_tocken}}
PARAMS
searchCriteria[filter_groups][0][filters][0][field]
sku
searchCriteria[filter_groups][0][filters][0][value]
24-WB01
searchCriteria[filter_groups][0][filters][0][condition_type]
eq
Example Request
Add label, image Product Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/products?searchCriteria[filter_groups][0][filters][0][field]%0A=sku&searchCriteria[filter_groups][0][filters][0][value]%0A=24-WB01&searchCriteria[filter_groups][0][filters][0][condition_type]%0A=eq' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin_tocken}}'200 OK
Example Response
json
{
"items": [
{
"id": 8,
"sku": "24-WB01",
"name": "Voyage Yoga Bag",
"attribute_set_id": 15,
"price": 32,
"status": 1,
"visibility": 4,
"type_id": "simple",
"created_at": "2020-02-28 03:23:48",
"updated_at": "2020-02-28 03:23:48",
"extension_attributes": {
"website_ids": [
1
],
"category_links": [
{
"position": 0,
"category_id": "3"
},
{
"position": 0,
"category_id": "4"
}
],
"mp_label_data": [
{
"id": 1,
"name": "test",
"enabled": 1,
"store_ids": "0",
"customer_group_ids": "0,1,2,3",
"priority": 0,
"label_template": "http://dev.mageplaza.vn/api/api2/pub/static/version1585620705/frontend/Magento/luma/en_US/Mageplaza_ProductLabels/images/template/p1/PL_Final_P1-17.png",
"label_image": null,
"label": null,
"label_front": "Roboto",
"label_font_size": "14",
"label_color": "#FFFFFF",
"label_css": "#design-label-text {top:32%; left:66%; transform: translateX(-50%) translateY(-50%) rotate(42deg)} #design-labels{margin-top:-8px; margin-left:8px}",
"label_position": "{\"label\":{\"top\":0,\"left\":126,\"width\":136,\"height\":124,\"percentTop\":0,\"percentLeft\":100}}",
"label_position_grid": "tr",
"same": 1,
"list_template": "http://dev.mageplaza.vn/api/api2/pub/static/version1585620705/frontend/Magento/luma/en_US/Mageplaza_ProductLabels/images/template/p1/PL_Final_P1-17.png",
"list_image": null,
"list_label": null,
"list_font": "Roboto",
"list_font_size": "14",
"list_color": "#FFFFFF",
"list_css": "#design-label-text {top:32%; left:66%; transform: translateX(-50%) translateY(-50%) rotate(42deg)} #design-labels{margin-top:-8px; margin-left:8px}",
"list_position": "{\"label\":{\"top\":0,\"left\":126,\"width\":136,\"height\":124,\"percentTop\":0,\"percentLeft\":100}}",
"list_position_grid": null,
"conditions_serialized": "{\"type\":\"Magento\\\\CatalogRule\\\\Model\\\\Rule\\\\Condition\\\\Combine\",\"attribute\":null,\"operator\":null,\"value\":\"1\",\"is_value_processed\":null,\"aggregator\":\"all\",\"conditions\":[{\"type\":\"Magento\\\\CatalogRule\\\\Model\\\\Rule\\\\Condition\\\\Product\",\"attribute\":\"attribute_set_id\",\"operator\":\"==\",\"value\":\"15\",\"is_value_processed\":false}]}",
"best_seller": 0,
"limit": null,
"from_date": "2020-03-01",
"to_date": "2020-04-30",
"stop_process": 0,
"updated_at": "2020-03-30 06:37:40",
"created_at": "2020-03-30 06:37:38"
}
]
},
"product_links": [
{
"sku": "24-WB01",
"link_type": "crosssell",
"linked_product_sku": "24-UG07",
"linked_product_type": "simple",
"position": 1
},
{
"sku": "24-WB01",
"link_type": "crosssell",
"linked_product_sku": "24-WG082-pink",
"linked_product_type": "simple",
"position": 2
},
{
"sku": "24-WB01",
"link_type": "crosssell",
"linked_product_sku": "24-WG087",
"linked_product_type": "simple",
"position": 3
},
{
"sku": "24-WB01",
"link_type": "crosssell",
"linked_product_sku": "24-WG085_Group",
"linked_product_type": "grouped",
"position": 4
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-MB01",
"linked_product_type": "simple",
"position": 1
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-MB03",
"linked_product_type": "simple",
"position": 3
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-MB05",
"linked_product_type": "simple",
"position": 4
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-MB06",
"linked_product_type": "simple",
"position": 5
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-MB02",
"linked_product_type": "simple",
"position": 2
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-UB02",
"linked_product_type": "simple",
"position": 6
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-WB06",
"linked_product_type": "simple",
"position": 9
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-WB03",
"linked_product_type": "simple",
"position": 7
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-WB07",
"linked_product_type": "simple",
"position": 10
},
{
"sku": "24-WB01",
"link_type": "upsell",
"linked_product_sku": "24-WB04",
"linked_product_type": "simple",
"position": 8
}
],
"options": [],
"media_gallery_entries": [
{
"id": 11,
"media_type": "image",
"label": "Image",
"position": 1,
"disabled": false,
"types": [
"image",
"small_image",
"thumbnail"
],
"file": "/w/b/wb01-black-0.jpg"
}
],
"tier_prices": [],
"custom_attributes": [
{
"attribute_code": "image",
"value": "/w/b/wb01-black-0.jpg"
},
{
"attribute_code": "small_image",
"value": "/w/b/wb01-black-0.jpg"
},
{
"attribute_code": "thumbnail",
"value": "/w/b/wb01-black-0.jpg"
},
{
"attribute_code": "options_container",
"value": "container2"
},
{
"attribute_code": "msrp_display_actual_price_type",
"value": "0"
},
{
"attribute_code": "url_key",
"value": "voyage-yoga-bag"
},
{
"attribute_code": "required_options",
"value": "0"
},
{
"attribute_code": "has_options",
"value": "0"
},
{
"attribute_code": "tax_class_id",
"value": "2"
},
{
"attribute_code": "category_ids",
"value": [
"3",
"4"
]
},
{
"attribute_code": "description",
"value": "<p>Everything you need for a trip to the gym will fit inside this surprisingly spacious Voyage Yoga Bag. Stock it with a water bottle, change of clothes, pair of shoes, and even a few beauty products. Fits inside a locker and zips shut for security.</p>\n<ul>\n<li>Slip pocket on front.</li>\n<li>Contrast piping.</li>\n<li>Durable nylon construction.</li>\n</ul>"
},
{
"attribute_code": "activity",
"value": "5438,5435"
},
{
"attribute_code": "style_bags",
"value": "5456,5457"
},
{
"attribute_code": "material",
"value": "5464,5465"
},
{
"attribute_code": "strap_bags",
"value": "5491,5493"
},
{
"attribute_code": "features_bags",
"value": "5501,5504,5506"
}
]
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "sku",
"value": "24-WB01",
"condition_type": "eq"
}
]
}
]
},
"total_count": 1
}Date
Wed, 01 Apr 2020 03:20:40 GMT
Server
Apache/2.4.38 (Ubuntu)
Set-Cookie
PHPSESSID=a8tijskit7v29bfldck8g0o7jo; expires=Wed, 01-Apr-2020 04:20:41 GMT; Max-Age=3600; path=/api/api2; domain=dev.mageplaza.vn; HttpOnly
Expires
Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control
no-store, no-cache, must-revalidate
Pragma
no-cache
X-Frame-Options
SAMEORIGIN
Content-Length
5468
Keep-Alive
timeout=5, max=100
Connection
Keep-Alive
Content-Type
application/json; charset=utf-8
GETGet label, image products SKU
{{magento_base_url}}/rest/V1/products/24-MB01
AUTHORIZATIONBearer Token
Token
<token>
HEADERS
Authorization
application/json
Example Request
Add label, image products SKU Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/products/24-MB01' \
--header 'Authorization: application/json'200 OK
Example Response
json
{
"id": 1,
"sku": "24-MB01",
"name": "Joust Duffle Bag",
"attribute_set_id": 15,
"price": 34,
"status": 1,
"visibility": 4,
"type_id": "simple",
"created_at": "2020-02-28 03:23:47",
"updated_at": "2020-03-30 09:17:21",
"extension_attributes": {
"website_ids": [
1
],
"category_links": [
{
"position": 0,
"category_id": "3"
},
{
"position": 0,
"category_id": "4"
}
],
"stock_item": {
"item_id": 1,
"product_id": 1,
"stock_id": 1,
"qty": 1000,
"is_in_stock": true,
"is_qty_decimal": false,
"show_default_notification_message": false,
"use_config_min_qty": true,
"min_qty": 0,
"use_config_min_sale_qty": 1,
"min_sale_qty": 1,
"use_config_max_sale_qty": true,
"max_sale_qty": 10000,
"use_config_backorders": true,
"backorders": 0,
"use_config_notify_stock_qty": true,
"notify_stock_qty": 1,
"use_config_qty_increments": true,
"qty_increments": 0,
"use_config_enable_qty_inc": true,
"enable_qty_increments": false,
"use_config_manage_stock": true,
"manage_stock": true,
"low_stock_date": null,
"is_decimal_divided": false,
"stock_status_changed_auto": 0
},
"mp_label_data": [
{
"id": 1,
"name": "test",
"enabled": 1,
"store_ids": "0",
"customer_group_ids": "0,1,2,3",
"priority": 0,
"label_template": "http://dev.mageplaza.vn/api/api2/pub/static/version1585620705/frontend/Magento/luma/en_US/Mageplaza_ProductLabels/images/template/p1/PL_Final_P1-17.png",
"label_image": null,
"label": null,
"label_front": "Roboto",
"label_font_size": "14",
"label_color": "#FFFFFF",
"label_css": "#design-label-text {top:32%; left:66%; transform: translateX(-50%) translateY(-50%) rotate(42deg)} #design-labels{margin-top:-8px; margin-left:8px}",
"label_position": "{\"label\":{\"top\":0,\"left\":126,\"width\":136,\"height\":124,\"percentTop\":0,\"percentLeft\":100}}",
"label_position_grid": "tr",
"same": 1,
"list_template": "http://dev.mageplaza.vn/api/api2/pub/static/version1585620705/frontend/Magento/luma/en_US/Mageplaza_ProductLabels/images/template/p1/PL_Final_P1-17.png",
"list_image": null,
"list_label": null,
"list_font": "Roboto",
"list_font_size": "14",
"list_color": "#FFFFFF",
"list_css": "#design-label-text {top:32%; left:66%; transform: translateX(-50%) translateY(-50%) rotate(42deg)} #design-labels{margin-top:-8px; margin-left:8px}",
"list_position": "{\"label\":{\"top\":0,\"left\":126,\"width\":136,\"height\":124,\"percentTop\":0,\"percentLeft\":100}}",
"list_position_grid": null,
"conditions_serialized": "{\"type\":\"Magento\\\\CatalogRule\\\\Model\\\\Rule\\\\Condition\\\\Combine\",\"attribute\":null,\"operator\":null,\"value\":\"1\",\"is_value_processed\":null,\"aggregator\":\"all\",\"conditions\":[{\"type\":\"Magento\\\\CatalogRule\\\\Model\\\\Rule\\\\Condition\\\\Product\",\"attribute\":\"attribute_set_id\",\"operator\":\"==\",\"value\":\"15\",\"is_value_processed\":false}]}",
"best_seller": 0,
"limit": null,
"from_date": "2020-03-01",
"to_date": "2020-04-30",
"stop_process": 0,
"updated_at": "2020-03-30 06:37:40",
"created_at": "2020-03-30 06:37:38"
}
],
"mp_stock_status_label": "abc",
"mp_stock_status_image": "http://dev.mageplaza.vn/api/api2/pub/media/attribute/swatch/swatch_thumb/110x90/4/_/4.jpg"
},
"product_links": [
{
"sku": "24-MB01",
"link_type": "related",
"linked_product_sku": "24-MB04",
"linked_product_type": "simple",
"position": 1
},
{
"sku": "24-MB01",
"link_type": "related",
"linked_product_sku": "24-MB03",
"linked_product_type": "simple",
"position": 2
},
{
"sku": "24-MB01",
"link_type": "related",
"linked_product_sku": "24-MB05",
"linked_product_type": "simple",
"position": 3
},
{
"sku": "24-MB01",
"link_type": "related",
"linked_product_sku": "24-MB06",
"linked_product_type": "simple",
"position": 4
},
{
"sku": "24-MB01",
"link_type": "crosssell",
"linked_product_sku": "24-UG01",
"linked_product_type": "simple",
"position": 3
},
{
"sku": "24-MB01",
"link_type": "crosssell",
"linked_product_sku": "24-WG083-blue",
"linked_product_type": "simple",
"position": 2
},
{
"sku": "24-MB01",
"link_type": "crosssell",
"linked_product_sku": "24-WG086",
"linked_product_type": "simple",
"position": 1
},
{
"sku": "24-MB01",
"link_type": "crosssell",
"linked_product_sku": "24-WG085_Group",
"linked_product_type": "grouped",
"position": 4
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-MB03",
"linked_product_type": "simple",
"position": 2
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-MB05",
"linked_product_type": "simple",
"position": 3
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-MB06",
"linked_product_type": "simple",
"position": 4
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-MB02",
"linked_product_type": "simple",
"position": 1
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-UB02",
"linked_product_type": "simple",
"position": 5
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-WB03",
"linked_product_type": "simple",
"position": 6
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-WB07",
"linked_product_type": "simple",
"position": 8
},
{
"sku": "24-MB01",
"link_type": "upsell",
"linked_product_sku": "24-WB04",
"linked_product_type": "simple",
"position": 7
}
],
"options": [],
"media_gallery_entries": [
{
"id": 1,
"media_type": "image",
"label": "Image",
"position": 1,
"disabled": false,
"types": [
"image",
"small_image",
"thumbnail"
],
"file": "/m/b/mb01-blue-0.jpg"
}
],
"tier_prices": [],
"custom_attributes": [
{
"attribute_code": "image",
"value": "/m/b/mb01-blue-0.jpg"
},
{
"attribute_code": "small_image",
"value": "/m/b/mb01-blue-0.jpg"
},
{
"attribute_code": "thumbnail",
"value": "/m/b/mb01-blue-0.jpg"
},
{
"attribute_code": "options_container",
"value": "container1"
},
{
"attribute_code": "msrp_display_actual_price_type",
"value": "0"
},
{
"attribute_code": "url_key",
"value": "joust-duffle-bag"
},
{
"attribute_code": "gift_message_available",
"value": "0"
},
{
"attribute_code": "required_options",
"value": "0"
},
{
"attribute_code": "has_options",
"value": "0"
},
{
"attribute_code": "image_label",
"value": "Image"
},
{
"attribute_code": "small_image_label",
"value": "Image"
},
{
"attribute_code": "thumbnail_label",
"value": "Image"
},
{
"attribute_code": "tax_class_id",
"value": "0"
},
{
"attribute_code": "mp_stock_status",
"value": "5640"
},
{
"attribute_code": "mp_dynamic_groups",
"value": "5639"
},
{
"attribute_code": "mp_productalerts_stock_notify",
"value": "1"
},
{
"attribute_code": "mp_productalerts_price_alert",
"value": "1"
},
{
"attribute_code": "ts_packaging_type",
"value": "none"
},
{
"attribute_code": "category_ids",
"value": [
"3",
"4"
]
},
{
"attribute_code": "description",
"value": "<p>The sporty Joust Duffle Bag can't be beat - not in the gym, not on the luggage carousel, not anywhere. Big enough to haul a basketball or soccer ball and some sneakers with plenty of room to spare, it's ideal for athletes with places to go.<p>\r\n<ul>\r\n<li>Dual top handles.</li>\r\n<li>Adjustable shoulder strap.</li>\r\n<li>Full-length zipper.</li>\r\n<li>L 29\" x W 13\" x H 11\".</li>\r\n</ul>"
},
{
"attribute_code": "news_from_date",
"value": "2020-02-29 00:00:00"
},
{
"attribute_code": "color",
"value": "5476"
},
{
"attribute_code": "eco_collection",
"value": "0"
},
{
"attribute_code": "performance_fabric",
"value": "0"
},
{
"attribute_code": "erin_recommends",
"value": "0"
},
{
"attribute_code": "new",
"value": "0"
},
{
"attribute_code": "sale",
"value": "0"
}
]
}Date
Wed, 01 Apr 2020 03:21:23 GMT
Server
Apache/2.4.38 (Ubuntu)
Expires
Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control
no-store, no-cache, must-revalidate
Pragma
no-cache
Set-Cookie
PHPSESSID=a8tijskit7v29bfldck8g0o7jo; expires=Wed, 01-Apr-2020 04:21:24 GMT; Max-Age=3600; path=/api/api2; domain=dev.mageplaza.vn; HttpOnly
X-Frame-Options
SAMEORIGIN
Content-Length
6954
Keep-Alive
timeout=5, max=100
Connection
Keep-Alive
Content-Type
application/json; charset=utf-8
GETCarts
{{magento_base_url}}/rest/V1/carts/:cartId
AUTHORIZATIONBearer Token
Token
<token>
HEADERS
Content-Type
application/json
PATH VARIABLES
cartId
31
Example Request
Carts Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/carts/31' \
--header 'Content-Type: application/json'200 OK
Example Response
json
{
"id": 31,
"created_at": "2020-04-01 04:09:14",
"updated_at": "2020-04-01 04:09:14",
"is_active": true,
"is_virtual": false,
"items": [],
"items_count": 0,
"items_qty": 0,
"customer": {
"id": 1,
"group_id": 1,
"default_billing": "1",
"default_shipping": "1",
"created_at": "2020-02-28 03:28:43",
"updated_at": "2020-03-11 07:23:27",
"created_in": "Default Store View",
"dob": "1973-12-15",
"email": "roni_cost@example.com",
"firstname": "Veronica",
"lastname": "Costello",
"gender": 2,
"store_id": 1,
"website_id": 1,
"addresses": [
{
"id": 1,
"customer_id": 1,
"region": {
"region_code": "MI",
"region": "Michigan",
"region_id": 33
},
"region_id": 33,
"country_id": "US",
"street": [
"6146 Honey Bluff Parkway"
],
"telephone": "(555) 229-3326",
"postcode": "49628-7978",
"city": "Calder",
"firstname": "Veronica",
"lastname": "Costello",
"default_shipping": true,
"default_billing": true
},
{
"id": 3,
"customer_id": 1,
"region": {
"region_code": "MI",
"region": "Michigan",
"region_id": 33
},
"region_id": 33,
"country_id": "US",
"street": [
"6146 Honey Bluff Parkway"
],
"telephone": "(555) 229-3326",
"postcode": "49628-7978",
"city": "Calder",
"firstname": "Veronica",
"lastname": "Costello"
}
],
"disable_auto_group_change": 0,
"extension_attributes": {
"is_subscribed": false
}
},
"billing_address": {
"id": 134,
"region": "Michigan",
"region_id": 33,
"region_code": "MI",
"country_id": "US",
"street": [
"6146 Honey Bluff Parkway"
],
"telephone": "(555) 229-3326",
"postcode": "49628-7978",
"city": "Calder",
"firstname": "Veronica",
"lastname": "Costello",
"customer_id": 1,
"email": "roni_cost@example.com",
"same_as_billing": 0,
"customer_address_id": 1,
"save_in_address_book": 0
},
"orig_order_id": 0,
"currency": {
"global_currency_code": "USD",
"base_currency_code": "USD",
"store_currency_code": "USD",
"quote_currency_code": "USD",
"store_to_base_rate": 0,
"store_to_quote_rate": 0,
"base_to_global_rate": 1,
"base_to_quote_rate": 1
},
"customer_is_guest": false,
"customer_note_notify": true,
"customer_tax_class_id": 3,
"store_id": 1,
"extension_attributes": {
"shipping_assignments": []
}
}Date
Wed, 01 Apr 2020 07:18:22 GMT
Server
Apache/2.4.38 (Ubuntu)
Expires
Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control
no-store, no-cache, must-revalidate
Pragma
no-cache
Set-Cookie
PHPSESSID=j3psdliau3gq47fmq2cj287r9l; expires=Wed, 01-Apr-2020 08:18:22 GMT; Max-Age=3600; path=/api/api2; domain=dev.mageplaza.vn; HttpOnly
X-Frame-Options
SAMEORIGIN
Content-Length
1912
Keep-Alive
timeout=5, max=100
Connection
Keep-Alive
Content-Type
application/json; charset=utf-8
GETGet label, image guest
{{magento_base_url}}/rest/V1/guest-carts/:cartId/items
AUTHORIZATIONBearer Token
Token
<token>
PATH VARIABLES
cartId
VW1arxo4viTw0W5Q953lsTHUbqkVYRea
Example Request
Get label, image guest Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/guest-carts/VW1arxo4viTw0W5Q953lsTHUbqkVYRea/items'200 OK
Example Response
json
[
{
"item_id": 79,
"sku": "24-WB04",
"qty": 1,
"name": "Push It Messenger Bag",
"price": 45,
"product_type": "simple",
"quote_id": "VW1arxo4viTw0W5Q953lsTHUbqkVYRea",
"extension_attributes": {
"mp_stock_status_label": "abc",
"mp_stock_status_image": "http://dev.mageplaza.vn/api/api2/pub/media/attribute/swatch/swatch_thumb/110x90/4/_/4.jpg"
}
}
]Date
Wed, 01 Apr 2020 07:46:49 GMT
Server
Apache/2.4.38 (Ubuntu)
Expires
Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control
no-store, no-cache, must-revalidate
Pragma
no-cache
Set-Cookie
PHPSESSID=j3psdliau3gq47fmq2cj287r9l; expires=Wed, 01-Apr-2020 08:46:49 GMT; Max-Age=3600; path=/api/api2; domain=dev.mageplaza.vn; HttpOnly
X-Frame-Options
SAMEORIGIN
Content-Length
336
Keep-Alive
timeout=5, max=100
Connection
Keep-Alive
Content-Type
application/json; charset=utf-8