List Printables
Uri: https://test-api.finerworks.com/v3/list_printables
Method: POST

Get a list of printable products available at FinerWorks.


Body

NameDescriptionTypeAdditional information
ids

Optional list of photo item ids if you wish to filter the list.

array (number)

None.

Example JSON Body

application/json, text/json

{
  "ids": [
    1,
    2
  ]
}

Sample Code Library


                        
curl --location --request sample_method 'https://test-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 '{
  "ids": [
    1,
    2
  ]
}'
                            
                        


require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-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('{
  'ids': [
    1,
    2
  ]
}');
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://test-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", "{
  'ids': [
    1,
    2
  ]
},  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

                        


var settings = {
"url": "https://test-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({
  'ids': [
    1,
    2
  ]
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

                        

                        
var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
'method': 'sample_method',
'hostname': 'v2.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({
  "ids": [
    1,
    2
  ]
});

req.write(postData);

req.end();
                            
                        

                        
    require "uri"
    require "net/http"

    url = URI("https://test-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 = "{
  'ids': [
    1,
    2
  ]
}"

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


                        

NameDescriptionTypeAdditional information
printables

array (printable)

None.

status

response_status

None.

Example JSON Response

application/json, text/json

{
  "printables": [
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "icon_url": "sample string 4",
      "price": 5.0,
      "sale_price": 6.0,
      "bulk_rates": {
        "1": 2.0,
        "3": 4.0
      },
      "color_correct_price": 7.0,
      "option_1_ids": [
        1,
        2
      ],
      "option_2_ids": [
        1,
        2
      ],
      "option_3_ids": [
        1,
        2
      ]
    },
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "icon_url": "sample string 4",
      "price": 5.0,
      "sale_price": 6.0,
      "bulk_rates": {
        "1": 2.0,
        "3": 4.0
      },
      "color_correct_price": 7.0,
      "option_1_ids": [
        1,
        2
      ],
      "option_2_ids": [
        1,
        2
      ],
      "option_3_ids": [
        1,
        2
      ]
    }
  ],
  "status": {
    "success": true,
    "status_code": 100,
    "message": "sample string 2",
    "debug": {},
    "reference_id": "sample string 4",
    "domain": "sample string 5"
  }
}