List Products

Retrieve a paginated list of products for a specific store, including their variants and basic information.

---

HTTP Method & Endpoint

GET | /product

---

Request

Headers

Header	Value	Description
Content-Type	application/json	Specifies that the response will be in JSON format
Authorization	Bearer {token}	Authentication token (replace {token} with your actual token)
x-store-id	{storeId}	StoreId (replace {storeId} with your actual storeId)

Query Parameters

Parameter	Type	Required	Description
limit	Number	No	Number of items per page (default: 10, max: 100)
page	Number	No	Page number to fetch (default: 1)
search	String	No	Search term to filter products

---

Response Format

Success Response (200 OK)

Field	Type	Description
message	String	Status message indicating the result of the operation
data	Data	Contains the list of products and pagination details
source	String	Source of the product data (e.g., "unisouk")

Data Object Properties

Field	Type	Description
products	Array(Product)	List of product objects
pagination	Pagination	Pagination metadata

Product Object Properties

Field	Type	Description
id	String	Unique identifier for the product
title	String	Product title
description	String	Product description
hsnCode	String	HSN code for tax classification
storeId	String	Store ID associated with the product
subCategoryName	String	Product sub-category name
categoryName	String	Product category name
originCountry	String	Country of origin (ISO country code)
slug	String	URL-friendly product identifier
variationAttribute	Array	List of product variation attributes
brandName	String	Brand name of the product
productMeasurement	ProductMeasurement	Physical dimensions and weight of the product
manufacturingInfo	ManufacturingInfo	Manufacturing/packaging details
images	Array(Image)	List of product images
variants	Array(Variants)	List of product variants

Product Measurement Properties

Field	Type	Description
dimensions	Dimensions	Physical dimensions of product

Dimensions Properties

Field	Type	Description
weight	Measurement	Product weight
length	Measurement	Product length
width	Measurement	Product width
height	Measurement	Product height

Measurement Unit Properties

Field	Type	Description
value	Number	Measurement value
unit	String	Unit of measurement

Manufacturing Info Properties

Field	Type	Description
manufacturerOrPackerName	String	Name of manufacturer/packer
manufacturerOrPackerAddress	String	Address of manufacturer/packer
monthOfManufactureOrPacking	String	Manufacturing/packing date

Image Properties

Field	Type	Description
position	Number	Display order of image
url	String	URL of the image

Variant Properties

Field	Type	Description
id	String	Unique identifier for the variant
images	Array(Image)	Variant-specific images
sku	String	Stock keeping unit
price	Number	Current selling price
mrp	Number	Maximum retail price
onHand	Number	Quantity available in inventory
allocated	Number	Quantity reserved in orders
attributes	Attributes	Variant-specific attributes

Attribute Properties

Field	Type	Description
Size	Size	Color hex code (for colors)
Color	Color	Color hex code (for colors)

Size Attribute

Field	Type	Description
name	String	Attribute name
brand	String	Brand-specific attribute
value	Object	Attribute value
gender	Male,Female	Gender specification (if any)
displayName	String	User-friendly attribute name

Color Attribute

Field	Type	Description
value	Object/String	Attribute value
displayName	String	User-friendly attribute name
hexCode	String	Color hex code (for colors)

Pagination Object Properties

Field	Type	Description
totalItems	Number	Total number of items available
currentPage	Number	Current page number
totalPages	Number	Total number of pages
pageSize	Number	Number of items per page

---

Examples

cURL

curl -X GET "https://dev-sfapi.unisouk.com/product?limit=100" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "x-store-id: <STORE_ID>"

Javascript (React)

import axios from "axios";

const fetchProducts = async () => {
  try {
    const response = await axios.get("https://dev-sfapi.unisouk.com/product", {
      params: {
        limit: 100,
      },
      headers: {
        "Content-Type": "application/json",
        Authorization: "Bearer <TOKEN>",
        "x-store-id": "<STORE_ID>",
      },
    });

    console.log("Products fetched:", response.data);
  } catch (error) {
    console.error("Error fetching products:", error.response?.data || error.message);
  }
};

Sample Response

{
  "message": "Products Fetched Successfully",
  "data": {
    "products": [
      {
        "id": "30212344240120832",
        "title": "Testing 1",
        "description": "Good Shoes From Abibas",
        "hsnCode": "6404",
        "storeId": "30182834660443136",
        "subCategoryName": "Test",
        "categoryName": "Test",
        "originCountry": "IN",
        "slug": "test",
        "variationAttribute": ["color", "size"],
        "brandName": "tets",
        "productMeasurement": {
          "dimensions": {
            "weight": {
              "value": 150,
              "unit": "grams"
            },
            "length": {
              "value": 50,
              "unit": "centimeters"
            },
            "width": {
              "value": 25,
              "unit": "centimeters"
            },
            "height": {
              "value": 15,
              "unit": "centimeters"
            }
          }
        },
        "manufacturingInfo": {
          "manufacturerOrPackerName": "Aman",
          "manufacturerOrPackerAddress": "surat",
          "monthOfManufactureOrPacking": "02/2025"
        },
        "images": [
          {
            "position": 1,
            "url": "https://test.com"
          }
        ],
        "variants": [
          {
            "id": "30212344307230720",
            "images": [
              {
                "position": 2,
                "url": "s3://unisouk-dev/store/30182834660443136/assets/30198039058809856.jpeg"
              }
            ],
            "sku": "Fas-Shi-ArTMfD1",
            "price": 100,
            "mrp": 1,
            "onHand": 1,
            "allocated": 1,
            "attributes": {
              "size": {
                "name": "size",
                "brand": "default",
                "value": {
                  "value": "free size",
                  "displayName": "Free Size"
                },
                "gender": null,
                "displayName": "Shirt Size | Male"
              },
              "color": {
                "value": "red",
                "hexCode": "#ifefefe",
                "displayName": "red"
              }
            }
          }
        ]
      }
    ],
    "pagination": {
      "totalItems": 1,
      "currentPage": 1,
      "totalPages": 1,
      "pageSize": 10
    }
  },
  "source": "unisouk"
}

---

Error Responses

Status Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Authentication token is missing or invalid
403	Forbidden - Insufficient permissions
500	Internal Server Error - Something went wrong on the server

---

Related Endpoints

• Get Product Details
• Create Product