arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/list_virtual_inventory

List Virtual Inventory

Provides a list of a user's virtual inventory (products) stored in their account with valid product codes.

Body

Name Description Type Additional information
search_filter Optional - Search query filter that searches based on text in the title or description. text None.
third_party_connections_filter Optional - Similar to regular search filter, does a string search for connection data text None.
sku_filter Optional - Search query filter that searches based on a list of product skus. The max it will search is 50, otherwise the filter will be ignored. array (text) None.
product_code_filter Optional - Search query filter that searches based on a list of product codes. The max it will search is 50, otherwise the filter will be ignored. array (text) None.
product_type_ids_filter Optional - Search query filter that searches based on a list of product type ids. array (number) None.
guid_filter Optional - If you have a list of image guids you can filter by a list of image unique identifiers. array (globally unique identifier) None.
page_number Optional - Page number. number None.
per_page Optional - Default is 10 however you can display up to 50 at a time. number None.
sort_field Optional - Default is by id. Alternatively these fields can also be used: title, file_name, file_size, updated, or date_added. text None.
sort_direction Optional - Default is "DESC" for descending order however if you want it to be ascending order, use "ASC". text None.
created_date_from Optional - Default is null however you can filter by earliest date added. date None.
created_date_to Optional - Default is null however you can filter by latest date added. date None.
account_key Optional - This retrieves 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

{
  "search_filter": "",
  "third_party_connections_filter": null,
  "sku_filter": null,
  "product_code_filter": null,
  "product_type_ids_filter": null,
  "guid_filter": null,
  "page_number": 1,
  "per_page": 10,
  "sort_field": "id",
  "sort_direction": "DESC",
  "created_date_from": null,
  "created_date_to": null,
  "account_key": null
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/list_virtual_inventory' \
--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": "",
  "third_party_connections_filter": null,
  "sku_filter": null,
  "product_code_filter": null,
  "product_type_ids_filter": null,
  "guid_filter": null,
  "page_number": 1,
  "per_page": 10,
  "sort_field": "id",
  "sort_direction": "DESC",
  "created_date_from": null,
  "created_date_to": null,
  "account_key": null
}'