Retrieves SKU (Stock Keeping Unit) data from the catalog with flexible filtering and pagination options.
Query Parameters
The API supports multiple query parameters to filter results, such as:
Version (V1)
The version of the API to use, currently v1 is the only accepted version.
catalogId (Integer)
The internal identifier for a catalog associated with company / customer account.
conditionName (string)
Name of the condition in PCC to fetch SKUs.
Note
When you use this parameter, this parameter takes precedence over all the input parameters such as toDateTime, fromDateTime, customerSkuIds, etc.
toDateTime (string)
Instructs the API to fetch SKUs which have been modified at or before the timestamp specified in this parameter in UTC timezone.
Note
If this parameter is used with conditionName parameter then the conditionName takes precedence.
If you use this parameter with any other parameters, the SKUs will be fetched based on all the parameters you provide together.
fromDateTime (string)
Instructs the API to fetch SKUs which have been modified at or after the timestamp specified in this parameter in UTC timezone. The value is a string in the format YYYY-MM-DD HH24: MI.
Note
If this parameter is used with conditionName parameter then the conditionName takes precedence.
If you use this parameter with any other parameters, the SKUs will be fetched based on all the parameters you provide together.
customerSkuIds (string)
Enter the external ID of SKU based on which the SKUs will be fetched. This input parameter must be able to accept a comma separate list of SKU Item Ids.
Note
If this parameter is used with conditionName parameter then the conditionName takes precedence.
If you use this parameter with any other parameters, the SKUs will be fetched based on all the parameters you provide together.
modifiedAttributeName (string)
The modifiedAttributeName parameter allows you to specify unique attribute name to filter SKUs according to the last time that attribute was updated. It's important to note that this parameter must be used with either the fromDateTime or toDateTime parameters to define the time range for the attribute modifications.
Note
If this parameter is used with conditionName parameter then the conditionName takes precedence.
If you use this parameter with any other parameters, the SKUs will be fetched based on all the parameters you provide together.
responseAttributeNameList (string)
The responseAttributeNameList parameter controls which attributes are included in the JSON response. It should be used alongside at least one other condition parameter, such as a date range or customerSkuIds. This parameter allows you to specify a list of attribute names, separated by a tilde (~), to limit the response to those attributes. It's important to note that attribute names must match exactly as defined in the PIM system, including case sensitivity.
Count (boolean)
If you set the count to true, only then you can see the total number of records fetched in the response. By default, it is set to false.
limit (integer)
This is an optional parameter that specifies the maximum number of items that should be returned in a single API response. For example, if you set the limit to 10, the API will return a maximum of 10 items in the response.
Offset (integer)
This is an optional parameter that specifies the starting point from which the API should fetch the item. For example, if you set the offset to 20 and the limit to 10, the API will skip the first 20 items and return the next 10 items starting from the 21st item.
ignoredAttributeNameList (string)
The ignoredAttributeNameList instructs the API to ignore SKUs where the latest modification date and time for the overall SKU is only because of the changes to attributes that belong to this list. If any other attribute (not in the list) was changed, the SKU will still be included in the response.
This parameter must be used with either the fromDateTime or toDateTime parameter to define the time range for the attribute modifications. The list of attributes are separated by the tilde (~) character.
Example: ignoredAttributeNameList=4G~3G
Note
If this parameter is used with conditionName parameter then the conditionName takes precedence.
Successful response
Response Parameters
The response body will return a JSON Array of JSON Objects describing SKUs.
amazeKeySkuIdentifier (integer)
Internal identifier of SKU in PCC.
customerCode (Integer)
Name of the customer associated with catalog.
catalogName (string)
Name of the catalog.
customerSkuId (string)
External ID of SKU.
skuTitle (string)
Title associated with SKU.
formulaNameIfDerivedTitle (string)
Name of the formula used to generate SKU title.
Type (string)
Type of SKU. possible values are SKU/Product Family.
residentTaxonomy.taxonomyPath (string)
Path of the taxonomy where SKU resides.
residentTaxonomy.taxonomyName (string)
Name of the taxonomy where SKU resides.
residentTaxonomy.taxonomyCustomerId (string)
Name of the taxonomy where SKU resides.
residentTaxonomy.domainName (string)
The name of the main domain to which taxonomy is linked.
crosslistedToTaxonomies.taxonomyPath (string)
Specifies the full path of the taxonomy where the SKU is cross-listed.
crosslistedToTaxonomies.taxonomyName (string)
Specifies the name of the taxonomy where the SKU is cross-listed.
crosslistedToTaxonomies.taxonomyCustomerId (string)
Customer ID of the taxonomy where SKU is cross-referenced.
mirroredToTaxonomies.taxonomyPath (string)
Path of the taxonomy where SKU mirrored.
mirroredToTaxonomies.taxonomyName (string)
Name of the taxonomy where SKU mirrored.
mirroredToTaxonomies.taxonomyCustomerId (string)
Customer ID of the taxonomy where SKU is mirrored.
mirroredToTaxonomies.domainName (string)
Name of the domain in which taxonomy is mirrored.
skuAttributes.attributeName (string)
Name of the attribute used in SKU.
skuAttributes.customerAttributeId (string)
Customer ID of an attribute used in SKU.
skuAttributes.attributeType (string/media)
Type of the attribute used in SKU.
Note
The MEDIA data type is used when a product attribute refers to a digital asset (e.g., an image, video, or document).
skuAttributes.isLocked (boolean)
Identification to determine an attribute under SKU is locked for modification.
If true, the attribute value cannot be changed.
skuAttributes.attributeMetaTags.name (string)
Name of the tag associated used to describe or categorize the attribute.
skuAttributes.attributeMetaTags.description (string)
A short description of the meta tag associated with an attribute.
skuAttributes.attributeMetaAttributes.name (string)
The name of an additional detail linked to the attribute for extra information.
skuAttributes.attributeMetaAttributes.description (string)
A brief explanation of what this additional attribute detail means.
skuAttributes.attributeMetaAttributes.value (string)
The actual value assigned to the additional attribute detail.
skuAttributes.skuAttributeValues.value (string)
Value of the attribute associated with SKU.
skuAttributes.skuAttributeValues.uomName (string)
The unit of measurement used for the attribute value (for example, Inches, Pounds).
skuAttributes.skuAttributeValues.uomSymbol (string)
The short symbol for the unit of measurement (for example, in, lb).
skuAttributes.skuAttributeValues.formulaNameIfDerivedValue (string)
The name of the formula used to calculate the value when the attribute is derived instead of manually entered.
digitalAssets.digitalAssetName (string)
Name of the digital asset associated with SKU.
digitalAssets.digitalAssetType (string)
Type of digital asset associated with SKU.
digitalAssets.digitalAssetPublicURL (string)
A public link that allows users to view or download the digital asset.
digitalAssets.digitalAssetThumbnailPublicURL (string)
A public link to a smaller preview (thumbnail) version of the digital asset.
digitalAssets.isPrimary (boolean)
Indicates whether this asset is the main or primary asset for the SKU.
- true = primary asset,
- false= additional asset.
validationFailures.constraintName (string)
Name of the rule or constraint for which validation failed.
validationFailures.attributeName (string)
Name of the attribute for which validation failed.
validationFailures.customerAttributeId (string)
Customer -specific identifier of the attribute that failed validation.
validationFailures.attributeType (string)
Type of attribute for which validation failed.
validationFailures.failureMessage (string)
A readable explanation describing why the validation failed.
reviewOpenIncidents.changeType (string)
The type of change requested that triggered a review.
reviewOpenIncidents.changeByUserName (string)
Name of the user who has submitted the review incident request.
reviewOpenIncidents.incidentCount (integer)
The number of review requests raised by the user for the same type of change.
Pagination Parameters
totalRecords (integer)
If the request parameter has the count parameter set to true only, then this parameter will get displayed with the total number of records fetched.
limit (integer)
This is an optional parameter that specifies the maximum number of items that should be returned in a single API response.
For example, if you set the limit to 10, the API will return a maximum of 10 records in the response.
offset (integer)
This is an optional parameter that specifies the starting point from which the API should fetch the record.
For example, if you set the offset = 20 and the limit = 10, the API will skip the first 20 records and return the next 10 records.