Product Details
Uri: https://v2.api.finerworks.com/v3/get_product_details
Method: POST
Request details and pricing (up to 25 skus at a time) based on sku and quantity. Additional response parameters may be added in the future as requested.
Body
Name | Description | Type | Additional information |
---|---|---|---|
products |
List of products in in which to get details. |
array (product) |
Required |
account_key |
Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and any pricing will be retrieved based upon the user's api credentials. Leave as null if not authorized to use this parameter. |
text |
None. |
Example JSON Body
application/json, text/json
{ "products": [ { "product_order_po": "sample string 1", "product_qty": 2, "product_sku": "sample string 3", "product_image": { "pixel_width": 1, "pixel_height": 2, "product_url_file": "sample string 3", "product_url_thumbnail": "sample string 4", "library_file": { "id": 1, "guid": "cf2125bc-4f0e-4bd3-b4d6-04ee3f377339", "title": "sample string 3", "description": "sample string 4", "file_name": "sample string 5", "file_size": 6, "thumbnail_file_name": "sample string 7", "preview_file_name": "sample string 8", "hires_file_name": "sample string 9", "public_thumbnail_uri": "sample string 10", "public_preview_uri": "sample string 11", "personal_gallery_title": "sample string 12", "members_gallery_category": "sample string 13", "private_hires_uri": "sample string 14", "pix_w": 15, "pix_h": 16, "date_added": "2025-08-29T15:48:15.512257-05:00", "date_expires": "2025-08-29T15:48:15.5127732-05:00", "active": true, "products": [ { "monetary_format": "sample string 1", "quantity": 2, "quantity_in_stock": 3, "sku": "sample string 4", "product_code": "sample string 5", "price_details": { "product_qty": 1, "product_sku": "sample string 2", "product_code": "sample string 3", "product_price": 4.1, "add_frame_price": 5.1, "add_mat_1_price": 6.1, "add_mat_2_price": 7.1, "add_glazing_price": 8.1, "add_color_correct_price": 9.1, "total_price": 10.1, "info": "sample string 11", "debug": {} }, "per_item_price": 6.0, "total_price": 7.0, "asking_price": 8.0, "name": "sample string 9", "description_short": "sample string 10", "description_long": "sample string 11", "labels": [ { "key": "sample string 1", "value": "sample string 2", "priority": 3 }, { "key": "sample string 1", "value": "sample string 2", "priority": 3 } ], "image_url_1": "sample string 12", "image_url_2": "sample string 13", "image_url_3": "sample string 14", "image_url_4": "sample string 15", "image_url_5": "sample string 16", "image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c", "product_size": { "width": 1.0, "height": 2.0, "depth": 3.0, "ounces": 4.0, "cubic_volume": 5.0, "is_rigid": true }, "third_party_integrations": { "etsy_product_id": 1, "shopify_product_id": 2, "shopify_variant_id": 3, "squarespace_product_id": "sample string 4", "squarespace_variant_id": "sample string 5", "wix_inventory_id": "sample string 6", "wix_product_id": "sample string 7", "wix_variant_id": "sample string 8", "woocommerce_product_id": 9, "woocommerce_variant_id": 10 }, "framing_options": { "collection_ids": [ 1, 2 ], "allow_frames": true, "allow_matting": true, "allow_glazing": true, "frame_required": true, "allow_float_matting": true, "require_float_matting": true }, "product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a", "debug": {} }, { "monetary_format": "sample string 1", "quantity": 2, "quantity_in_stock": 3, "sku": "sample string 4", "product_code": "sample string 5", "price_details": { "product_qty": 1, "product_sku": "sample string 2", "product_code": "sample string 3", "product_price": 4.1, "add_frame_price": 5.1, "add_mat_1_price": 6.1, "add_mat_2_price": 7.1, "add_glazing_price": 8.1, "add_color_correct_price": 9.1, "total_price": 10.1, "info": "sample string 11", "debug": {} }, "per_item_price": 6.0, "total_price": 7.0, "asking_price": 8.0, "name": "sample string 9", "description_short": "sample string 10", "description_long": "sample string 11", "labels": [ { "key": "sample string 1", "value": "sample string 2", "priority": 3 }, { "key": "sample string 1", "value": "sample string 2", "priority": 3 } ], "image_url_1": "sample string 12", "image_url_2": "sample string 13", "image_url_3": "sample string 14", "image_url_4": "sample string 15", "image_url_5": "sample string 16", "image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c", "product_size": { "width": 1.0, "height": 2.0, "depth": 3.0, "ounces": 4.0, "cubic_volume": 5.0, "is_rigid": true }, "third_party_integrations": { "etsy_product_id": 1, "shopify_product_id": 2, "shopify_variant_id": 3, "squarespace_product_id": "sample string 4", "squarespace_variant_id": "sample string 5", "wix_inventory_id": "sample string 6", "wix_product_id": "sample string 7", "wix_variant_id": "sample string 8", "woocommerce_product_id": 9, "woocommerce_variant_id": 10 }, "framing_options": { "collection_ids": [ 1, 2 ], "allow_frames": true, "allow_matting": true, "allow_glazing": true, "frame_required": true, "allow_float_matting": true, "require_float_matting": true }, "product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a", "debug": {} } ] } }, "product_title": "sample string 5", "template": { "id": "012b0f4d-ca1d-4314-b683-1e228a32090b", "thumbnail_url": "sample string 2", "product_code": "sample string 3" }, "product_guid": "92b389b5-13d9-4e3c-8e73-5b49f293890a", "custom_data_1": "sample string 7", "custom_data_2": "sample string 8", "custom_data_3": "sample string 9" }, { "product_order_po": "sample string 1", "product_qty": 2, "product_sku": "sample string 3", "product_image": { "pixel_width": 1, "pixel_height": 2, "product_url_file": "sample string 3", "product_url_thumbnail": "sample string 4", "library_file": { "id": 1, "guid": "cf2125bc-4f0e-4bd3-b4d6-04ee3f377339", "title": "sample string 3", "description": "sample string 4", "file_name": "sample string 5", "file_size": 6, "thumbnail_file_name": "sample string 7", "preview_file_name": "sample string 8", "hires_file_name": "sample string 9", "public_thumbnail_uri": "sample string 10", "public_preview_uri": "sample string 11", "personal_gallery_title": "sample string 12", "members_gallery_category": "sample string 13", "private_hires_uri": "sample string 14", "pix_w": 15, "pix_h": 16, "date_added": "2025-08-29T15:48:15.512257-05:00", "date_expires": "2025-08-29T15:48:15.5127732-05:00", "active": true, "products": [ { "monetary_format": "sample string 1", "quantity": 2, "quantity_in_stock": 3, "sku": "sample string 4", "product_code": "sample string 5", "price_details": { "product_qty": 1, "product_sku": "sample string 2", "product_code": "sample string 3", "product_price": 4.1, "add_frame_price": 5.1, "add_mat_1_price": 6.1, "add_mat_2_price": 7.1, "add_glazing_price": 8.1, "add_color_correct_price": 9.1, "total_price": 10.1, "info": "sample string 11", "debug": {} }, "per_item_price": 6.0, "total_price": 7.0, "asking_price": 8.0, "name": "sample string 9", "description_short": "sample string 10", "description_long": "sample string 11", "labels": [ { "key": "sample string 1", "value": "sample string 2", "priority": 3 }, { "key": "sample string 1", "value": "sample string 2", "priority": 3 } ], "image_url_1": "sample string 12", "image_url_2": "sample string 13", "image_url_3": "sample string 14", "image_url_4": "sample string 15", "image_url_5": "sample string 16", "image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c", "product_size": { "width": 1.0, "height": 2.0, "depth": 3.0, "ounces": 4.0, "cubic_volume": 5.0, "is_rigid": true }, "third_party_integrations": { "etsy_product_id": 1, "shopify_product_id": 2, "shopify_variant_id": 3, "squarespace_product_id": "sample string 4", "squarespace_variant_id": "sample string 5", "wix_inventory_id": "sample string 6", "wix_product_id": "sample string 7", "wix_variant_id": "sample string 8", "woocommerce_product_id": 9, "woocommerce_variant_id": 10 }, "framing_options": { "collection_ids": [ 1, 2 ], "allow_frames": true, "allow_matting": true, "allow_glazing": true, "frame_required": true, "allow_float_matting": true, "require_float_matting": true }, "product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a", "debug": {} }, { "monetary_format": "sample string 1", "quantity": 2, "quantity_in_stock": 3, "sku": "sample string 4", "product_code": "sample string 5", "price_details": { "product_qty": 1, "product_sku": "sample string 2", "product_code": "sample string 3", "product_price": 4.1, "add_frame_price": 5.1, "add_mat_1_price": 6.1, "add_mat_2_price": 7.1, "add_glazing_price": 8.1, "add_color_correct_price": 9.1, "total_price": 10.1, "info": "sample string 11", "debug": {} }, "per_item_price": 6.0, "total_price": 7.0, "asking_price": 8.0, "name": "sample string 9", "description_short": "sample string 10", "description_long": "sample string 11", "labels": [ { "key": "sample string 1", "value": "sample string 2", "priority": 3 }, { "key": "sample string 1", "value": "sample string 2", "priority": 3 } ], "image_url_1": "sample string 12", "image_url_2": "sample string 13", "image_url_3": "sample string 14", "image_url_4": "sample string 15", "image_url_5": "sample string 16", "image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c", "product_size": { "width": 1.0, "height": 2.0, "depth": 3.0, "ounces": 4.0, "cubic_volume": 5.0, "is_rigid": true }, "third_party_integrations": { "etsy_product_id": 1, "shopify_product_id": 2, "shopify_variant_id": 3, "squarespace_product_id": "sample string 4", "squarespace_variant_id": "sample string 5", "wix_inventory_id": "sample string 6", "wix_product_id": "sample string 7", "wix_variant_id": "sample string 8", "woocommerce_product_id": 9, "woocommerce_variant_id": 10 }, "framing_options": { "collection_ids": [ 1, 2 ], "allow_frames": true, "allow_matting": true, "allow_glazing": true, "frame_required": true, "allow_float_matting": true, "require_float_matting": true }, "product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a", "debug": {} } ] } }, "product_title": "sample string 5", "template": { "id": "012b0f4d-ca1d-4314-b683-1e228a32090b", "thumbnail_url": "sample string 2", "product_code": "sample string 3" }, "product_guid": "92b389b5-13d9-4e3c-8e73-5b49f293890a", "custom_data_1": "sample string 7", "custom_data_2": "sample string 8", "custom_data_3": "sample string 9" } ], "account_key": "sample string 1" }
Sample Code Library
curl --location --request sample_method 'https://v2.api.finerworks.comsample_endpoint' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
"products": [
{
"product_order_po": "sample string 1",
"product_qty": 2,
"product_sku": "sample string 3",
"product_image": {
"pixel_width": 1,
"pixel_height": 2,
"product_url_file": "sample string 3",
"product_url_thumbnail": "sample string 4",
"library_file": {
"id": 1,
"guid": "cf2125bc-4f0e-4bd3-b4d6-04ee3f377339",
"title": "sample string 3",
"description": "sample string 4",
"file_name": "sample string 5",
"file_size": 6,
"thumbnail_file_name": "sample string 7",
"preview_file_name": "sample string 8",
"hires_file_name": "sample string 9",
"public_thumbnail_uri": "sample string 10",
"public_preview_uri": "sample string 11",
"personal_gallery_title": "sample string 12",
"members_gallery_category": "sample string 13",
"private_hires_uri": "sample string 14",
"pix_w": 15,
"pix_h": 16,
"date_added": "2025-08-29T15:48:15.512257-05:00",
"date_expires": "2025-08-29T15:48:15.5127732-05:00",
"active": true,
"products": [
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
},
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
}
]
}
},
"product_title": "sample string 5",
"template": {
"id": "012b0f4d-ca1d-4314-b683-1e228a32090b",
"thumbnail_url": "sample string 2",
"product_code": "sample string 3"
},
"product_guid": "92b389b5-13d9-4e3c-8e73-5b49f293890a",
"custom_data_1": "sample string 7",
"custom_data_2": "sample string 8",
"custom_data_3": "sample string 9"
},
{
"product_order_po": "sample string 1",
"product_qty": 2,
"product_sku": "sample string 3",
"product_image": {
"pixel_width": 1,
"pixel_height": 2,
"product_url_file": "sample string 3",
"product_url_thumbnail": "sample string 4",
"library_file": {
"id": 1,
"guid": "cf2125bc-4f0e-4bd3-b4d6-04ee3f377339",
"title": "sample string 3",
"description": "sample string 4",
"file_name": "sample string 5",
"file_size": 6,
"thumbnail_file_name": "sample string 7",
"preview_file_name": "sample string 8",
"hires_file_name": "sample string 9",
"public_thumbnail_uri": "sample string 10",
"public_preview_uri": "sample string 11",
"personal_gallery_title": "sample string 12",
"members_gallery_category": "sample string 13",
"private_hires_uri": "sample string 14",
"pix_w": 15,
"pix_h": 16,
"date_added": "2025-08-29T15:48:15.512257-05:00",
"date_expires": "2025-08-29T15:48:15.5127732-05:00",
"active": true,
"products": [
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
},
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
}
]
}
},
"product_title": "sample string 5",
"template": {
"id": "012b0f4d-ca1d-4314-b683-1e228a32090b",
"thumbnail_url": "sample string 2",
"product_code": "sample string 3"
},
"product_guid": "92b389b5-13d9-4e3c-8e73-5b49f293890a",
"custom_data_1": "sample string 7",
"custom_data_2": "sample string 8",
"custom_data_3": "sample string 9"
}
],
"account_key": "sample string 1"
}'
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://v2.api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
'products': [
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
},
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
}
],
'account_key': 'sample string 1'
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
var client = new RestClient("https://v2.api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
'products': [
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
},
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
}
],
'account_key': 'sample string 1'
}, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
var settings = {
"url": "https://v2.api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
'products': [
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
},
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
}
],
'account_key': 'sample string 1'
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'sample_method',
'hostname': 'api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = JSON.stringify({
"products": [
{
"product_order_po": "sample string 1",
"product_qty": 2,
"product_sku": "sample string 3",
"product_image": {
"pixel_width": 1,
"pixel_height": 2,
"product_url_file": "sample string 3",
"product_url_thumbnail": "sample string 4",
"library_file": {
"id": 1,
"guid": "cf2125bc-4f0e-4bd3-b4d6-04ee3f377339",
"title": "sample string 3",
"description": "sample string 4",
"file_name": "sample string 5",
"file_size": 6,
"thumbnail_file_name": "sample string 7",
"preview_file_name": "sample string 8",
"hires_file_name": "sample string 9",
"public_thumbnail_uri": "sample string 10",
"public_preview_uri": "sample string 11",
"personal_gallery_title": "sample string 12",
"members_gallery_category": "sample string 13",
"private_hires_uri": "sample string 14",
"pix_w": 15,
"pix_h": 16,
"date_added": "2025-08-29T15:48:15.512257-05:00",
"date_expires": "2025-08-29T15:48:15.5127732-05:00",
"active": true,
"products": [
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
},
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
}
]
}
},
"product_title": "sample string 5",
"template": {
"id": "012b0f4d-ca1d-4314-b683-1e228a32090b",
"thumbnail_url": "sample string 2",
"product_code": "sample string 3"
},
"product_guid": "92b389b5-13d9-4e3c-8e73-5b49f293890a",
"custom_data_1": "sample string 7",
"custom_data_2": "sample string 8",
"custom_data_3": "sample string 9"
},
{
"product_order_po": "sample string 1",
"product_qty": 2,
"product_sku": "sample string 3",
"product_image": {
"pixel_width": 1,
"pixel_height": 2,
"product_url_file": "sample string 3",
"product_url_thumbnail": "sample string 4",
"library_file": {
"id": 1,
"guid": "cf2125bc-4f0e-4bd3-b4d6-04ee3f377339",
"title": "sample string 3",
"description": "sample string 4",
"file_name": "sample string 5",
"file_size": 6,
"thumbnail_file_name": "sample string 7",
"preview_file_name": "sample string 8",
"hires_file_name": "sample string 9",
"public_thumbnail_uri": "sample string 10",
"public_preview_uri": "sample string 11",
"personal_gallery_title": "sample string 12",
"members_gallery_category": "sample string 13",
"private_hires_uri": "sample string 14",
"pix_w": 15,
"pix_h": 16,
"date_added": "2025-08-29T15:48:15.512257-05:00",
"date_expires": "2025-08-29T15:48:15.5127732-05:00",
"active": true,
"products": [
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
},
{
"monetary_format": "sample string 1",
"quantity": 2,
"quantity_in_stock": 3,
"sku": "sample string 4",
"product_code": "sample string 5",
"price_details": {
"product_qty": 1,
"product_sku": "sample string 2",
"product_code": "sample string 3",
"product_price": 4.1,
"add_frame_price": 5.1,
"add_mat_1_price": 6.1,
"add_mat_2_price": 7.1,
"add_glazing_price": 8.1,
"add_color_correct_price": 9.1,
"total_price": 10.1,
"info": "sample string 11",
"debug": {}
},
"per_item_price": 6.0,
"total_price": 7.0,
"asking_price": 8.0,
"name": "sample string 9",
"description_short": "sample string 10",
"description_long": "sample string 11",
"labels": [
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
},
{
"key": "sample string 1",
"value": "sample string 2",
"priority": 3
}
],
"image_url_1": "sample string 12",
"image_url_2": "sample string 13",
"image_url_3": "sample string 14",
"image_url_4": "sample string 15",
"image_url_5": "sample string 16",
"image_guid": "6bfd5861-c502-4d20-bd22-e98f8fa2ec6c",
"product_size": {
"width": 1.0,
"height": 2.0,
"depth": 3.0,
"ounces": 4.0,
"cubic_volume": 5.0,
"is_rigid": true
},
"third_party_integrations": {
"etsy_product_id": 1,
"shopify_product_id": 2,
"shopify_variant_id": 3,
"squarespace_product_id": "sample string 4",
"squarespace_variant_id": "sample string 5",
"wix_inventory_id": "sample string 6",
"wix_product_id": "sample string 7",
"wix_variant_id": "sample string 8",
"woocommerce_product_id": 9,
"woocommerce_variant_id": 10
},
"framing_options": {
"collection_ids": [
1,
2
],
"allow_frames": true,
"allow_matting": true,
"allow_glazing": true,
"frame_required": true,
"allow_float_matting": true,
"require_float_matting": true
},
"product_guid": "497067f3-8d8c-42dd-9eec-d335785d063a",
"debug": {}
}
]
}
},
"product_title": "sample string 5",
"template": {
"id": "012b0f4d-ca1d-4314-b683-1e228a32090b",
"thumbnail_url": "sample string 2",
"product_code": "sample string 3"
},
"product_guid": "92b389b5-13d9-4e3c-8e73-5b49f293890a",
"custom_data_1": "sample string 7",
"custom_data_2": "sample string 8",
"custom_data_3": "sample string 9"
}
],
"account_key": "sample string 1"
});
req.write(postData);
req.end();
require "uri"
require "net/http"
url = URI("https://v2.api.finerworks.comsample_endpoint")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::sample_method.new(url)
request["Content-Type"] = "application/json"
request["web_api_key"] = "my-web-api-key-goes-here"
request["app_key"] = "my-app-key-goes-here"
request.body = "{
'products': [
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
},
{
'product_order_po': 'sample string 1',
'product_qty': 2,
'product_sku': 'sample string 3',
'product_image': {
'pixel_width': 1,
'pixel_height': 2,
'product_url_file': 'sample string 3',
'product_url_thumbnail': 'sample string 4',
'library_file': {
'id': 1,
'guid': 'cf2125bc-4f0e-4bd3-b4d6-04ee3f377339',
'title': 'sample string 3',
'description': 'sample string 4',
'file_name': 'sample string 5',
'file_size': 6,
'thumbnail_file_name': 'sample string 7',
'preview_file_name': 'sample string 8',
'hires_file_name': 'sample string 9',
'public_thumbnail_uri': 'sample string 10',
'public_preview_uri': 'sample string 11',
'personal_gallery_title': 'sample string 12',
'members_gallery_category': 'sample string 13',
'private_hires_uri': 'sample string 14',
'pix_w': 15,
'pix_h': 16,
'date_added': '2025-08-29T15:48:15.512257-05:00',
'date_expires': '2025-08-29T15:48:15.5127732-05:00',
'active': true,
'products': [
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
},
{
'monetary_format': 'sample string 1',
'quantity': 2,
'quantity_in_stock': 3,
'sku': 'sample string 4',
'product_code': 'sample string 5',
'price_details': {
'product_qty': 1,
'product_sku': 'sample string 2',
'product_code': 'sample string 3',
'product_price': 4.1,
'add_frame_price': 5.1,
'add_mat_1_price': 6.1,
'add_mat_2_price': 7.1,
'add_glazing_price': 8.1,
'add_color_correct_price': 9.1,
'total_price': 10.1,
'info': 'sample string 11',
'debug': {}
},
'per_item_price': 6.0,
'total_price': 7.0,
'asking_price': 8.0,
'name': 'sample string 9',
'description_short': 'sample string 10',
'description_long': 'sample string 11',
'labels': [
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
},
{
'key': 'sample string 1',
'value': 'sample string 2',
'priority': 3
}
],
'image_url_1': 'sample string 12',
'image_url_2': 'sample string 13',
'image_url_3': 'sample string 14',
'image_url_4': 'sample string 15',
'image_url_5': 'sample string 16',
'image_guid': '6bfd5861-c502-4d20-bd22-e98f8fa2ec6c',
'product_size': {
'width': 1.0,
'height': 2.0,
'depth': 3.0,
'ounces': 4.0,
'cubic_volume': 5.0,
'is_rigid': true
},
'third_party_integrations': {
'etsy_product_id': 1,
'shopify_product_id': 2,
'shopify_variant_id': 3,
'squarespace_product_id': 'sample string 4',
'squarespace_variant_id': 'sample string 5',
'wix_inventory_id': 'sample string 6',
'wix_product_id': 'sample string 7',
'wix_variant_id': 'sample string 8',
'woocommerce_product_id': 9,
'woocommerce_variant_id': 10
},
'framing_options': {
'collection_ids': [
1,
2
],
'allow_frames': true,
'allow_matting': true,
'allow_glazing': true,
'frame_required': true,
'allow_float_matting': true,
'require_float_matting': true
},
'product_guid': '497067f3-8d8c-42dd-9eec-d335785d063a',
'debug': {}
}
]
}
},
'product_title': 'sample string 5',
'template': {
'id': '012b0f4d-ca1d-4314-b683-1e228a32090b',
'thumbnail_url': 'sample string 2',
'product_code': 'sample string 3'
},
'product_guid': '92b389b5-13d9-4e3c-8e73-5b49f293890a',
'custom_data_1': 'sample string 7',
'custom_data_2': 'sample string 8',
'custom_data_3': 'sample string 9'
}
],
'account_key': 'sample string 1'
}"
response = https.request(request)
puts response.read_body
Name | Description | Type | Additional information |
---|---|---|---|
status | response_status |
None. |
|
product_list | array (product_details) |
None. |
Example JSON Response
application/json, text/json
{ "status": { "success": true, "status_code": 100, "message": "sample string 2", "debug": {}, "reference_id": "sample string 4" }, "product_list": [ { "monetary_format": "sample string 1", "quantity": 2, "quantity_in_stock": 3, "sku": "sample string 4", "product_code": "sample string 5", "price_details": { "product_qty": 1, "product_sku": "sample string 2", "product_code": "sample string 3", "product_price": 4.1, "add_frame_price": 5.1, "add_mat_1_price": 6.1, "add_mat_2_price": 7.1, "add_glazing_price": 8.1, "add_color_correct_price": 9.1, "total_price": 10.1, "info": "sample string 11", "debug": {} }, "per_item_price": 6.0, "total_price": 7.0, "asking_price": 8.0, "name": "sample string 9", "description_short": "sample string 10", "description_long": "sample string 11", "labels": [ { "key": "sample string 1", "value": "sample string 2", "priority": 3 }, { "key": "sample string 1", "value": "sample string 2", "priority": 3 } ], "image_url_1": "sample string 12", "image_url_2": "sample string 13", "image_url_3": "sample string 14", "image_url_4": "sample string 15", "image_url_5": "sample string 16", "image_guid": "af287754-96e4-4c95-81d3-59ad4330d748", "product_size": { "width": 1.0, "height": 2.0, "depth": 3.0, "ounces": 4.0, "cubic_volume": 5.0, "is_rigid": true }, "third_party_integrations": { "etsy_product_id": 1, "shopify_product_id": 2, "shopify_variant_id": 3, "squarespace_product_id": "sample string 4", "squarespace_variant_id": "sample string 5", "wix_inventory_id": "sample string 6", "wix_product_id": "sample string 7", "wix_variant_id": "sample string 8", "woocommerce_product_id": 9, "woocommerce_variant_id": 10 }, "framing_options": { "collection_ids": [ 1, 2 ], "allow_frames": true, "allow_matting": true, "allow_glazing": true, "frame_required": true, "allow_float_matting": true, "require_float_matting": true }, "product_guid": "0446ad23-47f8-4ecd-9621-aaf5fa721031", "debug": {} }, { "monetary_format": "sample string 1", "quantity": 2, "quantity_in_stock": 3, "sku": "sample string 4", "product_code": "sample string 5", "price_details": { "product_qty": 1, "product_sku": "sample string 2", "product_code": "sample string 3", "product_price": 4.1, "add_frame_price": 5.1, "add_mat_1_price": 6.1, "add_mat_2_price": 7.1, "add_glazing_price": 8.1, "add_color_correct_price": 9.1, "total_price": 10.1, "info": "sample string 11", "debug": {} }, "per_item_price": 6.0, "total_price": 7.0, "asking_price": 8.0, "name": "sample string 9", "description_short": "sample string 10", "description_long": "sample string 11", "labels": [ { "key": "sample string 1", "value": "sample string 2", "priority": 3 }, { "key": "sample string 1", "value": "sample string 2", "priority": 3 } ], "image_url_1": "sample string 12", "image_url_2": "sample string 13", "image_url_3": "sample string 14", "image_url_4": "sample string 15", "image_url_5": "sample string 16", "image_guid": "af287754-96e4-4c95-81d3-59ad4330d748", "product_size": { "width": 1.0, "height": 2.0, "depth": 3.0, "ounces": 4.0, "cubic_volume": 5.0, "is_rigid": true }, "third_party_integrations": { "etsy_product_id": 1, "shopify_product_id": 2, "shopify_variant_id": 3, "squarespace_product_id": "sample string 4", "squarespace_variant_id": "sample string 5", "wix_inventory_id": "sample string 6", "wix_product_id": "sample string 7", "wix_variant_id": "sample string 8", "woocommerce_product_id": 9, "woocommerce_variant_id": 10 }, "framing_options": { "collection_ids": [ 1, 2 ], "allow_frames": true, "allow_matting": true, "allow_glazing": true, "frame_required": true, "allow_float_matting": true, "require_float_matting": true }, "product_guid": "0446ad23-47f8-4ecd-9621-aaf5fa721031", "debug": {} } ] }