[Deprecated] Get Product Pair by Variant ID
get
https://api.flxpoint.com/product/variant/{variantId}/pairDeprecatedUse this when you want to pull product data through the API.
🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
Deprecated, use `/products/variants/{id}` with `includeParent`
Request
Example request
get
/product/variant/{variantId}/paircurl -X GET "https://api.flxpoint.com/product/variant/{variantId}/pair" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OKapplication/json
parentobjectrequiredidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryTwoobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryThreeobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegeroptionsarray[ProductParentOption]productParentIdintegeridintegernamestringrequiredglobalOptionIdinteger (int64)optionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ProductParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ProductParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ProductVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumberThe cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumberThe MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumberThe MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumberThe estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumberThe estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"productParentIdintegerpricenumberThe dynamic price, or locked price if overwritten.
salePricenumberestimatedShippingCostnumberThe dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumberThe dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredproductAlternativesarray[AlternateVariant]idintegerskustringtitlestringquantityintegercostnumberpricenumberimagestringparentIdintegerreferenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumberThe dynamic MSRP, or locked MSRP if overwritten.
mapnumberThe dynamic MAP, or locked MAP if overwritten.
weightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberThe dynamic cost, or locked cost if overwritten.
quantityintegerThe dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityintegerThe # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegeroptionsarray[ProductVariantOption]productParentOptionIdintegerglobalOptionValueIdinteger (int64)productVariantIdintegeridintegerpositionintegernamestringrequiredvaluestringrequiredglobalPositionintegerbundlebooleanIndicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]Only available when the product is a part of a bundle
componentQuantityintegerrequiredcomponentProductVariantobjectpriceOverwritePriceOverwritequantityOverwriteQuantityOverwriteproductParentIdintegerpricenumberThe dynamic price, or locked price if overwritten.
salePricenumberestimatedShippingCostnumberThe dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumberThe dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]productAlternativesarray[AlternateVariant]referenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumberThe dynamic MSRP, or locked MSRP if overwritten.
mapnumberThe dynamic MAP, or locked MAP if overwritten.
weightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberThe dynamic cost, or locked cost if overwritten.
quantityintegerThe dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityintegerThe # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitWeightUnitdimensionUnitDimensionUnitdimensionalWeightnumberimagesarray[ProductImage]optionsarray[ProductVariantOption]bundlebooleanIndicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]customAggregateFieldsarray[ProductVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]parentProductParentdescriptionstringtagsarray[string]requiresFflbooleanIndicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredbooleanlinkedSourceCountintegerThe number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdintegercomponentProductVariantIdintegerrequiredlistingLinksarray[ProductVariantListingLink]listingVariantIdintegerrequiredchannelIdintegerrequiredcustomAggregateFieldsarray[ProductVariantCustomAggregateField]idinteger (int64)productVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleandefault
falseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringparentobjectidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryTwoobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryThreeobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegeroptionsarray[ProductParentOption]productParentIdintegeridintegernamestringrequiredglobalOptionIdinteger (int64)optionValuesarray[OptionValue]attributesarray[ProductParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ProductParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ProductVariant]priceOverwritePriceOverwritequantityOverwriteQuantityOverwriteproductParentIdintegerpricenumberThe dynamic price, or locked price if overwritten.
salePricenumberestimatedShippingCostnumberThe dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumberThe dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]productAlternativesarray[AlternateVariant]referenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumberThe dynamic MSRP, or locked MSRP if overwritten.
mapnumberThe dynamic MAP, or locked MAP if overwritten.
weightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberThe dynamic cost, or locked cost if overwritten.
quantityintegerThe dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityintegerThe # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitWeightUnitdimensionUnitDimensionUnitdimensionalWeightnumberimagesarray[ProductImage]optionsarray[ProductVariantOption]bundlebooleanIndicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]customAggregateFieldsarray[ProductVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]parentProductParentdescriptionstringtagsarray[string]requiresFflbooleanIndicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredbooleanlinkedSourceCountintegerThe number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)tagsarray[string]string
listingLinksarray[ProductParentListingLink]listingParentIdintegerrequiredchannelIdintegerrequiredimageFetcherEventTriggeredbooleandescriptionstringtagsarray[string]string
requiresFflbooleanIndicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredbooleanlinkedSourceCountintegerThe number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)tagsarray[string]string
listingLinksarray[ProductParentListingLink]listingParentIdintegerrequiredchannelIdintegerrequiredimageFetcherEventTriggeredbooleanvariantobjectrequiredpriceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumberThe cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumberThe MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumberThe MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumberThe estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumberThe estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"productParentIdintegerpricenumberThe dynamic price, or locked price if overwritten.
salePricenumberestimatedShippingCostnumberThe dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumberThe dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredproductAlternativesarray[AlternateVariant]idintegerskustringtitlestringquantityintegercostnumberpricenumberimagestringparentIdintegerreferenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumberThe dynamic MSRP, or locked MSRP if overwritten.
mapnumberThe dynamic MAP, or locked MAP if overwritten.
weightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberThe dynamic cost, or locked cost if overwritten.
quantityintegerThe dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityintegerThe # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegeroptionsarray[ProductVariantOption]productParentOptionIdintegerglobalOptionValueIdinteger (int64)productVariantIdintegeridintegerpositionintegernamestringrequiredvaluestringrequiredglobalPositionintegerbundlebooleanIndicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]Only available when the product is a part of a bundle
componentQuantityintegerrequiredcomponentProductVariantobjectpriceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumberThe cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumberThe MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumberThe MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumberThe estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumberThe estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"productParentIdintegerpricenumberThe dynamic price, or locked price if overwritten.
salePricenumberestimatedShippingCostnumberThe dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumberThe dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredproductAlternativesarray[AlternateVariant]idintegerskustringtitlestringquantityintegercostnumberpricenumberimagestringparentIdintegerreferenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumberThe dynamic MSRP, or locked MSRP if overwritten.
mapnumberThe dynamic MAP, or locked MAP if overwritten.
weightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberThe dynamic cost, or locked cost if overwritten.
quantityintegerThe dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityintegerThe # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegeroptionsarray[ProductVariantOption]productParentOptionIdintegerglobalOptionValueIdinteger (int64)productVariantIdintegeridintegerpositionintegernamestringrequiredvaluestringrequiredglobalPositionintegerbundlebooleanIndicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]Only available when the product is a part of a bundle
componentQuantityintegerrequiredcomponentProductVariantProductVariantbundleProductVariantIdintegercomponentProductVariantIdintegerrequiredlistingLinksarray[ProductVariantListingLink]listingVariantIdintegerrequiredchannelIdintegerrequiredcustomAggregateFieldsarray[ProductVariantCustomAggregateField]idinteger (int64)productVariantIdintegeraccountIdintegercustomAggregateFieldCustomAggregateFieldnamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringparentobjectidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryTwoobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryThreeobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (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]string
requiresFflbooleanIndicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredbooleanlinkedSourceCountintegerThe number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdintegercomponentProductVariantIdintegerrequiredlistingLinksarray[ProductVariantListingLink]listingVariantIdintegerrequiredchannelIdintegerrequiredcustomAggregateFieldsarray[ProductVariantCustomAggregateField]idinteger (int64)productVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleandefault
falseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringparentobjectidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryTwoobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryThreeobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegeroptionsarray[ProductParentOption]productParentIdintegeridintegernamestringrequiredglobalOptionIdinteger (int64)optionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ProductParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ProductParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ProductVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumberThe cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumberThe MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumberThe MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumberThe estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumberThe estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured.
This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"productParentIdintegerpricenumberThe dynamic price, or locked price if overwritten.
salePricenumberestimatedShippingCostnumberThe dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumberThe dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumberimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)inventoryLinksarray[ProductVariantInventoryLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredproductAlternativesarray[AlternateVariant]idintegerskustringtitlestringquantityintegercostnumberpricenumberimagestringparentIdintegerreferenceIdentifierstringidintegerskustringrequiredtitlestringmpnstringupcstringeanstringasinstringmsrpnumberThe dynamic MSRP, or locked MSRP if overwritten.
mapnumberThe dynamic MAP, or locked MAP if overwritten.
weightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberThe dynamic cost, or locked cost if overwritten.
quantityintegerThe dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityintegerThe # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ProductImage]productParentIdintegerproductVariantIdintegermd5ChecksumstringoriginalUrlstringfetchedbooleanfetchAttemptsintegerarchivedbooleanidintegerurlstringrequiredsortOrderintegeroptionsarray[ProductVariantOption]productParentOptionIdintegerglobalOptionValueIdinteger (int64)productVariantIdintegeridintegerpositionintegernamestringrequiredvaluestringrequiredglobalPositionintegerbundlebooleanIndicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]Only available when the product is a part of a bundle
componentQuantityintegerrequiredcomponentProductVariantProductVariantbundleProductVariantIdintegercomponentProductVariantIdintegerrequiredlistingLinksarray[ProductVariantListingLink]listingVariantIdintegerrequiredchannelIdintegerrequiredcustomAggregateFieldsarray[ProductVariantCustomAggregateField]idinteger (int64)productVariantIdintegeraccountIdintegercustomAggregateFieldCustomAggregateFieldnamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)customFieldsarray[ProductVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringparentobjectidintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryTwoobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorycategoryThreeobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (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]string
requiresFflbooleanIndicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredbooleanlinkedSourceCountintegerThe number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanproductBuilderIdintegerbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)tagsarray[string]string
listingLinksarray[ProductParentListingLink]listingParentIdintegerrequiredchannelIdintegerrequiredimageFetcherEventTriggeredbooleandescriptionstringtagsarray[string]string
requiresFflbooleanIndicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredbooleanlinkedSourceCountintegerThe number of sources (inventory variants) linked to the product that act as means of fulfillment
Example response
{
"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": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"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": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"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": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"images": [
{
"productParentId": 0,
"productVariantId": 0,
"md5Checksum": "string",
"originalUrl": "string",
"fetched": true,
"fetchAttempts": 0,
"archived": true,
"id": 0,
"url": "string",
"sortOrder": 0
}
],
"options": [
{
"productParentId": 0,
"id": 0,
"name": "string",
"globalOptionId": 0,
"optionValues": [
null
]
}
],
"attributes": [
{
"id": 0,
"attributeId": 0,
"attributeValueId": 0,
"name": "string",
"originalInventoryName": "string",
"value": "string",
"originalInventoryValue": "string",
"isPrivate": true,
"mergeToAttributeId": 0,
"mergeToAttributeName": "string",
"mergeToAttributeValueId": 0,
"mergeToAttributeValue": "string",
"mergeToAttributeIsPrivate": true
}
],
"customFields": [
{
"id": 0,
"customFieldValueId": 0,
"customFieldId": 0,
"name": "string",
"value": "string",
"originalInventoryName": "string",
"originalInventoryValue": "string",
"mergeToCustomFieldId": 0,
"mergeToCustomFieldName": "string",
"mergeToCustomFieldValueId": 0,
"mergeToCustomFieldValue": "string"
}
],
"variants": [
{
"priceOverwrite": {
"priceOverwritten": null,
"costOverwritten": null,
"msrpOverwritten": null,
"mapOverwritten": null,
"shippingCostOverwritten": null,
"dropshipFeeOverwritten": null,
"dynamicPrice": null,
"dynamicCost": null,
"dynamicMsrp": null,
"dynamicMap": null,
"dynamicShippingCost": null,
"dynamicDropshipFee": null
},
"quantityOverwrite": {
"quantityOverwritten": null,
"dynamicQuantity": null,
"orderVolumeProtectionLockedAt": null,
"lastManualQuantity": null,
"isLockedByOrderVolumeProtection": null
},
"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": [
null
],
"productAlternatives": [
null
],
"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": null,
"abbreviatedHandle": null
},
"dimensionUnit": {
"handle": null,
"abbreviatedHandle": null
},
"dimensionalWeight": 0,
"images": [
null
],
"options": [
null
],
"bundle": true,
"bundleComponents": [
null
],
"listingLinks": [
null
],
"customAggregateFields": [
null
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"customFields": [
null
],
"parent": {
"id": null,
"sku": null,
"title": null,
"description": null,
"manufacturer": null,
"insertedAt": null,
"updatedAt": null,
"archived": null,
"categoryOne": null,
"categoryTwo": null,
"categoryThree": null,
"images": null,
"options": null,
"attributes": null,
"customFields": null,
"variants": null,
"categoryOneId": null,
"categoryTwoId": null,
"categoryThreeId": null,
"imagesFetched": null,
"productBuilderId": null,
"builtWithMappingTemplateId": null,
"builtAt": null,
"rebuiltAt": null,
"tags": null,
"listingLinks": null,
"imageFetcherEventTriggered": null
},
"description": "string",
"tags": [
null
],
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"linkedSourceCount": 0
}
],
"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": 0,
"channelId": 0
}
],
"imageFetcherEventTriggered": true
},
"variant": {
"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
}
],
"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
}
],
"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
}
],
"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
}
}401Unauthorized
No schema documented for this status.
404Not Found
No schema documented for this status.
OpenAPI fragment
{
"get": {
"summary": "[Deprecated] Get Product Pair by Variant ID",
"description": "Deprecated, use `/products/variants/{id}` with `includeParent`",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPair"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
}
}
}
}Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight