Get/Search Product SKUs

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

Use this API to retrieve product SKU details from your organisation. You can fetch SKUs in bulk, search SKUs by SKU code, or retrieve specific SKUs using SKU IDs or codes. The API supports pagination, sorting, and filtering, and can optionally return related data such as product attributes, brand, and category.

You can use this API to:

  • Fetch all product SKUs in the organisation.
  • Search SKUs by SKU code prefix.
  • Retrieve specific SKUs using SKU IDs or SKU codes.
  • Filter SKUs by organisation unit (OU) when OU support is enabled.
  • Retrieve additional related data (attributes, brand, category) for a single SKU.

The response includes SKU details, pricing and return information, optional related entities, attribution metadata, and pagination details.

Example request

curl --location 'https://{Host}/v2/product/skus' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic bmVlcmFqa3Jpc2huYTpkY2VhNmU1ODlhM2U0M2JhODdkMTFkMTM2ODI2NmMxOQ==' \
--header 'Cookie: _cfuvid=adIdLElC8oafEHX277Vu_kA.mTpq2xD18k-1762750332464-0.0.1.1-604800000; _cfuvid=r8CYFCntpo7UzJkjqfesBBFBReI85rG87hY54Q9wOVU-1768196006476-0.0.1.1-604800000'
curl --location 'https://nightly.intouch.capillarytech.com/v2/product/skus' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic bmVlcmFqa3Jpc2huYTpkY2VhNmM2U0M2JhODdkMTFkMTM2ODI2NmMxOQ==' \
--header 'Cookie: _cfuvid=adIdLElC8EHX277Vu_kA.mTpq2xD18k-1762750332464-0.0.1.1-604800000; _cfuvid=r8CYFCntpo7UzJkjqfesBBFBReI85rG87hY54Q9wOVU-1768196006476-0.0.1.1-604800000'
curl --location 'https://nightly.intouch.capillarytech.com/v2/product/skus?include=attributes%20%2C%20brand%2C%20category&entityIds=32510888' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic bmVlcmFqa3Jpc2huYTpkY2VhNmU1ODlhM2U0M2JhODdkMTFkMTM2ODI2NmMxOQ=='

Prerequisites

Resource information

Pagination supportYes
Batch supportYes

Query parameters

FieldTypeRequiredDescription
qstringOptionalSearch product SKUs by their SKU code (also called item code). This returns product SKUs whose codes start with the specified query string. This field is case-insensitive and supports UTF-8 characters. The maximum number of characters supported is 30. This parameter overides entityCodes and entityIds. If provided along with those filters, a warning is returned, and the other filters are ignored.
entityCodesstringOptionalA single or comma-separated list of product SKU codes. Use the value of the code parameter from the response of the Add Product SKU API.Used when q parameter is not provided.
  • Format: Case-insensitive; supports UTF-8 characters.
  • Limits: Maximum 30 codes; 50 characters per code.
  • This parameter is ignored if query parameter q is provided.
Example: code1, 10001
entityIdsstringOptionalA single or comma-separated list of product SKU id. Use the value of the id parameter from the response of the Add Product SKU API.
  • Limits: Maximum 30 ID's.
  • This parameter is ignored if the query parameter q or entityCodes are provided.
Example: 1999, 2000
includestringOptionalComma-separated list of optional related data to include. Supported values: category, brand, attributes.Only applied when retrieving a single entity (specific SKU codeorid).
limitintegerOptionalMaximum number of product categories to retrieve. The default value is 10, and the maximum allowed value is 100.
offsetintegerOptionalNumber of product categories to skip from the beginning of the response.
sortBystringOptionalAllows you to sort the response based on specific fields. Supported values are id and code. Defaults to id.
sortOrderstringOptionalSort direction. Supported values: ASC, DESC. Default: DESC
ouCodestringOptionalFilters product SKUs by the Organization's concept code. This parameter is only applicable when OU support is enabled.
fetchTypestringOptionalScope of product categories to fetch. Supported Values: ALL (master org and OU), ORG (master org only), SCOPE (OU only).

Example response

{
    "data": [
        {
            "id": 27353463,
            "orgId": 50583,
            "ouId": -1,
            "code": "Red1",
            "ean": "Red1",
            "price": 7000.0,
            "description": "adding sample product",
            "longDescription": "Sample description",
            "imageUrl": "https://nightly.capillary.in/productManagement/Colors/img.jpg",
            "attribution": {
                "modifiedDate": "2021-03-16T11:53:22+05:30"
            }
        },
        {
            "id": 27353464,
            "orgId": 50583,
            "ouId": -1,
            "code": "White1",
            "ean": "White1",
            "price": 1000.0,
            "description": "soap",
            "imageUrl": "",
            "attribution": {
                "modifiedDate": "2019-11-29T13:29:09+05:30"
            }
        },
        {
            "id": 27407685,
            "orgId": 50583,
            "ouId": -1,
            "code": "uforall",
            "ean": "uforall",
            "price": 450.0,
            "description": "for all",
            "imageUrl": "",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2020-03-04T12:28:10+05:30"
            }
        },
        {
            "id": 27407686,
            "orgId": 50583,
            "ouId": -1,
            "code": "3872295",
            "ean": "3872295",
            "price": 7000.0,
            "description": "adding sample product",
            "longDescription": "Sample description",
            "imageUrl": "https://nightly.capillary.in/productManagement/Colors/img.jpg",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2021-03-16T11:54:18+05:30"
            }
        },
        {
            "id": 27451903,
            "orgId": 50583,
            "ouId": -1,
            "code": "",
            "ean": "",
            "price": 20000.0,
            "description": "Android Tablet",
            "imageUrl": "",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2020-05-28T17:50:31+05:30"
            }
        },
        {
            "id": 27469435,
            "orgId": 50583,
            "ouId": -1,
            "code": "132453",
            "ean": "132453",
            "price": 500.0,
            "description": "for all",
            "imageUrl": "",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2020-07-07T13:04:57+05:30"
            }
        },
        {
            "id": 27478784,
            "orgId": 50583,
            "ouId": -1,
            "code": "PHONE",
            "ean": "PHONE",
            "price": 20000.0,
            "description": "Basic Android Phone",
            "imageUrl": "",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2020-07-15T11:17:58+05:30"
            }
        },
        {
            "id": 27478785,
            "orgId": 50583,
            "ouId": -1,
            "code": "TAB",
            "ean": "TAB",
            "price": 20000.0,
            "description": "Android Tablet",
            "imageUrl": "",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2020-07-15T11:17:58+05:30"
            }
        },
        {
            "id": 27480360,
            "orgId": 50583,
            "ouId": -1,
            "code": "item-001",
            "ean": "item-001",
            "price": 500.0,
            "description": "soap",
            "imageUrl": "",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2020-07-16T10:47:38+05:30"
            }
        },
        {
            "id": 27501047,
            "orgId": 50583,
            "ouId": -1,
            "code": "sku-18-001",
            "ean": "sku-18-001",
            "price": 500.0,
            "description": "soap",
            "imageUrl": "",
            "returnable": true,
            "returnableDays": -1,
            "attribution": {
                "modifiedDate": "2020-08-11T21:29:13+05:30"
            }
        }
    ],
    "pagination": {
        "limit": 10,
        "offset": 0,
        "total": 423970
    }
}
{
    "data": [
        {
            "id": 32510888,
            "orgId": 50583,
            "ouId": -1,
            "code": "1212jo1212-q",
            "ean": "test-jo-nigh-qt",
            "price": 100.0,
            "description": "test sku",
            "longDescription": "detailed description",
            "imageUrl": "http://newimage.com/abc.png",
            "returnable": true,
            "returnableDays": 2,
            "attributes": [
                {
                    "id": 91454,
                    "code": "producttype",
                    "name": "type",
                    "value": {
                        "id": 13544478,
                        "code": "producttype",
                        "name": "Plastic2"
                    }
                }
            ],
            "attribution": {
                "modifiedDate": "2026-01-12T14:08:46+05:30"
            }
        }
    ],
    "pagination": {
        "limit": 10,
        "offset": 0,
        "total": 1
    }
}
{
    "data": [
        {
            "id": 32510888,
            "orgId": 50583,
            "ouId": -1,
            "code": "1212jo1212-q",
            "ean": "test-jo-nigh-qt",
            "price": 100.0,
            "description": "test sku",
            "longDescription": "detailed description",
            "imageUrl": "http://newimage.com/abc.png",
            "returnable": true,
            "returnableDays": 2,
            "brand": {
                "id": 1242092,
                "code": "Airpods",
                "name": "Airpods"
            },
            "attribution": {
                "modifiedDate": "2026-01-12T14:08:46+05:30"
            }
        }
    ],
    "pagination": {
        "limit": 10,
        "offset": 0,
        "total": 1
    }
}
{
    "data": [
        {
            "id": 32510888,
            "orgId": 50583,
            "ouId": -1,
            "code": "1212jo1212-q",
            "ean": "test-jo-nigh-qt",
            "price": 100.0,
            "description": "test sku",
            "longDescription": "detailed description",
            "imageUrl": "http://newimage.com/abc.png",
            "returnable": true,
            "returnableDays": 2,
            "category": {
                "id": 11329340,
                "code": "Apparel",
                "name": "Apparel"
            },
            "attribution": {
                "modifiedDate": "2026-01-12T14:08:46+05:30"
            }
        }
    ],
    "pagination": {
        "limit": 10,
        "offset": 0,
        "total": 1
    }
}

Response parameters

ParameterTypeDescription
idlongIndicates the unique entity id for the SKU.
orgIdlongSpecifies the organization ID to which the SKU belongs.
ouIdlongIndicates the organizational unit ID (-1 if the SKU belongs to the master organization).
codestringSpecifies the unique code for the Stock Keeping Unit (SKU).
eanstringSpecifies the European Article Number (EAN) of the product.
pricedecimalIndicates the monetary cost of the product.
descriptionstringSpecifies a short summary or title of the product.
longDescriptionstringSpecifies the detailed information about the product.
imageUrlstringSpecifies the source URL of the product image.
returnablebooleanIndicates whether the product is eligible for return.
returnableDaysintegerSpecifies the number of days within which the product can be returned.
attributionobjectAn object containing metadata related to the attribution.
. modifiedDatestringIndicates the date and time when the product was last modified (ISO 8601).
attributesarraySpecifies the list of custom product attributes associated with the SKU.
. idlongIndicates the unique identifier of the attribute definition.
. codestringSpecifies the system code identifying the attribute type (e.g., "color", "size").
. valueobjectSpecifies the object containing the assigned value details.
. . idlongIndicates the unique identifier for the specific attribute value.
. . codestringSpecifies the code representing the attribute value (e.g., "na").
. . namestringSpecifies the human-readable display name of the attribute value (e.g., "Material").

Error & warning codes

CodeTypeDescription
10007ErrorentityCodes cannot have more than 30 comma-separated values.
10008ErrorentityIds cannot have more than 30 comma-separated values.
10004ErrorPagination limit cannot exceed 100.
10005ErrorPagination limit cannot be zero or negative.
10006ErrorPagination offset cannot be negative.
10002ErrorOU level product filtering is disabled for your organization, but an ouCode was provided.
10001ErrorThe provided ouCode is invalid or does not exist.
10009WarningSearching by q parameter; entityCodes and entityIds were ignored.
10010WarningSearching by entityCodes; entityIds was ignored.
10014WarningInvalid sortBy parameter. Defaulting to sort by id.
10018WarningThe include parameter is only supported for single SKU requests and will be ignored.
10019WarningThe following include values are invalid and will be ignored: 0
10011WarningOne or more blank values provided in entityCodes or entityIds were ignored.
10012WarningOne or more non-numeric values provided in entityIds were ignored.
10013WarningAll provided entityIds were invalid and ignored. The query will now fetch all entities.

Query Params
string
integer
Response
200

OK

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!