List Products
Uri: https://test-api.finerworks.com/v3/list_products
Method: POST

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

Body

Request to be submitted

NameDescriptionTypeAdditional 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": [
    "5622eae3-374e-48a7-beec-7fed3fb405c3",
    "7faac946-fe6a-4f3e-944f-a87d285ccb86"
  ],
  "order_key": "22b7bc74-f3ed-4b86-a0d8-6018bbf6205f",
  "account_key": "sample string 2"
}

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 '{
  "guids": [
    "5622eae3-374e-48a7-beec-7fed3fb405c3",
    "7faac946-fe6a-4f3e-944f-a87d285ccb86"
  ],
  "order_key": "22b7bc74-f3ed-4b86-a0d8-6018bbf6205f",
  "account_key": "sample string 2"
}'
                            
                        


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('{
  'guids': [
    '5622eae3-374e-48a7-beec-7fed3fb405c3',
    '7faac946-fe6a-4f3e-944f-a87d285ccb86'
  ],
  'order_key': '22b7bc74-f3ed-4b86-a0d8-6018bbf6205f',
  '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.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", "{
  'guids': [
    '5622eae3-374e-48a7-beec-7fed3fb405c3',
    '7faac946-fe6a-4f3e-944f-a87d285ccb86'
  ],
  'order_key': '22b7bc74-f3ed-4b86-a0d8-6018bbf6205f',
  'account_key': 'sample string 2'
},  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({
  'guids': [
    '5622eae3-374e-48a7-beec-7fed3fb405c3',
    '7faac946-fe6a-4f3e-944f-a87d285ccb86'
  ],
  'order_key': '22b7bc74-f3ed-4b86-a0d8-6018bbf6205f',
  'account_key': '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': 'v2.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({
  "guids": [
    "5622eae3-374e-48a7-beec-7fed3fb405c3",
    "7faac946-fe6a-4f3e-944f-a87d285ccb86"
  ],
  "order_key": "22b7bc74-f3ed-4b86-a0d8-6018bbf6205f",
  "account_key": "sample string 2"
});

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 = "{
  'guids': [
    '5622eae3-374e-48a7-beec-7fed3fb405c3',
    '7faac946-fe6a-4f3e-944f-a87d285ccb86'
  ],
  'order_key': '22b7bc74-f3ed-4b86-a0d8-6018bbf6205f',
  'account_key': 'sample string 2'
}"

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

NameDescriptionTypeAdditional 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
}