API Reference

List Product Documents

get
https://api.skulytics.io/v3/e-commerce/product/documents

The List Product Documents endpoint allows you to access all documents associated with a specific product, such as installation instructions, energy guides, quick specs, and warranty details. The response from this API provides the necessary data to manage and display product documents effectively on an e-commerce platform or application, including metadata such as file size, document type, and URL links.

These product documents can be used to provide important information needed by customers or developers to better understand the product. This is especially useful for e-commerce platforms, product display systems, or any application requiring product documentation.

Use Case
This API is useful for accessing and organizing documents related to a specific product. Types of documents may include:

  • Installation Instructions
  • Energy Guide
  • Quick Specs
  • Warranty Information

These documents can be displayed on websites, e-commerce platforms, or used in any system that requires product-related documentation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by SKU.

integer

Filter by the product’s unique ID.

string

Match behavior for sku searches. Allowed values: exact or fuzzy. (Default: exact if not provided.)

string

Filter brands by their primary industry. Valid values: Appliances, Furniture, or Mattresses.

integer

Filter by brand ID.

string

Filter by brand name or brand slug.

integer

Filter brands using a unique Category ID.

string

Filter brands within one category.

integer

Filter brands using a unique Subcategory ID.

subcategory
array of strings

Filter brands within one subcategory.

subcategory
string

Filter brands using a unique Detail Category ID.

string

Filter brands within one detail category category.

integer

Exclude by brand ID.

string

Exclude by brand name or brand slug.

integer

Exclude brands associated with a specific Category ID.

string

Exclude brands associated with a specific category name from the results.

integer

Exclude brands associated with a specific Subcategory ID.

string

Exclude brands associated with a specific subcategory name.

integer

Exclude brands associated with a specific Detail Category ID.

string

Exclude brands associated with a specific detail category name.

string

Specify the page number for paginated results.

integer

Specify the number of brand items to return per page.

Response

Updated about 4 hours ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 hours ago