List Orders
Uri: https://test-api.finerworks.com/v3/list_orders
Method: POST

Retrieves a list of orders.

Body

Order list request to be submitted via JSON

NameDescriptionTypeAdditional information
search_filter

Optional - Search query filter that searches based on text in the title or description.

 text

None.
status

Filter by order status.

 text

None.
order_ids

Filter by order id numbers

 array (number)

None.
date_from

Date after the order was placed

 date

None.
date_to

Date before the order was placed.

 date

None.
account_key

Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and any get 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.
per_page

Default is 10 however you can display up to 25 at a time.

 number

None.
page_number

Page number

 number

None.
show_cancelled

Include cancelled orders. The default is true

 boolean

None.

Example JSON Body

application/json, text/json

{
  "search_filter": "sample string 1",
  "status": "sample string 2",
  "order_ids": [
    1,
    2
  ],
  "date_from": "2026-02-28T18:11:11.8211438-06:00",
  "date_to": "2026-02-28T18:11:11.8211438-06:00",
  "account_key": "sample string 3",
  "per_page": 4,
  "page_number": 5,
  "show_cancelled": true
}

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 '{
  "search_filter": "sample string 1",
  "status": "sample string 2",
  "order_ids": [
    1,
    2
  ],
  "date_from": "2026-02-28T18:11:11.8211438-06:00",
  "date_to": "2026-02-28T18:11:11.8211438-06:00",
  "account_key": "sample string 3",
  "per_page": 4,
  "page_number": 5,
  "show_cancelled": true
}'
                            
                        


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('{
  'search_filter': 'sample string 1',
  'status': 'sample string 2',
  'order_ids': [
    1,
    2
  ],
  'date_from': '2026-02-28T18:11:11.8211438-06:00',
  'date_to': '2026-02-28T18:11:11.8211438-06:00',
  'account_key': 'sample string 3',
  'per_page': 4,
  'page_number': 5,
  'show_cancelled': true
}');
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", "{
  'search_filter': 'sample string 1',
  'status': 'sample string 2',
  'order_ids': [
    1,
    2
  ],
  'date_from': '2026-02-28T18:11:11.8211438-06:00',
  'date_to': '2026-02-28T18:11:11.8211438-06:00',
  'account_key': 'sample string 3',
  'per_page': 4,
  'page_number': 5,
  'show_cancelled': true
},  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({
  'search_filter': 'sample string 1',
  'status': 'sample string 2',
  'order_ids': [
    1,
    2
  ],
  'date_from': '2026-02-28T18:11:11.8211438-06:00',
  'date_to': '2026-02-28T18:11:11.8211438-06:00',
  'account_key': 'sample string 3',
  'per_page': 4,
  'page_number': 5,
  'show_cancelled': true
}),
};

$.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({
  "search_filter": "sample string 1",
  "status": "sample string 2",
  "order_ids": [
    1,
    2
  ],
  "date_from": "2026-02-28T18:11:11.8211438-06:00",
  "date_to": "2026-02-28T18:11:11.8211438-06:00",
  "account_key": "sample string 3",
  "per_page": 4,
  "page_number": 5,
  "show_cancelled": true
});

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 = "{
  'search_filter': 'sample string 1',
  'status': 'sample string 2',
  'order_ids': [
    1,
    2
  ],
  'date_from': '2026-02-28T18:11:11.8211438-06:00',
  'date_to': '2026-02-28T18:11:11.8211438-06:00',
  'account_key': 'sample string 3',
  'per_page': 4,
  'page_number': 5,
  'show_cancelled': true
}"

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

NameDescriptionTypeAdditional information
status

response_status

None.
orders

array (order_summary)

None.
total_count

number

None.
total_amount

decimal

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"
  },
  "orders": [
    {
      "order_id": 1,
      "recipient": "sample string 2",
      "order_date": "2026-02-28T18:11:11.8251267-06:00",
      "order_guid": "64c11e43-280d-4483-975b-b79e1458117e",
      "order_email": "sample string 5",
      "order_po": "sample string 6",
      "status": "sample string 7",
      "transaction_id": "sample string 8",
      "total": 9.0,
      "tracking": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "order_id": 1,
      "recipient": "sample string 2",
      "order_date": "2026-02-28T18:11:11.8251267-06:00",
      "order_guid": "64c11e43-280d-4483-975b-b79e1458117e",
      "order_email": "sample string 5",
      "order_po": "sample string 6",
      "status": "sample string 7",
      "transaction_id": "sample string 8",
      "total": 9.0,
      "tracking": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "total_count": 1,
  "total_amount": 2.0
}