Users / Customers
Create customer
Method: POST
URL: {{base_url}}/rest/V1/customers
Request Payload
{
“customer” : {
“lastname” : “Doe”,
“firstname” : “Jane”,
“email” : “jdoe@yopmail.com”,
“addresses” : [
{
“defaultBilling” : true,
“defaultShipping” : true,
“firstname” : “Jane”,
“lastname” : “Doe”,
“region” : {
“regionCode” : “NY”,
“regionId” : 43,
“region” : “New York”
},
“countryId” : “US”,
“postcode” : “11501”,
“city” : “Mineola”,
“street” : [
“160 1st St.”
],
“telephone” : “516-555-1111”
}
]
},
“password” : “Jdoe@yopmail”
}
Response Example
{
“id”: 30,
“group_id”: 1,
“default_billing”: “1”,
“default_shipping”: “1”,
“created_at”: “2024-10-08 13:18:54”,
“updated_at”: “2024-10-08 13:18:54”,
“created_in”: “Default Store View”,
“email”: “jdoe@example.com”,
“firstname”: “Jane”,
“lastname”: “Doe”,
“store_id”: 1,
“website_id”: 1,
“addresses”: [
{
“id”: 1,
“customer_id”: 30,
“region”: {
“region_code”: “NY”,
“region”: “New York”,
“region_id”: 43
},
“region_id”: 43,
“country_id”: “US”,
“street”: [
“160 1st St.”
],
“telephone”: “516-555-1111”,
“postcode”: “11501”,
“city”: “Mineola”,
“firstname”: “Jane”,
“lastname”: “Doe”,
“default_shipping”: true,
“default_billing”: true
}
],
“disable_auto_group_change”: 0,
“extension_attributes”: {
“is_subscribed”: false
}
}
Get customer
Method: GET
URL: {{base_url}}/rest/V1/customers/{{customer_id}}
Response Example
{
“id”: 30,
“group_id”: 1,
“default_billing”: “1”,
“default_shipping”: “1”,
“created_at”: “2024-10-08 13:18:54”,
“updated_at”: “2024-10-08 13:18:54”,
“created_in”: “Default Store View”,
“email”: “jdoe@example.com”,
“firstname”: “Jane”,
“lastname”: “Doe”,
“store_id”: 1,
“website_id”: 1,
“addresses”: [
{
“id”: 1,
“customer_id”: 30,
“region”: {
“region_code”: “NY”,
“region”: “New York”,
“region_id”: 43
},
“region_id”: 43,
“country_id”: “US”,
“street”: [
“160 1st St.”
],
“telephone”: “516-555-1111”,
“postcode”: “11501”,
“city”: “Mineola”,
“firstname”: “Jane”,
“lastname”: “Doe”,
“default_shipping”: true,
“default_billing”: true
}
],
“disable_auto_group_change”: 0,
“extension_attributes”: {
“is_subscribed”: false
}
}
Update customer
Method: PUT
URL: {{base_url}}/rest/V1/customers/{{customer_id}}
Request Payload
{
“customer” : {
“firstname” : “Patt”,
“email” : “jdoe@example111.com”
}
}
Response Example
{
“id”: 30,
“group_id”: 1,
“default_billing”: “1”,
“default_shipping”: “1”,
“created_at”: “2024-10-08 13:18:54”,
“updated_at”: “2024-10-08 13:30:12”,
“created_in”: “Default Store View”,
“email”: “jdoe@example111.com”,
“firstname”: “Patt”,
“lastname”: “Doe”,
“store_id”: 1,
“website_id”: 1,
“addresses”: [
{
“id”: 1,
“customer_id”: 30,
“region”: {
“region_code”: “NY”,
“region”: “New York”,
“region_id”: 43
},
“region_id”: 43,
“country_id”: “US”,
“street”: [
“160 1st St.”
],
“telephone”: “516-555-1111”,
“postcode”: “11501”,
“city”: “Mineola”,
“firstname”: “Jane”,
“lastname”: “Doe”,
“default_shipping”: true,
“default_billing”: true
}
],
“disable_auto_group_change”: 0,
“extension_attributes”: {
“is_subscribed”: false
}
}
Remove customer
Method: DELETE
URL: {{base_url}}/rest/V1/customers/{{customer_id}}
Response Example
true
Categories
Create Category
Method: POST
URL: {{base_url}}/rest/all/V1/categories
Request Payload
{
“category”: {
“name”: “Bags”,
“parent_id”: 2,
“isActive”: true
}
}
Response Example
{
“id”: 34,
“parent_id”: 2,
“name”: “Bags”,
“is_active”: true,
“position”: 7,
“level”: 2,
“children”: “”,
“created_at”: “2024-10-08 12:45:40”,
“updated_at”: “2024-10-08 12:45:40”,
“path”: “1/2/34”,
“include_in_menu”: true,
“custom_attributes”: [
{
“attribute_code”: “is_anchor”,
“value”: “1”
},
{
“attribute_code”: “path”,
“value”: “1/2/34”
},
{
“attribute_code”: “children_count”,
“value”: “0”
},
{
“attribute_code”: “url_key”,
“value”: “bags”
},
{
“attribute_code”: “url_path”,
“value”: “bags”
},
{
“attribute_code”: “enable_product_designer_category”,
“value”: “1”
}
]
}
Get Category by search
Method: GET
URL: {{base_url}}/rest/V1/categories/list?searchCriteria[filterGroups][0][filters][0][field]=name&searchCriteria[filterGroups][0][filters][0][value]={{category_name}}&searchCriteria[filterGroups][0][filters][0][conditionType]=eq
Response Example
{
“id”: 34,
“parent_id”: 2,
“name”: “Bags”,
“is_active”: true,
“position”: 7,
“level”: 2,
“children”: “”,
“created_at”: “2024-10-08 12:45:40”,
“updated_at”: “2024-10-08 12:45:40”,
“path”: “1/2/34”,
“include_in_menu”: true,
“custom_attributes”: [
{
“attribute_code”: “is_anchor”,
“value”: “1”
},
{
“attribute_code”: “path”,
“value”: “1/2/34”
},
{
“attribute_code”: “children_count”,
“value”: “0”
},
{
“attribute_code”: “url_key”,
“value”: “bags”
},
{
“attribute_code”: “url_path”,
“value”: “bags”
},
{
“attribute_code”: “enable_product_designer_category”,
“value”: “1”
}
]
}
Get Category by id
Method: GET
URL: {{base_url}}/rest/all/V1/categories/{{category_id}}
Response Example
{
“id”: 34,
“parent_id”: 2,
“name”: “Bags”,
“is_active”: true,
“position”: 7,
“level”: 2,
“children”: “”,
“created_at”: “2024-10-08 12:45:40”,
“updated_at”: “2024-10-08 12:45:40”,
“path”: “1/2/34”,
“include_in_menu”: true,
“custom_attributes”: [
{
“attribute_code”: “is_anchor”,
“value”: “1”
},
{
“attribute_code”: “path”,
“value”: “1/2/34”
},
{
“attribute_code”: “children_count”,
“value”: “0”
},
{
“attribute_code”: “url_key”,
“value”: “bags”
},
{
“attribute_code”: “url_path”,
“value”: “bags”
},
{
“attribute_code”: “enable_product_designer_category”,
“value”: “1”
}
]
}
Update Category
Method: PUT
URL: {{base_url}}/rest/all/V1/categories/{{category_id}}
Request Payload
{
“category”:{
“is_active”: true,
“name”: “Tourist Bags”
}
}
Response Example
{
“id”: 34,
“parent_id”: 2,
“name”: “Tourist Bags”,
“is_active”: true,
“position”: 7,
“level”: 2,
“children”: “”,
“created_at”: “2024-10-08 12:45:40”,
“updated_at”: “2024-10-08 12:53:45”,
“path”: “1/2/34”,
“include_in_menu”: true,
“custom_attributes”: [
{
“attribute_code”: “is_anchor”,
“value”: “1”
},
{
“attribute_code”: “path”,
“value”: “1/2/34”
},
{
“attribute_code”: “children_count”,
“value”: “0”
},
{
“attribute_code”: “url_key”,
“value”: “bags”
},
{
“attribute_code”: “url_path”,
“value”: “bags”
},
{
“attribute_code”: “enable_product_designer_category”,
“value”: “1”
}
]
}
Remove Category
Method: DELETE
URL: {{base_url}}/rest/all/V1/categories/{{category_id}}
Response Example
true
Product Attributes
Create product attribute
Method: POST
URL: {{base_url}}/rest/V1/products/attributes
Request Payload
{
“attribute”: {
“apply_to”: [
“simple”,
“configurable”
],
“is_visible”: true,
“scope”: “global”,
“default_frontend_label”: “Custom Width New”,
“attribute_code”: “customwidthnew”,
“frontend_input”: “select”,
“is_required”: false,
“is_searchable”: “1”,
“is_comparable”: “1”,
“is_filterable”: true,
“is_filterable_in_search”: true,
“is_used_in_grid”: true,
“is_visible_in_grid”: true,
“is_filterable_in_grid”: true,
“options”: [
{
“label”: “100”
},
{
“label”: “200”
}
]
}
}
Response Example
{
“extension_attributes”: {
“is_pagebuilder_enabled”: false
},
“is_wysiwyg_enabled”: false,
“is_html_allowed_on_front”: false,
“used_for_sort_by”: false,
“is_filterable”: true,
“is_filterable_in_search”: true,
“is_used_in_grid”: true,
“is_visible_in_grid”: true,
“is_filterable_in_grid”: true,
“position”: 0,
“apply_to”: [
“simple”,
“configurable”
],
“is_searchable”: “1”,
“is_visible_in_advanced_search”: “0”,
“is_comparable”: “1”,
“is_used_for_promo_rules”: “0”,
“is_visible_on_front”: “0”,
“used_in_product_listing”: “0”,
“is_visible”: true,
“scope”: “global”,
“attribute_id”: 154,
“attribute_code”: “customwidthnew”,
“frontend_input”: “select”,
“entity_type_id”: “4”,
“is_required”: false,
“options”: [
{
“label”: ” “,
“value”: “”
},
{
“label”: “100”,
“value”: “30”
},
{
“label”: “200”,
“value”: “31”
}
],
“is_user_defined”: true,
“default_frontend_label”: “Custom Width New”,
“frontend_labels”: [],
“backend_type”: “int”,
“source_model”: “Magento\\Eav\\Model\\Entity\\Attribute\\Source\\Table”,
“default_value”: “”,
“is_unique”: “0”,
“validation_rules”: []
}
Assign product attribute
Method: POST
URL: {{base_url}}/rest/V1/products/attribute-sets/attributes
Request Payload
{
“attributeSetId”: 4,
“attributeGroupId”: 7,
“attributeCode”: “customwidthnew”,
“sortOrder”: 100
}
Response Example
“153”
Update product attribute
Method: PUT
URL: {{base_url}}/rest/V1/products/attributes/{{attributeCode}}
Request Payload
{
“attribute”: {
“attribute_id”: 154,
“default_frontend_label”: “Main Width option”,
“is_searchable”: “1”,
“is_comparable”: “1”,
“is_filterable_in_search”: true,
“is_used_in_grid”: true,
“is_visible_in_grid”: true,
“is_filterable_in_grid”: true
}
}
Response Example
{
“extension_attributes”: {
“is_pagebuilder_enabled”: false
},
“is_wysiwyg_enabled”: false,
“is_html_allowed_on_front”: false,
“used_for_sort_by”: false,
“is_filterable”: true,
“is_filterable_in_search”: true,
“is_used_in_grid”: true,
“is_visible_in_grid”: true,
“is_filterable_in_grid”: true,
“position”: 0,
“apply_to”: [
“simple”,
“configurable”
],
“is_searchable”: “1”,
“is_visible_in_advanced_search”: “0”,
“is_comparable”: “1”,
“is_used_for_promo_rules”: “0”,
“is_visible_on_front”: “0”,
“used_in_product_listing”: “0”,
“is_visible”: true,
“scope”: “global”,
“attribute_id”: 154,
“attribute_code”: “customwidthnew”,
“frontend_input”: “select”,
“entity_type_id”: “4”,
“is_required”: false,
“options”: [
{
“label”: ” “,
“value”: “”
},
{
“label”: “100”,
“value”: “30”
},
{
“label”: “200”,
“value”: “31”
}
],
“is_user_defined”: true,
“default_frontend_label”: “Custom Width New”,
“frontend_labels”: [],
“backend_type”: “int”,
“source_model”: “Magento\\Eav\\Model\\Entity\\Attribute\\Source\\Table”,
“default_value”: “”,
“is_unique”: “0”,
“validation_rules”: []
}
Get product attribute
Method: GET
URL: {{base_url}}/rest/V1/products/attributes/{{attributeCode}}
Response Example
{
“extension_attributes”: {
“is_pagebuilder_enabled”: false
},
“is_wysiwyg_enabled”: false,
“is_html_allowed_on_front”: false,
“used_for_sort_by”: false,
“is_filterable”: true,
“is_filterable_in_search”: true,
“is_used_in_grid”: true,
“is_visible_in_grid”: true,
“is_filterable_in_grid”: true,
“position”: 0,
“apply_to”: [
“simple”,
“configurable”
],
“is_searchable”: “1”,
“is_visible_in_advanced_search”: “0”,
“is_comparable”: “1”,
“is_used_for_promo_rules”: “0”,
“is_visible_on_front”: “0”,
“used_in_product_listing”: “0”,
“is_visible”: true,
“scope”: “global”,
“attribute_id”: 154,
“attribute_code”: “customwidthnew”,
“frontend_input”: “select”,
“entity_type_id”: “4”,
“is_required”: false,
“options”: [
{
“label”: ” “,
“value”: “”
},
{
“label”: “100”,
“value”: “30”
},
{
“label”: “200”,
“value”: “31”
}
],
“is_user_defined”: true,
“default_frontend_label”: “Custom Width New”,
“frontend_labels”: [],
“backend_type”: “int”,
“source_model”: “Magento\\Eav\\Model\\Entity\\Attribute\\Source\\Table”,
“default_value”: “”,
“is_unique”: “0”,
“validation_rules”: []
}
Remove product attribute
Method: DELETE
URL: {{base_url}}/rest/V1/products/attributes/{{attributeCode}}
Response Example
true
Product Attribute Options
Create product attribute option
Method: POST
URL: {{base_url}}/rest/V1/products/attributes/customwidthnew/options
Request Payload
{
“option”: {
“label”: “300”
}
}
Response Example
“32”
Update product attribute option
Method: PUT
URL: {{base_url}}/rest/V1/products/attributes/customwidthnew/options/{{option_id}}
Request Payload
{
“option”: {
“label”: “400”
}
}
Response Example
true
Get product attribute option
Method: GET
URL: {{base_url}}/rest/V1/products/attributes/afwerking/options
Response Example
[
{
“label”: ” “,
“value”: “”
},
{
“label”: “100”,
“value”: “30”
},
{
“label”: “300”,
“value”: “32”
},
{
“label”: “200”,
“value”: “31”
}
]
Get product attribute option Copy
Method: DELETE
URL: {{base_url}}/rest/V1/products/attributes/customwidthnew/options/{{option_id}}
Response Example
true
Simple Product
Create Simple Product
Method: POST
URL: {{base_url}}/rest/all/V1/products
Request Payload
{
“product”: {
“sku”: “sku-Champ-Black-Blue”,
“name”: “Champ Tee Black Blue”,
“attribute_set_id”: 4,
“price”: 100,
“status”: 1,
“visibility”: 1,
“type_id”: “simple”,
“weight”: “0.5”,
“extension_attributes”: {
“stock_item”: {
“qty”: “100”,
“is_in_stock”: true
},
“category_links”: [
{
“position”: 0,
“category_id”: 35
}
]
},
“custom_attributes”: [
{
“attribute_code”: “description”,
“value”: “Test product checking”
}
],
“media_gallery_entries”: [
{
“position”: 1,
“media_type”: “image”,
“label”: “10000200”,
“disabled”: false,
“types”: [
“image”,
“small_image”,
“thumbnail”
],
“content”: {
“base64_encoded_data”: “base64_image_data”,
“type”: “image/png”,
“name”: “newkurtaimage”
}
}
]
}
}
Response Example
{
“id”: 95,
“sku”: “sku-Champ-Black-Blue”,
“name”: “Champ Tee Black Blue”,
“attribute_set_id”: 4,
“price”: 100,
“status”: 1,
“visibility”: 1,
“type_id”: “simple”,
“created_at”: “2024-10-09 12:02:22”,
“updated_at”: “2024-10-09 12:02:22”,
“weight”: 0.5,
“extension_attributes”: {
“website_ids”: [
1
],
“category_links”: [
{
“position”: 0,
“category_id”: “35”
}
],
“stock_item”: {
“item_id”: 95,
“product_id”: 95,
“stock_id”: 1,
“qty”: 100,
“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
}
},
“options”: [],
“media_gallery_entries”: [
{
“id”: 203,
“media_type”: “image”,
“label”: “10000200”,
“position”: 1,
“disabled”: false,
“types”: [
“image”,
“small_image”,
“thumbnail”
],
“file”: “/n/e/newkurtaimage.png”
}
],
“custom_attributes”: [
{
“attribute_code”: “image”,
Update Simple Product
Method: PUT
URL: {{base_url}}/rest/all/V1/products/{{sku}}
Request Payload
{
“product”: {
“name”: “Autostickers eigen ontwerp-Glans/Vierkant/rechthoek/Bubbelfree (voor vlakke toepassing)”,
“sku”: “sku-27782_2540713”,
“attribute_set_id”: 4,
“status”: 1,
“visibility”: 4,
“type_id”: “simple”,
“weight”: 0.5,
“price”: 1.95,
“extension_attributes”: {
“stock_item”: {
“qty”: 1000,
“is_in_stock”: 1,
“manage_stock”: 0
},
“category_links”: [
{
“position”: 0,
“category_id”: 27
},
{
“position”: 1,
“category_id”: 28
},
{
“position”: 2,
“category_id”: 29
},
{
“position”: 3,
“category_id”: 8
},
{
“position”: 4,
“category_id”: 30
},
{
“position”: 5,
“category_id”: 11
},
{
“position”: 6,
“category_id”: 3
},
{
“position”: 7,
“category_id”: 19
},
{
“position”: 8,
“category_id”: 24
},
{
“position”: 9,
“category_id”: 25
}
]
},
“custom_attributes”: [
{
“attribute_code”: “afwerking”,
“value”: 5
},
{
“attribute_code”: “vorm”,
“value”: 16
},
{
“attribute_code”: “soort_folie”,
“value”: 12
}
],
“media_gallery_entries”: []
}
}
Response Example
{
“id”: 95,
“sku”: “sku-Champ-Black-Blue”,
“name”: “Champ coffee Black”,
“attribute_set_id”: 4,
“price”: 1000,
“status”: 1,
“visibility”: 1,
“type_id”: “simple”,
“created_at”: “2024-10-09 12:02:22”,
“updated_at”: “2024-10-09 12:07:57”,
“weight”: 0.5,
“extension_attributes”: {
“website_ids”: [
1
],
“category_links”: [
{
“position”: 0,
“category_id”: “33”
}
],
“stock_item”: {
“item_id”: 95,
“product_id”: 95,
“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
}
},
“product_links”: [],
“options”: [],
“media_gallery_entries”: [
{
“id”: 203,
“media_type”: “image”,
“label”: “10000200”,
“position”: 1,
“disabled”: false,
“types”: [
“image”,
“small_image”,
“thumbnail”
],
“file”: “/n/e/newkurtaimage.png”
}
],
“tier_prices”: [],
“custom_attributes”: [
Get Simple Product
Method: GET
URL: {{base_url}}/rest/all/V1/products/{{sku}}
Response Example
{
“id”: 95,
“sku”: “sku-Champ-Black-Blue”,
“name”: “Champ coffee Black”,
“attribute_set_id”: 4,
“price”: 1000,
“status”: 1,
“visibility”: 1,
“type_id”: “simple”,
“created_at”: “2024-10-09 12:02:22”,
“updated_at”: “2024-10-09 12:07:57”,
“weight”: 0.5,
“extension_attributes”: {
“website_ids”: [
1
],
“category_links”: [
{
“position”: 0,
“category_id”: “33”
}
],
“stock_item”: {
“item_id”: 95,
“product_id”: 95,
“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
}
},
“product_links”: [],
“options”: [],
“media_gallery_entries”: [
{
“id”: 203,
“media_type”: “image”,
“label”: “10000200”,
“position”: 1,
“disabled”: false,
“types”: [
“image”,
“small_image”,
“thumbnail”
],
“file”: “/n/e/newkurtaimage.png”
}
],
“tier_prices”: [],
“custom_attributes”: [
Remove Simple Product
Method: DELETE
URL: {{base_url}}/rest/all/V1/products/{{sku}}
Response Example
true
Configure / Variable Product
Create configure product
Method: POST
URL: {{base_url}}/rest/all/V1/products
Request Payload
{
“product”: {
“sku”: “sku-9835585”,
“name”: “Test Product gf fb”,
“attribute_set_id”: 4,
“price”: “0.00”,
“status”: 1,
“visibility”: 4,
“type_id”: “configurable”,
“weight”: 0.5,
“extension_attributes”: {
“stock_item”: {
“qty”: 0,
“is_in_stock”: 1
},
“configurable_product_options”: [
{
“attribute_id”: 143,
“label”: “Color”,
“position”: 0,
“values”: [
{
“value_index”: “9”
},
{
“value_index”: “8”
}
]
}
],
“configurable_product_links”: [
18108,
18109
]
},
“custom_attributes”: [
{
“attribute_code”: “description”,
“value”: “[\”18\/8 Recycled Stainless Steel\”, \”BPA-free\”, \”Double-wall Vacuum insulation\”, \”Leakproof fast flow lid is designed for easy pouring, drinking, and cleaning\”, \”Stanley\u2019s AeroLight featherweight technology employs spun steel for a body that\u2019s 33% lighter than comparable drinkware pieces\”, \”Drinks stay iced for 2 days and cold for 10 hours\”, \”Dishwasher safe when laser engraved. For best results, hand washing recommended for Silkscreen printed pieces\”, \”Compatible with most cupholders\”, \”Easy carry handle\”, \”Lifetime warranty\”]”
},
{
“attribute_code”: “url_key”,
“value”: “9835585503522-432432432”
}
],
“media_gallery_entries”: [
{
“position”: 1,
“media_type”: “image”,
“label”: “Stanley\u00ae 24oz Iceflow\u2122 Bottle with Fast Flow Lid – White – STN35-240Z ICEFLOW BT”,
“disabled”: false,
“types”: [
“image”,
“thumbnail”,
“small_image”
],
“content”: {
“type”: “image\/png”,
“name”: “eeff425d80101f7aa83d224deb80aa25”
}
}
]
}
}
Response Example
{
“id”: 102,
“sku”: “sku-7696265248825”,
“name”: “Configure tshirt”,
“attribute_set_id”: 4,
“price”: 0,
“status”: 1,
“visibility”: 4,
“type_id”: “configurable”,
“created_at”: “2024-10-09 13:49:19”,
“updated_at”: “2024-10-09 13:49:19”,
“weight”: 0.5,
“extension_attributes”: {
“website_ids”: [
1
],
“stock_item”: {
“item_id”: 102,
“product_id”: 102,
“stock_id”: 1,
“qty”: 0,
“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
},
“configurable_product_options”: [
{
“id”: 21,
“attribute_id”: “143”,
“label”: “Color”,
“position”: 0,
“values”: [
{
“value_index”: 22
},
{
“value_index”: 23
}
],
“product_id”: 102
},
{
“id”: 22,
“attribute_id”: “144”,
“label”: “Size”,
“position”: 0,
Update configure product
Method: PUT
URL: {{base_url}}/rest/all/V1/products/{{sku}}
Request Payload
{
“product”: {
“sku”: “sku-7696265248825”,
“name”: “Configure tshirt new”,
“attribute_set_id”: 4,
“price”: 5000,
“status”: 1,
“visibility”: 4,
“type_id”: “configurable”,
“weight”: 0.5,
“extension_attributes”: {
“stock_item”: {
“qty”: 100,
“is_in_stock”: true
},
“configurable_product_options”: [
{
“attribute_id”: 143,
“label”: “Color”,
“position”: 0,
“values”: [
{
“value_index”: 22
},
{
“value_index”: 23
}
]
},
{
“attribute_id”: 144,
“label”: “Size”,
“position”: 0,
“values”: [
{
“value_index”: 24
},
{
“value_index”: 25
}
]
}
],
“configurable_product_links”: [
82,
83,
84,
85
]
},
“media_gallery_entries”: [
{
“position”: 1,
“media_type”: “image”,
“label”: “504184699773”,
“disabled”: false,
“types”: [
“image”,
“small_image”,
“thumbnail”
],
“content”: {
“type”: “image/jpeg”,
“name”: “hoddies_cat_dd3fd638-5e56-4d32-bfef-33f3db7309mf”
}
}
]
}
}
Response Example
{
“id”: 102,
“sku”: “sku-7696265248825”,
“name”: “Configure tshirt new”,
“attribute_set_id”: 4,
“price”: 0,
“status”: 1,
“visibility”: 4,
“type_id”: “configurable”,
“created_at”: “2024-10-09 13:49:19”,
“updated_at”: “2024-10-09 13:54:56”,
“weight”: 0.5,
“extension_attributes”: {
“website_ids”: [
1
],
“stock_item”: {
“item_id”: 102,
“product_id”: 102,
“stock_id”: 1,
“qty”: 0,
“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
},
“configurable_product_options”: [
{
“id”: 21,
“attribute_id”: “143”,
“label”: “Color”,
“position”: 0,
“values”: [
{
“value_index”: 22
},
{
“value_index”: 23
}
],
“product_id”: 102
},
{
“id”: 22,
“attribute_id”: “144”,
“label”: “Size”,
“position”: 0,
Get configure product
Method: GET
URL: {{base_url}}/rest/all/V1/products/{{sku}}
Response Example
{
“id”: 102,
“sku”: “sku-7696265248825”,
“name”: “Configure tshirt”,
“attribute_set_id”: 4,
“price”: 0,
“status”: 1,
“visibility”: 4,
“type_id”: “configurable”,
“created_at”: “2024-10-09 13:49:19”,
“updated_at”: “2024-10-09 13:49:19”,
“weight”: 0.5,
“extension_attributes”: {
“website_ids”: [
1
],
“stock_item”: {
“item_id”: 102,
“product_id”: 102,
“stock_id”: 1,
“qty”: 0,
“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
},
“configurable_product_options”: [
{
“id”: 21,
“attribute_id”: “143”,
“label”: “Color”,
“position”: 0,
“values”: [
{
“value_index”: 22
},
{
“value_index”: 23
}
],
“product_id”: 102
},
{
“id”: 22,
“attribute_id”: “144”,
“label”: “Size”,
“position”: 0,
Remove configure product
Method: DELETE
URL: {{base_url}}/rest/all/V1/products/{{sku}}
Orders
Order create
Method: POST
URL: {{base_url}}/rest/default/V1/order/create
Request Payload
{
“id”: “gid:\/\/shopify\/Order\/7076842471770”,
“legacyResourceId”: “7076842471770”,
“name”: “Y5611”,
“email”: “abc@gmail.com”,
“currencyCode”: “EUR”,
“displayFinancialStatus”: “PAID”,
“totalWeight”: “1”,
“note”: “Bestell”,
“phone”: “+167567567”,
“createdAt”: “2025-09-12T12: 26: 25Z”,
“updatedAt”: “2025-10-02T06: 37: 25Z”,
“totalDiscountsSet”: {
“presentmentMoney”: {
“amount”: “0.0”
}
},
“totalPriceSet”: {
“presentmentMoney”: {
“amount”: “49.65”
}
},
“lineItems”: {
“nodes”: [
{
“id”: “gid:\/\/shopify\/LineItem\/17619648676186”,
“name”: “Cove C gestalten”,
“quantity”: 1,
“sku”: “100300”,
“product”: {
“legacyResourceId”: “8995011101018”
},
“originalTotalSet”: {
“presentmentMoney”: {
“amount”: “4.75”
}
},
“originalUnitPriceSet”: {
“presentmentMoney”: {
“amount”: “4.75”
}
},
“variant”: {
“legacyResourceId”: “48319654658394”
},
“customAttributes”: [
{
“key”: “_Product Design”,
“value”: “493”
},
{
“key”: “Custom Options”,
“value”: “[]”
},
{
“key”: “_Designer Image”,
“value”: “url\/media\/productdesigner\/designs\/493\/base\/pd_OWIzYWI.png”
},
{
“key”: “_Designer Url”,
“value”: “url\/productdesigner\/index\/index\/id\/4\/design\/NDkz\/item\/”
},
{
“key”: “Product Design”,
“value”: “Yes”
},
{
“key”: “_Individual Product”,
“value”: “Yes”
}
],
“image”: {
“url”: “url\/s\/files\/1\/0776\/9738\/4794\/files\/coveryubikeyc.png?v=1719654133”
},
“options”: []
},
{
“id”: “gid:\/\/shopify\/LineItem\/17619648708954”,
“name”: “Cover selbst gestalten”,
“quantity”: 1,
“sku”: “100300”,
“product”: {
“legacyResourceId”: “8995011101018”
},
“originalTotalSet”: {
“presentmentMoney”: {
“amount”: “4.75”
}
},
“originalUnitPriceSet”: {
“presentmentMoney”: {
“amount”: “4.75”
}
},
“variant”: {
“legacyResourceId”: “48319654658394”
},
“customAttributes”: [
{
“key”: “_Product Design”,
“value”: “492”
},
{
“key”: “Custom Options”,
“value”: “[]”
},
{
“key”: “_Designer Image”,
“value”: “url\/media\/productdesigner\/designs\/492\/base\/pd_OWMyZWE.png”
},
{
“key”: “_Designer Url”,
“value”: “url\/productdesigner\/index\/index\/id\/4\/design\/NDky\/item\/”
},
{
“key”: “Product Design”,
“value”: “Yes”
},
{
“key”: “_Individual Product”,
“value”: “Yes”
}
],
“image”: {
“url”: “url\/s\/files\/1\/0776\/9738\/4794\/files\/coveryubikeyc.png?v=1719654133”
},
“options”: []
}
]
},
“customer”: {
“legacyResourceId”: “9625152389466”,
“displayName”: “Florian Brand”,
“email”: “abc@gmail.de”,
“phone”: “+498823”,
“firstName”: “Florian”,
“lastName”: “Brand”,
“addresses”: [
{
“address1”: “Von-Kuehlmann-Stra\u00dfe 15”,
“address2”: “”,
“city”: “Landsberg am Lech”,
“country”: “Germany”,
“province”: null,
“zip”: “86899”,
“provinceCode”: null,
“countryCodeV2”: “DE”,
“phone”: null
},
{
“address1”: “Justus-von-Liebig-Str. 3-5”,
“address2”: null,
“city”: “Landsberg am Lech”,
“country”: “Germany”,
“province”: null,
“zip”: “86899”,
“provinceCode”: null,
“countryCodeV2”: “DE”,
“phone”: “+498191823”
}
]
},
“shippingAddress”: {
“firstName”: “Florian”,
“lastName”: “Brand”,
“address1”: “Justus-Str. 3-5”,
“address2”: null,
“city”: “Landsberg am Lech”,
“country”: “Germany”,
“province”: null,
“zip”: “86899”,
“provinceCode”: null,
“countryCodeV2”: “DE”,
“phone”: “+49801823”
},
“billingAddress”: {
“firstName”: “Florian”,
“lastName”: “Brand”,
“address1”: “Von-Ke 15”,
“address2”: null,
“city”: “Landsberg am Lech”,
“country”: “Germany”,
“province”: null,
“zip”: “86899”,
“provinceCode”: null,
“countryCodeV2”: “DE”,
“phone”: null
}
}
Save Design from Magento
Endpoint: POST ${base_url}/saveDesignerUrl
Triggered by: Magento Admin Panel (on Save Design action)
Steps:
When a design is saved in the Magento admin panel for a product, Magento triggers a POST request to our connector endpoint with the following payload:
{
“image_url”: “image_url”,
“designer_url”: “designer_url”,
“enable_product_designer”: 0,
“integration_product_id”: 10001,
“action”: “save-design”
}
Payload Parameters:
| Key | Description |
| image_url | The final image output of the product design (used for preview/thumbnail). |
| designer_url | URL to the product designer/editor with saved state. |
| enable_product_designer | Flag indicating if the product designer is enabled (0 = No, 1 = Yes). |
| integration_product_id | The ID of the product in platform (integration side). |
Add to Cart (from Designer Tool)
Endpoint: POST ${base_url}/addToCart
Used by: Designer Tool (Client-side or Magento-integrated front-end)
Purpose:
To add a product customized via the Designer Tool to the customer’s cart on website, design-specific metadata (e.g., price, image, design price, designer URL, and custom options) is passed as part of the website cart data.
Payload Structure
Request Body:
{
“order”: [
{
“qty”: 1,
“integration_product_id”: “12345”, // website product id
“product_price”: 25.00,
“design_price”: 5.00,
“unit_price”: 30.00,
“integration_product_name”: “Custom Hoodie”,
“additional_options”: {
“product_design”: 789,
“canvas_resize”: null,
“custom_options”: []
},
“designer_url”: “https://designer.example.com/preview/abc123”,
“image_url”: “https://cdn.example.com/design.png”,
“item”: 1, // edit cart item
“integration_associate_id”: 123 // website variant product id
}
]
}