Product Details
Uri: https://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

NameDescriptionTypeAdditional information
product_order_po

Optional - This is a unique order identifier or reference number. For example, an order numnber generated by your shopping cart or application.

 text

Max length: 50
product_qty

Optional - Number of copies of this product.

 number

Required

Range: inclusive between 1 and 999
product_sku

Either a sku within your virtual inventory or a product code.

 text

Required
product_image

Required if a print on demand production and not from your virtual inventory.

 product_image_file

None.
product_title

Optional title or descriptive name

 text

Max length: 50
template

Can be left as null

 Object

None.
product_guid

Optional - A 128-bit integer (16 bytes) unique identifier

 globally unique identifier

None.
custom_data_1

Optional - custom data field that can be used by developers.

 text

None.
custom_data_2

Optional - custom data field that can be used by developers.

 text

None.
custom_data_3

Optional - custom data field that can be used by developers.

 text

None.

Example JSON Body

application/json, text/json

[
  {
    "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"
    },
    "product_title": "sample string 5",
    "template": {},
    "product_guid": "e9a628d7-95da-4fdc-81a3-a1db431546e2",
    "custom_data_1": "sample string 8",
    "custom_data_2": "sample string 9",
    "custom_data_3": "sample string 10"
  },
  {
    "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"
    },
    "product_title": "sample string 5",
    "template": {},
    "product_guid": "e9a628d7-95da-4fdc-81a3-a1db431546e2",
    "custom_data_1": "sample string 8",
    "custom_data_2": "sample string 9",
    "custom_data_3": "sample string 10"
  }
]

Sample Code Library


                        
curl --location --request sample_method 'https://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 '[
  {
    "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"
    },
    "product_title": "sample string 5",
    "template": {},
    "product_guid": "e9a628d7-95da-4fdc-81a3-a1db431546e2",
    "custom_data_1": "sample string 8",
    "custom_data_2": "sample string 9",
    "custom_data_3": "sample string 10"
  },
  {
    "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"
    },
    "product_title": "sample string 5",
    "template": {},
    "product_guid": "e9a628d7-95da-4fdc-81a3-a1db431546e2",
    "custom_data_1": "sample string 8",
    "custom_data_2": "sample string 9",
    "custom_data_3": "sample string 10"
  }
]'
                            
                        


require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://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('[
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  },
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  }
]');
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://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", "[
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  },
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  }
],  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

                        


var settings = {
"url": "https://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([
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  },
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  }
]),
};

$.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([
  {
    "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"
    },
    "product_title": "sample string 5",
    "template": {},
    "product_guid": "e9a628d7-95da-4fdc-81a3-a1db431546e2",
    "custom_data_1": "sample string 8",
    "custom_data_2": "sample string 9",
    "custom_data_3": "sample string 10"
  },
  {
    "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"
    },
    "product_title": "sample string 5",
    "template": {},
    "product_guid": "e9a628d7-95da-4fdc-81a3-a1db431546e2",
    "custom_data_1": "sample string 8",
    "custom_data_2": "sample string 9",
    "custom_data_3": "sample string 10"
  }
]);

req.write(postData);

req.end();
                            
                        

                        
    require "uri"
    require "net/http"

    url = URI("https://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 = "[
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  },
  {
    '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'
    },
    'product_title': 'sample string 5',
    'template': {},
    'product_guid': 'e9a628d7-95da-4fdc-81a3-a1db431546e2',
    'custom_data_1': 'sample string 8',
    'custom_data_2': 'sample string 9',
    'custom_data_3': 'sample string 10'
  }
]"

    response = https.request(request)
    puts response.read_body

NameDescriptionTypeAdditional 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": {}
  },
  "product_list": [
    {
      "monetary_format": "sample string 1",
      "quantity": 2,
      "sku": "sample string 3",
      "product_code": "sample string 4",
      "per_item_price": 5.0,
      "total_price": 6.0,
      "asking_price": 7.0,
      "name": "sample string 8",
      "description_short": "sample string 9",
      "description_long": "sample string 10",
      "image_url_1": "sample string 11",
      "image_url_2": "sample string 12",
      "image_url_3": "sample string 13",
      "image_url_4": "sample string 14",
      "image_url_5": "sample string 15",
      "image_guid": "90e1d694-abda-4cf5-b6d8-bb6eb6cc3535"
    },
    {
      "monetary_format": "sample string 1",
      "quantity": 2,
      "sku": "sample string 3",
      "product_code": "sample string 4",
      "per_item_price": 5.0,
      "total_price": 6.0,
      "asking_price": 7.0,
      "name": "sample string 8",
      "description_short": "sample string 9",
      "description_long": "sample string 10",
      "image_url_1": "sample string 11",
      "image_url_2": "sample string 12",
      "image_url_3": "sample string 13",
      "image_url_4": "sample string 14",
      "image_url_5": "sample string 15",
      "image_guid": "90e1d694-abda-4cf5-b6d8-bb6eb6cc3535"
    }
  ]
}