POST
https://test-api.finerworks.com/v3/list_static_products
List Static Products
Returns a list of non-dynamic products. These are generally accessory products.
Body
Request to be submitted
| Name | Description | Type | Additional information |
|---|---|---|---|
| ids | Optional - This can be the ids assigned to the static.. | array (number) | None. |
| account_key | Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and any submit orders will be based upon the user's api credentials. Leave as null or ignore if not explicitly required to use this parameter. | text | None. |
Example JSON Body
application/json, text/json
{
"ids": [
1,
2
],
"account_key": "sample string 1"
}
Sample Code Library
curl --location --request POST 'https://test-api.finerworks.com/v3/list_static_products' \
--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
],
"account_key": "sample string 1"
}'require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-api.finerworks.com/v3/list_static_products');
$request->setMethod(HTTP_Request2::METHOD_POST);
$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
],
'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://test-api.finerworks.com/v3/list_static_products");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
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
],
'account_key': 'sample string 1'
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);var settings = {
"url": "https://test-api.finerworks.com/v3/list_static_products",
"method": "POST",
"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
],
'account_key': 'sample string 1'
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});var https = require('follow-redirects').https;
var options = {
'method': 'POST',
'hostname': 'test-api.finerworks.com',
'path': '/v3/list_static_products',
'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 () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) { console.error(error); });
});
var postData = JSON.stringify({
'ids': [
1,
2
],
'account_key': 'sample string 1'
});
req.write(postData);
req.end();require "uri"
require "net/http"
url = URI("https://test-api.finerworks.com/v3/list_static_products")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.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
],
'account_key': 'sample string 1'
}"
response = https.request(request)
puts response.read_body| Name | Description | Type | Additional information |
|---|---|---|---|
| status | Status of response | response_status | None. |
| debug | Used to assist debugging any errors | Object | None. |
| products | Dictionary of number [key] and static_product [value] | None. |
Example JSON Response
application/json, text/json
{
"status": {
"success": true,
"status_code": 100,
"message": "sample string 2",
"debug": {},
"reference_id": "sample string 4",
"domain": "sample string 5"
},
"debug": {},
"products": {
"1": {
"id": 1,
"name": "sample string 2",
"price": 3.0,
"free_shipping": true,
"short_description": "sample string 5",
"long_description": "sample string 6",
"thumbnail": "sample string 7",
"image1": "sample string 8",
"image2": "sample string 9",
"image3": "sample string 10",
"image4": "sample string 11",
"alias": "sample string 12",
"tax_exempt": true,
"info1": "sample string 14",
"info2": "sample string 15",
"info3": "sample string 16",
"info4": "sample string 17",
"info5": "sample string 18",
"tab1": "sample string 19",
"tab2": "sample string 20",
"tab3": "sample string 21",
"tab4": "sample string 22",
"tab5": "sample string 23",
"tab6": "sample string 24",
"shipping_level": 25,
"options": {
"1": {
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"price": 4.0,
"static_product_id": 5,
"group_label": "sample string 6"
},
"2": {
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"price": 4.0,
"static_product_id": 5,
"group_label": "sample string 6"
}
}
},
"2": {
"id": 1,
"name": "sample string 2",
"price": 3.0,
"free_shipping": true,
"short_description": "sample string 5",
"long_description": "sample string 6",
"thumbnail": "sample string 7",
"image1": "sample string 8",
"image2": "sample string 9",
"image3": "sample string 10",
"image4": "sample string 11",
"alias": "sample string 12",
"tax_exempt": true,
"info1": "sample string 14",
"info2": "sample string 15",
"info3": "sample string 16",
"info4": "sample string 17",
"info5": "sample string 18",
"tab1": "sample string 19",
"tab2": "sample string 20",
"tab3": "sample string 21",
"tab4": "sample string 22",
"tab5": "sample string 23",
"tab6": "sample string 24",
"shipping_level": 25,
"options": {
"1": {
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"price": 4.0,
"static_product_id": 5,
"group_label": "sample string 6"
},
"2": {
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"price": 4.0,
"static_product_id": 5,
"group_label": "sample string 6"
}
}
}
}
}