Create a gift card product
Learn how to create a gift card product using the REST API and the ÃÛ¶¹ÊÓƵ Commerce Admin.
Who is this video for?
- Website managers
- eCommerce merchandisers
- New ÃÛ¶¹ÊÓƵ Commerce developers who want to learn how to create products in ÃÛ¶¹ÊÓƵ Commerce using the REST API.
Video content
Create a gift card with a simple payload
The following request example shows the payload to create a gift card like the one shown in the video. This smaller payload overrides the default settings for a subset of the available attributes. The remaining attributes not included in the payload remain set to the default values.
curl --location '{{your.url.here}}/rest/default/V1/products' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Your Bearer Token}}' \
--header 'Cookie: PHPSESSID=83b55460e3ab1bf903fab59dfedc81c6; private_content_version=41d94540f5bd8b691017a850bc3b82b3' \
--data '{
"product": {
"sku": "giftcard21",
"name": "giftcard21",
"attribute_set_id": {{Your Attribute Set ID}},
"price": 0,
"status": 1,
"visibility": 4,
"type_id": "giftcard",
"weight": 1,
"extension_attributes": {
"website_ids": [
1
],
"stock_item": {
"qty": 1000,
"is_in_stock": true
},
"giftcard_amounts": [
{
"attribute_id": {{Your attribute ID for giftcard_amounts},
"website_id": 0,
"value": 10,
"website_value": null
},
{
"attribute_id": {{Your attribute ID for giftcard_amounts},
"website_id": 0,
"value": 20,
"website_value": null
}
]
},
"custom_attributes": [
{
"attribute_code": "gift_message_available",
"value": "2"
},
{
"attribute_code": "is_redeemable",
"value": "1"
},
{
"attribute_code": "required_options",
"value": "1"
},
{
"attribute_code": "use_config_is_redeemable",
"value": "1"
},
{
"attribute_code": "has_options",
"value": "1"
},
{
"attribute_code": "allow_message",
"value": "1"
},
{
"attribute_code": "giftcard_type",
"value": "1"
},
{
"attribute_code": "giftcard_amounts",
"value": [
{
"website_id": "0",
"value": "10.0000",
"attribute_id": "{{Your attribute ID for giftcard_amounts}",
"website_value": 10
},
{
"website_id": "0",
"value": "20.0000",
"attribute_id": "{{Your attribute ID for giftcard_amounts}",
"website_value": 20
}
]
},
{
"attribute_code": "allow_open_amount",
"value": "1"
},
{
"attribute_code": "open_amount_min",
"value": "10.000000"
},
{
"attribute_code": "open_amount_max",
"value": "100.000000"
},
{
"attribute_code": "is_returnable",
"value": "2"
}
]
}
}'
Create a gift card with a full payload
The following example shows the POST request to create a gift card with a full payload. The payload includes all attributes that can configured when you create a gift card. If you use this code sample, customize the configuration by updating the default values for each attribute as needed before submitting the request.
curl --location '{{your.url.here}}/rest/default/V1/products' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Your Bearer Token}}' \
--header 'Cookie: PHPSESSID=83b55460e3ab1bf903fab59dfedc81c6; private_content_version=41d94540f5bd8b691017a850bc3b82b3' \
--data '{
"product": {
"sku": "giftcard22",
"name": "giftcard22",
"attribute_set_id": {{Your Attribute Set ID}},
"price": 0,
"status": 1,
"visibility": 4,
"type_id": "giftcard",
"created_at": "2024-01-24 20:54:54",
"updated_at": "2024-01-24 20:54:54",
"weight": 1,
"extension_attributes": {
"website_ids": [
1
],
"stock_item": {
"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
},
"giftcard_amounts": [
{
"attribute_id": {{Your attribute ID for giftcard_amounts},
"website_id": 0,
"value": 10,
"website_value": null
},
{
"attribute_id": {{Your attribute ID for giftcard_amounts},
"website_id": 0,
"value": 20,
"website_value": null
}
]
},
"product_links": [],
"options": [],
"media_gallery_entries": [],
"tier_prices": [],
"custom_attributes": [
{
"attribute_code": "options_container",
"value": "container2"
},
{
"attribute_code": "url_key",
"value": "giftcard22"
},
{
"attribute_code": "gift_message_available",
"value": "2"
},
{
"attribute_code": "is_redeemable",
"value": "1"
},
{
"attribute_code": "required_options",
"value": "1"
},
{
"attribute_code": "use_config_is_redeemable",
"value": "1"
},
{
"attribute_code": "has_options",
"value": "1"
},
{
"attribute_code": "lifetime",
"value": "0"
},
{
"attribute_code": "use_config_lifetime",
"value": "1"
},
{
"attribute_code": "email_template",
"value": "giftcard_email_template"
},
{
"attribute_code": "use_config_email_template",
"value": "1"
},
{
"attribute_code": "allow_message",
"value": "1"
},
{
"attribute_code": "meta_title",
"value": "giftcard22"
},
{
"attribute_code": "use_config_allow_message",
"value": "1"
},
{
"attribute_code": "gift_wrapping_available",
"value": "2"
},
{
"attribute_code": "meta_keyword",
"value": "giftcard22"
},
{
"attribute_code": "giftcard_type",
"value": "1"
},
{
"attribute_code": "giftcard_amounts",
"value": [
{
"website_id": "0",
"value": "10.0000",
"attribute_id": "{{Your attribute ID for giftcard_amounts}",
"website_value": 10
},
{
"website_id": "0",
"value": "20.0000",
"attribute_id": "{{Your attribute ID for giftcard_amounts}",
"website_value": 20
}
]
},
{
"attribute_code": "allow_open_amount",
"value": "1"
},
{
"attribute_code": "open_amount_min",
"value": "10.000000"
},
{
"attribute_code": "open_amount_max",
"value": "100.000000"
},
{
"attribute_code": "meta_description",
"value": "giftcard22"
},
{
"attribute_code": "is_returnable",
"value": "2"
}
]
}
}'
3a5f7e19-f383-4af8-8983-d01154c1402f