POST https://test-api.finerworks.com/v3/list_products

List Products

Returns a list of products assigned to a particular order or cart.

Body

Request to be submitted

Name	Description	Type	Additional information
guids	Optional - This can be the guild assigned to the product. Note, it will also return products assigned to these guids if they are in your virtual inventory.	array (globally unique identifier)	None.
order_key	Optional - This can be the order assigned to the product.	globally unique identifier	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

{
  "guids": [
    "b464c114-9e44-449c-8566-f3a7eb012d14",
    "b03edc41-b8a0-417d-af62-d89cf97a6cd8"
  ],
  "order_key": "db36a3bc-5169-44e3-be34-c9c7d835e15b",
  "account_key": "sample string 2"
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/list_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 '{
  "guids": [
    "b464c114-9e44-449c-8566-f3a7eb012d14",
    "b03edc41-b8a0-417d-af62-d89cf97a6cd8"
  ],
  "order_key": "db36a3bc-5169-44e3-be34-c9c7d835e15b",
  "account_key": "sample string 2"
}'

require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-api.finerworks.com/v3/list_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('{
  'guids': [
    'b464c114-9e44-449c-8566-f3a7eb012d14',
    'b03edc41-b8a0-417d-af62-d89cf97a6cd8'
  ],
  'order_key': 'db36a3bc-5169-44e3-be34-c9c7d835e15b',
  'account_key': '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://test-api.finerworks.com/v3/list_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", "{
  'guids': [
    'b464c114-9e44-449c-8566-f3a7eb012d14',
    'b03edc41-b8a0-417d-af62-d89cf97a6cd8'
  ],
  'order_key': 'db36a3bc-5169-44e3-be34-c9c7d835e15b',
  'account_key': 'sample string 2'
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

var settings = {
    "url": "https://test-api.finerworks.com/v3/list_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({
  'guids': [
    'b464c114-9e44-449c-8566-f3a7eb012d14',
    'b03edc41-b8a0-417d-af62-d89cf97a6cd8'
  ],
  'order_key': 'db36a3bc-5169-44e3-be34-c9c7d835e15b',
  'account_key': 'sample string 2'
}),
};

$.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_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({
  'guids': [
    'b464c114-9e44-449c-8566-f3a7eb012d14',
    'b03edc41-b8a0-417d-af62-d89cf97a6cd8'
  ],
  'order_key': 'db36a3bc-5169-44e3-be34-c9c7d835e15b',
  'account_key': 'sample string 2'
});

req.write(postData);
req.end();

require "uri"
require "net/http"

url = URI("https://test-api.finerworks.com/v3/list_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 = "{
  'guids': [
    'b464c114-9e44-449c-8566-f3a7eb012d14',
    'b03edc41-b8a0-417d-af62-d89cf97a6cd8'
  ],
  'order_key': 'db36a3bc-5169-44e3-be34-c9c7d835e15b',
  'account_key': 'sample string 2'
}"

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.
id	Miscellaneous data	number	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": {},
  "id": 2
}