List Frame Collections
Uri: https://api.finerworks.com/v3/list_collections
Method: POST

List all available frame categories .

Body

NameDescriptionTypeAdditional information
id

Optional - Filter by collection id. Required in order to get a list of available frames in this collection.

 number

None.
product_code

Optional - Filter by product code if you want to only show collections / frames that are compatible with your print product.

 text

None.

Example JSON Body

application/json, text/json

{
  "id": 1,
  "product_code": "sample string 2"
}

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 '{
  "id": 1,
  "product_code": "sample string 2"
}'
                            
                        


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('{
  'id': 1,
  'product_code': 'sample string 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://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", "{
  'id': 1,
  'product_code': 'sample string 2'
},  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({
  'id': 1,
  'product_code': 'sample string 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': '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({
  "id": 1,
  "product_code": "sample string 2"
});

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 = "{
  'id': 1,
  'product_code': 'sample string 2'
}"

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

NameDescriptionTypeAdditional information
status

response_status

None.
collections

array (frame_collection)

None.

Example JSON Response

application/json, text/json

{
  "status": {
    "success": true,
    "status_code": 100,
    "message": "sample string 2",
    "debug": {}
  },
  "collections": [
    {
      "id": 1,
      "icon_url_1": "sample string 2",
      "icon_url_2": "sample string 3",
      "icon_url_3": "sample string 4",
      "name": "sample string 5",
      "description": "sample string 6",
      "alias": "sample string 7",
      "starting_price": 8.1,
      "frames": [
        {
          "id": 1,
          "name": "sample string 2",
          "thickness": 3.0,
          "depth": 4.0,
          "float_offset": 5.0,
          "rabbet": 6.0,
          "lip": 7.0,
          "profile_svg_url": "sample string 8",
          "sample_image_url_1": "sample string 9",
          "sample_image_url_2": "sample string 10",
          "sample_image_url_3": "sample string 11",
          "min_width": 12.0,
          "min_height": 13.0,
          "max_width": 14.0,
          "max_height": 15.0,
          "price_level": 16,
          "allow_glazing": true,
          "allow_matting": true,
          "color": "sample string 19",
          "composite": "sample string 20",
          "segment_url": "sample string 21",
          "sample_length": 22.0,
          "class_alias": "sample string 23",
          "starting_price": 24.1
        },
        {
          "id": 1,
          "name": "sample string 2",
          "thickness": 3.0,
          "depth": 4.0,
          "float_offset": 5.0,
          "rabbet": 6.0,
          "lip": 7.0,
          "profile_svg_url": "sample string 8",
          "sample_image_url_1": "sample string 9",
          "sample_image_url_2": "sample string 10",
          "sample_image_url_3": "sample string 11",
          "min_width": 12.0,
          "min_height": 13.0,
          "max_width": 14.0,
          "max_height": 15.0,
          "price_level": 16,
          "allow_glazing": true,
          "allow_matting": true,
          "color": "sample string 19",
          "composite": "sample string 20",
          "segment_url": "sample string 21",
          "sample_length": 22.0,
          "class_alias": "sample string 23",
          "starting_price": 24.1
        }
      ]
    },
    {
      "id": 1,
      "icon_url_1": "sample string 2",
      "icon_url_2": "sample string 3",
      "icon_url_3": "sample string 4",
      "name": "sample string 5",
      "description": "sample string 6",
      "alias": "sample string 7",
      "starting_price": 8.1,
      "frames": [
        {
          "id": 1,
          "name": "sample string 2",
          "thickness": 3.0,
          "depth": 4.0,
          "float_offset": 5.0,
          "rabbet": 6.0,
          "lip": 7.0,
          "profile_svg_url": "sample string 8",
          "sample_image_url_1": "sample string 9",
          "sample_image_url_2": "sample string 10",
          "sample_image_url_3": "sample string 11",
          "min_width": 12.0,
          "min_height": 13.0,
          "max_width": 14.0,
          "max_height": 15.0,
          "price_level": 16,
          "allow_glazing": true,
          "allow_matting": true,
          "color": "sample string 19",
          "composite": "sample string 20",
          "segment_url": "sample string 21",
          "sample_length": 22.0,
          "class_alias": "sample string 23",
          "starting_price": 24.1
        },
        {
          "id": 1,
          "name": "sample string 2",
          "thickness": 3.0,
          "depth": 4.0,
          "float_offset": 5.0,
          "rabbet": 6.0,
          "lip": 7.0,
          "profile_svg_url": "sample string 8",
          "sample_image_url_1": "sample string 9",
          "sample_image_url_2": "sample string 10",
          "sample_image_url_3": "sample string 11",
          "min_width": 12.0,
          "min_height": 13.0,
          "max_width": 14.0,
          "max_height": 15.0,
          "price_level": 16,
          "allow_glazing": true,
          "allow_matting": true,
          "color": "sample string 19",
          "composite": "sample string 20",
          "segment_url": "sample string 21",
          "sample_length": 22.0,
          "class_alias": "sample string 23",
          "starting_price": 24.1
        }
      ]
    }
  ]
}