Get Product Variants
https://api.flxpoint.com/product/variantsUse this when you want to pull product data through the API.
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
This endpoint will fetch back a list of Product Variants. You cannot use both `findBySKUs` and `findByIds` in a single request
Request
pagequeryintegerpage number
default 1pageSizequeryintegernumber of elements per page
default 50max 1000updatedAfterquerystring (date-time)Only retrieves back inventory records that hae been updated after the date specified
skusqueryarray[string]Finds elements matching these SKUs. Max must be less than or equal to pageSize.
max 100 itemsupcsqueryarray[string]Finds elements matching these UPCs. Max must be less than or equal to pageSize.
max 100 itemsidsqueryarray[integer]Finds elements matching these IDs. Max must be less than or equal to pageSize.
max 100 itemsincludeOverwritesquerybooleanIf `true` will include a list of Price/Quantity overwrites
includeCustomAggregatesquerybooleanIf "false" is passed, the "customAggregates"(Fields) node will not be populated. Custom Aggregates are similar to custom fields, but they can be aggregated across multiple sources.
default falseincludeCustomFieldsquerybooleanIf "true" is passed, the "customFields" nodes will be populated.
default falseincludeImagesquerybooleanIf "false" is passed, the "image" and "parent.image" nodes will not be populated
default falseincludeOptionsquerybooleanIf "false" is passed, the "options" and "parent.options" nodes will not be populated
default falseincludeInventoryLinksquerybooleanIf `true`, `inventoryLinks` will be populated with a list of `Inventory Variant IDs` that this product is associated to.
default falseincludeListingLinksquerybooleanIf `true`, `listingLinks` will be populated with a list of `Listing Variant IDs` that this product is associated to.
default falseincludeParentquerybooleanIf "true" is passed, the "parent" node will be populated with Parent information. NOTE : The "variants" will be empty in this node to prevent circular references.
default falseincludeAttributesquerybooleanIf "true" is passed, the "parent.attributes" node will be populated.
default falseincludeCategoriesquerybooleanIf "true" is passed, the parent category nodes will be populated.
default falseincludeBundleComponentsquerybooleanUse this to include `ProductBundleComponents` associated with the product variant. </br> By default they are not included.
default falseincludeTagsquerybooleanDetermines if "tags" are returned in the response
default false
Example request
/product/variantscurl -X GET "https://api.flxpoint.com/product/variants" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OKapplication/json
priceOverwriteobjectpriceOverwrittenbooleancostOverwrittenbooleanmsrpOverwrittenbooleanmapOverwrittenbooleanshippingCostOverwrittenbooleandropshipFeeOverwrittenbooleandynamicPricenumberdynamicCostnumberdynamicMsrpnumberdynamicMapnumberdynamicShippingCostnumberdynamicDropshipFeenumberquantityOverwriteobjectquantityOverwrittenbooleandynamicQuantityintegerorderVolumeProtectionLockedAtstringlastManualQuantityintegerisLockedByOrderVolumeProtectionboolean"false"productParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredsourceIdintegerskustringarchivedbooleanquantityintegercostnumbermsrpnumbermapnumbershippingCostnumberdropshipFeenumberinventoryListPricenumberproductAlternativesarray[AlternateVariant]idintegerskustringtitlestringquantityintegercostnumberpricenumberimagestringparentIdintegerreferenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerpendingFulfillmentQuantityintegerweightUnitobjecthandlestringpoundouncegramkilogramabbreviatedHandlestringlbozgkgdimensionUnitobjecthandlestringinchcentimeterabbreviatedHandlestringincmdimensionalWeightnumberimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegersizeinteger (int64)compressedbooleanwidthintegerheightintegersharedImagebooleanoptionsarray[ProductVariantOption]productParentOptionIdintegerglobalOptionValueIdinteger (int64)productVariantIdintegeridintegerpositionintegernamestringrequiredvaluestringrequiredglobalPositionintegerbundlebooleanbundleComponentsarray[ProductBundleComponent]componentQuantityintegerrequiredcomponentProductVariantobjectpriceOverwriteobjectpriceOverwrittenbooleancostOverwrittenbooleanmsrpOverwrittenbooleanmapOverwrittenbooleanshippingCostOverwrittenbooleandropshipFeeOverwrittenbooleandynamicPricenumberdynamicCostnumberdynamicMsrpnumberdynamicMapnumberdynamicShippingCostnumberdynamicDropshipFeenumberquantityOverwriteobjectquantityOverwrittenbooleandynamicQuantityintegerorderVolumeProtectionLockedAtstringlastManualQuantityintegerisLockedByOrderVolumeProtectionboolean"false"productParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredsourceIdintegerskustringarchivedbooleanquantityintegercostnumbermsrpnumbermapnumbershippingCostnumberdropshipFeenumberinventoryListPricenumberproductAlternativesarray[AlternateVariant]idintegerskustringtitlestringquantityintegercostnumberpricenumberimagestringparentIdintegerreferenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerpendingFulfillmentQuantityintegerweightUnitobjecthandlestringpoundouncegramkilogramabbreviatedHandlestringlbozgkgdimensionUnitobjecthandlestringinchcentimeterabbreviatedHandlestringincmdimensionalWeightnumberimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegersizeinteger (int64)compressedbooleanwidthintegerheightintegersharedImagebooleanoptionsarray[ProductVariantOption]productParentOptionIdintegerglobalOptionValueIdinteger (int64)productVariantIdintegeridintegerpositionintegernamestringrequiredvaluestringrequiredglobalPositionintegerbundlebooleanbundleComponentsarray[ProductBundleComponent]componentQuantityintegerrequiredcomponentProductVariantProductVariantbundleProductVariantIdintegercomponentProductVariantIdintegerrequiredlistingLinksarray[ProductVariantListingLink]listingVariantIdintegerrequiredchannelIdintegerrequiredcustomAggregateFieldsarray[ProductVariantCustomAggregateField]idinteger (int64)productVariantIdintegeraccountIdintegercustomAggregateFieldCustomAggregateFieldnamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringparentobjectidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryTwoobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryThreeobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategoryimagesarray[ProductImage]optionsarray[ProductParentOption]attributesarray[ProductParentAttribute]customFieldsarray[ProductParentCustomField]variantsarray[ProductVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)tagsarray[string]listingLinksarray[ProductParentListingLink]imageFetcherEventTriggeredbooleandescriptionstringtagsarray[string]requiresFflbooleanimageFetcherEventTriggeredbooleanlinkedSourceCountintegerbundleProductVariantIdintegercomponentProductVariantIdintegerrequiredlistingLinksarray[ProductVariantListingLink]listingVariantIdintegerrequiredchannelIdintegerrequiredcustomAggregateFieldsarray[ProductVariantCustomAggregateField]idinteger (int64)productVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleanfalseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringparentobjectidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryTwoobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryThreeobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegerimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegersizeinteger (int64)compressedbooleanwidthintegerheightintegersharedImagebooleanoptionsarray[ProductParentOption]productParentIdintegeridintegernamestringrequiredglobalOptionIdinteger (int64)optionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ProductParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ProductParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ProductVariant]priceOverwriteobjectpriceOverwrittenbooleancostOverwrittenbooleanmsrpOverwrittenbooleanmapOverwrittenbooleanshippingCostOverwrittenbooleandropshipFeeOverwrittenbooleandynamicPricenumberdynamicCostnumberdynamicMsrpnumberdynamicMapnumberdynamicShippingCostnumberdynamicDropshipFeenumberquantityOverwriteobjectquantityOverwrittenbooleandynamicQuantityintegerorderVolumeProtectionLockedAtstringlastManualQuantityintegerisLockedByOrderVolumeProtectionboolean"false"productParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredsourceIdintegerskustringarchivedbooleanquantityintegercostnumbermsrpnumbermapnumbershippingCostnumberdropshipFeenumberinventoryListPricenumberproductAlternativesarray[AlternateVariant]idintegerskustringtitlestringquantityintegercostnumberpricenumberimagestringparentIdintegerreferenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerpendingFulfillmentQuantityintegerweightUnitobjecthandlestringpoundouncegramkilogramabbreviatedHandlestringlbozgkgdimensionUnitobjecthandlestringinchcentimeterabbreviatedHandlestringincmdimensionalWeightnumberimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegersizeinteger (int64)compressedbooleanwidthintegerheightintegersharedImagebooleanoptionsarray[ProductVariantOption]productParentOptionIdintegerglobalOptionValueIdinteger (int64)productVariantIdintegeridintegerpositionintegernamestringrequiredvaluestringrequiredglobalPositionintegerbundlebooleanbundleComponentsarray[ProductBundleComponent]componentQuantityintegerrequiredcomponentProductVariantProductVariantbundleProductVariantIdintegercomponentProductVariantIdintegerrequiredlistingLinksarray[ProductVariantListingLink]listingVariantIdintegerrequiredchannelIdintegerrequiredcustomAggregateFieldsarray[ProductVariantCustomAggregateField]idinteger (int64)productVariantIdintegeraccountIdintegercustomAggregateFieldCustomAggregateFieldnamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringparentobjectidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryTwoobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryThreeobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategoryimagesarray[ProductImage]optionsarray[ProductParentOption]attributesarray[ProductParentAttribute]customFieldsarray[ProductParentCustomField]variantsarray[ProductVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)tagsarray[string]listingLinksarray[ProductParentListingLink]imageFetcherEventTriggeredbooleandescriptionstringtagsarray[string]requiresFflbooleanimageFetcherEventTriggeredbooleanlinkedSourceCountintegercategoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)tagsarray[string]listingLinksarray[ProductParentListingLink]listingParentIdintegerrequiredchannelIdintegerrequiredimageFetcherEventTriggeredbooleandescriptionstringtagsarray[string]requiresFflbooleanimageFetcherEventTriggeredbooleanlinkedSourceCountinteger[
{
"priceOverwrite": {
"priceOverwritten": true,
"costOverwritten": true,
"msrpOverwritten": true,
"mapOverwritten": true,
"shippingCostOverwritten": true,
"dropshipFeeOverwritten": true,
"dynamicPrice": 0,
"dynamicCost": 0,
"dynamicMsrp": 0,
"dynamicMap": 0,
"dynamicShippingCost": 0,
"dynamicDropshipFee": 0
},
"quantityOverwrite": {
"quantityOverwritten": true,
"dynamicQuantity": 0,
"orderVolumeProtectionLockedAt": "string",
"lastManualQuantity": 0,
"isLockedByOrderVolumeProtection": true
},
"productParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"productBuilderId": 0,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"inventoryLinks": [
{
"id": 0,
"productVariantId": 0,
"inventoryVariantId": 0,
"sourceId": 0,
"sku": "string",
"archived": true,
"quantity": 0,
"cost": 0,
"msrp": 0,
"map": 0,
"shippingCost": 0,
"dropshipFee": 0,
"inventoryListPrice": 0
}
],
"productAlternatives": [
{
"id": 0,
"sku": "string",
"title": "string",
"quantity": 0,
"cost": 0,
"price": 0,
"image": "string",
"parentId": 0
}
],
"referenceIdentifier": "string",
"id": 0,
"sku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"pendingFulfillmentQuantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"dimensionalWeight": 0,
"images": [
{
"productParentId": 0,
"productVariantId": 0,
"md5Checksum": "string",
"originalUrl": "string",
"fetched": true,
"fetchAttempts": 0,
"archived": true,
"id": 0,
"url": "string",
"sortOrder": 0,
"size": 0,
"compressed": true,
"width": 0,
"height": 0,
"sharedImage": true
}
],
"options": [
{
"productParentOptionId": 0,
"globalOptionValueId": 0,
"productVariantId": 0,
"id": 0,
"position": 0,
"name": "string",
"value": "string",
"globalPosition": 0
}
],
"bundle": true,
"bundleComponents": [
{
"componentQuantity": 0,
"componentProductVariant": {
"priceOverwrite": null,
"quantityOverwrite": null,
"productParentId": null,
"price": null,
"salePrice": null,
"estimatedShippingCost": null,
"estimatedDropshipFee": null,
"inventoryListPrice": null,
"imagesFetched": null,
"productBuilderId": null,
"builtWithMappingTemplateId": null,
"builtAt": null,
"rebuiltAt": null,
"inventoryLinks": null,
"productAlternatives": null,
"referenceIdentifier": null,
"id": null,
"sku": null,
"title": null,
"mpn": null,
"upc": null,
"ean": null,
"asin": null,
"msrp": null,
"map": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"insertedAt": null,
"updatedAt": null,
"archived": null,
"cost": null,
"quantity": null,
"pendingFulfillmentQuantity": null,
"weightUnit": null,
"dimensionUnit": null,
"dimensionalWeight": null,
"images": null,
"options": null,
"bundle": null,
"bundleComponents": null,
"listingLinks": null,
"customAggregateFields": null,
"scheduledToDeleteAt": null,
"customFields": null,
"parent": null,
"description": null,
"tags": null,
"requiresFfl": null,
"imageFetcherEventTriggered": null,
"linkedSourceCount": null
},
"bundleProductVariantId": 0,
"componentProductVariantId": 0
}
],
"listingLinks": [
{
"listingVariantId": 0,
"channelId": 0
}
],
"customAggregateFields": [
{
"id": 0,
"productVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": null,
"aggregateFieldDataTypeId": null,
"customAggregateFieldOptionId": null,
"name": null,
"handle": null,
"ignoreOutOfStock": null,
"accountId": null
},
"name": "string",
"value": 0,
"customAggregateFieldId": 0
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"customFields": [
{
"id": 0,
"customFieldValueId": 0,
"customFieldId": 0,
"name": "string",
"value": "string",
"originalInventoryName": "string",
"originalInventoryValue": "string",
"mergeToCustomFieldId": 0,
"mergeToCustomFieldName": "string",
"mergeToCustomFieldValueId": 0,
"mergeToCustomFieldValue": "string"
}
],
"parent": {
"id": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": null,
"productCategoryId": null,
"id": null,
"name": null,
"excluded": null,
"parentCategoryId": null
}
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": null,
"productCategoryId": null,
"id": null,
"name": null,
"excluded": null,
"parentCategoryId": null
}
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": null,
"productCategoryId": null,
"id": null,
"name": null,
"excluded": null,
"parentCategoryId": null
}
},
"images": [
{
"productParentId": null,
"productVariantId": null,
"md5Checksum": null,
"originalUrl": null,
"fetched": null,
"fetchAttempts": null,
"archived": null,
"id": null,
"url": null,
"sortOrder": null,
"size": null,
"compressed": null,
"width": null,
"height": null,
"sharedImage": null
}
],
"options": [
{
"productParentId": null,
"id": null,
"name": null,
"globalOptionId": null,
"optionValues": null
}
],
"attributes": [
{
"id": null,
"attributeId": null,
"attributeValueId": null,
"name": null,
"originalInventoryName": null,
"value": null,
"originalInventoryValue": null,
"isPrivate": null,
"mergeToAttributeId": null,
"mergeToAttributeName": null,
"mergeToAttributeValueId": null,
"mergeToAttributeValue": null,
"mergeToAttributeIsPrivate": null
}
],
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"variants": [
{
"priceOverwrite": null,
"quantityOverwrite": null,
"productParentId": null,
"price": null,
"salePrice": null,
"estimatedShippingCost": null,
"estimatedDropshipFee": null,
"inventoryListPrice": null,
"imagesFetched": null,
"productBuilderId": null,
"builtWithMappingTemplateId": null,
"builtAt": null,
"rebuiltAt": null,
"inventoryLinks": null,
"productAlternatives": null,
"referenceIdentifier": null,
"id": null,
"sku": null,
"title": null,
"mpn": null,
"upc": null,
"ean": null,
"asin": null,
"msrp": null,
"map": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"insertedAt": null,
"updatedAt": null,
"archived": null,
"cost": null,
"quantity": null,
"pendingFulfillmentQuantity": null,
"weightUnit": null,
"dimensionUnit": null,
"dimensionalWeight": null,
"images": null,
"options": null,
"bundle": null,
"bundleComponents": null,
"listingLinks": null,
"customAggregateFields": null,
"scheduledToDeleteAt": null,
"customFields": null,
"parent": null,
"description": null,
"tags": null,
"requiresFfl": null,
"imageFetcherEventTriggered": null,
"linkedSourceCount": null
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"productBuilderId": 0,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"tags": [
"string"
],
"listingLinks": [
{
"listingParentId": null,
"channelId": null
}
],
"imageFetcherEventTriggered": true
},
"description": "string",
"tags": [
"string"
],
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"linkedSourceCount": 0
}
]400Bad Request
No schema documented for this status.
401Unauthorized
No schema documented for this status.
OpenAPI fragment
{
"get": {
"summary": "Get Product Variants",
"description": "This endpoint will fetch back a list of Product Variants. You cannot use both `findBySKUs` and `findByIds` in a single request",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"description": "page number"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"maximum": 1000
},
"description": "number of elements per page"
},
{
"schema": {
"type": "string",
"format": "date-time"
},
"in": "query",
"name": "updatedAfter",
"description": "Only retrieves back inventory records that hae been updated after the date specified"
},
{
"schema": {
"type": "array",
"maxItems": 100,
"example": "SKU123,SKU456,SKU789",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"in": "query",
"name": "skus",
"description": "Finds elements matching these SKUs. Max must be less than or equal to pageSize.",
"style": "form",
"explode": false
},
{
"schema": {
"type": "array",
"maxItems": 100,
"example": "012345678905,012345678912",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"in": "query",
"name": "upcs",
"description": "Finds elements matching these UPCs. Max must be less than or equal to pageSize.",
"style": "form",
"explode": false
},
{
"schema": {
"type": "array",
"maxItems": 100,
"example": "123,456,789",
"uniqueItems": true,
"items": {
"type": "integer"
}
},
"in": "query",
"name": "ids",
"description": "Finds elements matching these IDs. Max must be less than or equal to pageSize.",
"style": "form",
"explode": false
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "includeOverwrites",
"description": "If `true` will include a list of Price/Quantity overwrites"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeCustomAggregates",
"description": "If \"false\" is passed, the \"customAggregates\"(Fields) node will not be populated. Custom Aggregates are similar to custom fields, but they can be aggregated across multiple sources. "
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeCustomFields",
"description": "If \"true\" is passed, the \"customFields\" nodes will be populated. "
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeImages",
"description": "If \"false\" is passed, the \"image\" and \"parent.image\" nodes will not be populated"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeOptions",
"description": "If \"false\" is passed, the \"options\" and \"parent.options\" nodes will not be populated"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeInventoryLinks",
"description": "If `true`, `inventoryLinks` will be populated with a list of `Inventory Variant IDs` that this product is associated to."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeListingLinks",
"description": "If `true`, `listingLinks` will be populated with a list of `Listing Variant IDs` that this product is associated to."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeParent",
"description": "If \"true\" is passed, the \"parent\" node will be populated with Parent information. NOTE : The \"variants\" will be empty in this node to prevent circular references."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeAttributes",
"description": "If \"true\" is passed, the \"parent.attributes\" node will be populated. "
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeCategories",
"description": "If \"true\" is passed, the parent category nodes will be populated."
},
{
"name": "includeBundleComponents",
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"description": "Use this to include `ProductBundleComponents` associated with the product variant. </br> By default they are not included."
},
{
"name": "includeTags",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"description": "Determines if \"tags\" are returned in the response"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductVariant"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
}
}
}
}