Get Price List
Uri: https://test-api.finerworks.com/v3/get_prices
Method: POST

Returns a list of prices and their breakdown based on a list of product codes or virtual inventory skus. Request as few as 1 or as many as 50 in the body of the request.

Body

NameDescriptionTypeAdditional information
products

List of products in which pricing is requested.

 array (pricing_item)

Required
account_key

Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and 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_qty": 1,
      "product_sku": "sample string 2"
    },
    {
      "product_qty": 1,
      "product_sku": "sample string 2"
    }
  ],
  "account_key": "sample string 1"
}

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 '{
  "products": [
    {
      "product_qty": 1,
      "product_sku": "sample string 2"
    },
    {
      "product_qty": 1,
      "product_sku": "sample string 2"
    }
  ],
  "account_key": "sample string 1"
}'
                            
                        


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('{
  'products': [
    {
      'product_qty': 1,
      'product_sku': 'sample string 2'
    },
    {
      'product_qty': 1,
      'product_sku': 'sample string 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.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_qty': 1,
      'product_sku': 'sample string 2'
    },
    {
      'product_qty': 1,
      'product_sku': 'sample string 2'
    }
  ],
  'account_key': 'sample string 1'
},  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({
  'products': [
    {
      'product_qty': 1,
      'product_sku': 'sample string 2'
    },
    {
      'product_qty': 1,
      'product_sku': 'sample string 2'
    }
  ],
  '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_qty": 1,
      "product_sku": "sample string 2"
    },
    {
      "product_qty": 1,
      "product_sku": "sample string 2"
    }
  ],
  "account_key": "sample string 1"
});

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 = "{
  'products': [
    {
      'product_qty': 1,
      'product_sku': 'sample string 2'
    },
    {
      'product_qty': 1,
      'product_sku': 'sample string 2'
    }
  ],
  'account_key': 'sample string 1'
}"

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

NameDescriptionTypeAdditional information
prices

A list of prices

 array (price)

None.
status

response_status

None.

Example JSON Response

application/json, text/json

{
  "prices": [
    {
      "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": {}
    },
    {
      "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": {}
    }
  ],
  "status": {
    "success": true,
    "status_code": 100,
    "message": "sample string 2",
    "debug": {},
    "reference_id": "sample string 4"
  }
}