Update Virtual Inventory
Uri: https://test-api.finerworks.com/v3/update_virtual_inventory
Method: PUT
Updates virtual inventory items within a user's account.
Body
| Name | Description | Type | Additional information |
|---|---|---|---|
| virtual_inventory |
An array of virtual inventory items you want to update. Update up to 50 at a time. |
array (product_details_update) |
Required |
| account_key |
Optional - This updates virtual inventory by account_key. Note, this will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and virtual inventory 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
{
"virtual_inventory": [
{
"sku": "AP1556P79511",
"asking_price": 200.0,
"name": "Framed Giclee - Fine Art Paper Prints",
"description": "<h4>Framed Giclee - Fine Art Paper Prints</h4><ul>8 x 10\" Archival Canvas Paper<ul><li>1/2\" Extra Border Added</li></ul></li><li>Frame: Rustic Britanny<ul><li>Vermill Red 1-1/2\" (354303)<ul><li>13 x 15\"</li></ul></li></ul></li><li>Single Mat: Off White (A4902)<ul><li>13 x 15\" (window: 9 x 11)</li></ul></li><li>Glazing (Acrylic Glass): Premium Clear </li></ul>",
"quantity_in_stock": 10,
"track_inventory": true,
"third_party_integrations": {
"etsy_product_id": 0,
"shopify_product_id": 123456789,
"shopify_variant_id": 24681012,
"squarespace_product_id": null,
"squarespace_variant_id": null,
"wix_inventory_id": null,
"wix_product_id": null,
"wix_variant_id": null,
"woocommerce_product_id": 0,
"woocommerce_variant_id": 0
}
}
],
"account_key": null
}
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 '{
"virtual_inventory": [
{
"sku": "AP1556P79511",
"asking_price": 200.0,
"name": "Framed Giclee - Fine Art Paper Prints",
"description": "<h4>Framed Giclee - Fine Art Paper Prints</h4><ul>8 x 10\" Archival Canvas Paper<ul><li>1/2\" Extra Border Added</li></ul></li><li>Frame: Rustic Britanny<ul><li>Vermill Red 1-1/2\" (354303)<ul><li>13 x 15\"</li></ul></li></ul></li><li>Single Mat: Off White (A4902)<ul><li>13 x 15\" (window: 9 x 11)</li></ul></li><li>Glazing (Acrylic Glass): Premium Clear </li></ul>",
"quantity_in_stock": 10,
"track_inventory": true,
"third_party_integrations": {
"etsy_product_id": 0,
"shopify_product_id": 123456789,
"shopify_variant_id": 24681012,
"squarespace_product_id": null,
"squarespace_variant_id": null,
"wix_inventory_id": null,
"wix_product_id": null,
"wix_variant_id": null,
"woocommerce_product_id": 0,
"woocommerce_variant_id": 0
}
}
],
"account_key": null
}'
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('{
'virtual_inventory': [
{
'sku': 'AP1556P79511',
'asking_price': 200.0,
'name': 'Framed Giclee - Fine Art Paper Prints',
'description': '<h4>Framed Giclee - Fine Art Paper Prints</h4><ul>8 x 10\' Archival Canvas Paper<ul><li>1/2\' Extra Border Added</li></ul></li><li>Frame: Rustic Britanny<ul><li>Vermill Red 1-1/2\' (354303)<ul><li>13 x 15\'</li></ul></li></ul></li><li>Single Mat: Off White (A4902)<ul><li>13 x 15\' (window: 9 x 11)</li></ul></li><li>Glazing (Acrylic Glass): Premium Clear </li></ul>',
'quantity_in_stock': 10,
'track_inventory': true,
'third_party_integrations': {
'etsy_product_id': 0,
'shopify_product_id': 123456789,
'shopify_variant_id': 24681012,
'squarespace_product_id': null,
'squarespace_variant_id': null,
'wix_inventory_id': null,
'wix_product_id': null,
'wix_variant_id': null,
'woocommerce_product_id': 0,
'woocommerce_variant_id': 0
}
}
],
'account_key': null
}');
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", "{
'virtual_inventory': [
{
'sku': 'AP1556P79511',
'asking_price': 200.0,
'name': 'Framed Giclee - Fine Art Paper Prints',
'description': '<h4>Framed Giclee - Fine Art Paper Prints</h4><ul>8 x 10\' Archival Canvas Paper<ul><li>1/2\' Extra Border Added</li></ul></li><li>Frame: Rustic Britanny<ul><li>Vermill Red 1-1/2\' (354303)<ul><li>13 x 15\'</li></ul></li></ul></li><li>Single Mat: Off White (A4902)<ul><li>13 x 15\' (window: 9 x 11)</li></ul></li><li>Glazing (Acrylic Glass): Premium Clear </li></ul>',
'quantity_in_stock': 10,
'track_inventory': true,
'third_party_integrations': {
'etsy_product_id': 0,
'shopify_product_id': 123456789,
'shopify_variant_id': 24681012,
'squarespace_product_id': null,
'squarespace_variant_id': null,
'wix_inventory_id': null,
'wix_product_id': null,
'wix_variant_id': null,
'woocommerce_product_id': 0,
'woocommerce_variant_id': 0
}
}
],
'account_key': null
}, 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({
'virtual_inventory': [
{
'sku': 'AP1556P79511',
'asking_price': 200.0,
'name': 'Framed Giclee - Fine Art Paper Prints',
'description': '<h4>Framed Giclee - Fine Art Paper Prints</h4><ul>8 x 10\' Archival Canvas Paper<ul><li>1/2\' Extra Border Added</li></ul></li><li>Frame: Rustic Britanny<ul><li>Vermill Red 1-1/2\' (354303)<ul><li>13 x 15\'</li></ul></li></ul></li><li>Single Mat: Off White (A4902)<ul><li>13 x 15\' (window: 9 x 11)</li></ul></li><li>Glazing (Acrylic Glass): Premium Clear </li></ul>',
'quantity_in_stock': 10,
'track_inventory': true,
'third_party_integrations': {
'etsy_product_id': 0,
'shopify_product_id': 123456789,
'shopify_variant_id': 24681012,
'squarespace_product_id': null,
'squarespace_variant_id': null,
'wix_inventory_id': null,
'wix_product_id': null,
'wix_variant_id': null,
'woocommerce_product_id': 0,
'woocommerce_variant_id': 0
}
}
],
'account_key': null
}),
};
$.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({
"virtual_inventory": [
{
"sku": "AP1556P79511",
"asking_price": 200.0,
"name": "Framed Giclee - Fine Art Paper Prints",
"description": "<h4>Framed Giclee - Fine Art Paper Prints</h4><ul>8 x 10\" Archival Canvas Paper<ul><li>1/2\" Extra Border Added</li></ul></li><li>Frame: Rustic Britanny<ul><li>Vermill Red 1-1/2\" (354303)<ul><li>13 x 15\"</li></ul></li></ul></li><li>Single Mat: Off White (A4902)<ul><li>13 x 15\" (window: 9 x 11)</li></ul></li><li>Glazing (Acrylic Glass): Premium Clear </li></ul>",
"quantity_in_stock": 10,
"track_inventory": true,
"third_party_integrations": {
"etsy_product_id": 0,
"shopify_product_id": 123456789,
"shopify_variant_id": 24681012,
"squarespace_product_id": null,
"squarespace_variant_id": null,
"wix_inventory_id": null,
"wix_product_id": null,
"wix_variant_id": null,
"woocommerce_product_id": 0,
"woocommerce_variant_id": 0
}
}
],
"account_key": null
});
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 = "{
'virtual_inventory': [
{
'sku': 'AP1556P79511',
'asking_price': 200.0,
'name': 'Framed Giclee - Fine Art Paper Prints',
'description': '<h4>Framed Giclee - Fine Art Paper Prints</h4><ul>8 x 10\' Archival Canvas Paper<ul><li>1/2\' Extra Border Added</li></ul></li><li>Frame: Rustic Britanny<ul><li>Vermill Red 1-1/2\' (354303)<ul><li>13 x 15\'</li></ul></li></ul></li><li>Single Mat: Off White (A4902)<ul><li>13 x 15\' (window: 9 x 11)</li></ul></li><li>Glazing (Acrylic Glass): Premium Clear </li></ul>',
'quantity_in_stock': 10,
'track_inventory': true,
'third_party_integrations': {
'etsy_product_id': 0,
'shopify_product_id': 123456789,
'shopify_variant_id': 24681012,
'squarespace_product_id': null,
'squarespace_variant_id': null,
'wix_inventory_id': null,
'wix_product_id': null,
'wix_variant_id': null,
'woocommerce_product_id': 0,
'woocommerce_variant_id': 0
}
}
],
'account_key': null
}"
response = https.request(request)
puts response.read_body
| Name | Description | Type | Additional information |
|---|---|---|---|
| status |
Response status |
response_status |
None. |
| skus_updated |
A list of the supplied skus that were succesfully updated |
array (text) |
None. |
Example JSON Response
application/json, text/json
{
"status": {
"success": true,
"status_code": 200,
"message": "",
"debug": null,
"reference_id": "ec270d5c6cd5474d99e91888406a8a92"
},
"skus_updated": [
"AP0001P0001",
"AP0001P0002",
"AP0001P0003",
"AP0001P0004"
]
}