Create/Update Product Variant
post
https://api.flxpoint.com/product/products/variantUse this when you want to create 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.
Create/Update a product variant.
**Note on Bundles:** To create a bundle, you must set the `bundle` field to `true` in the initial creation request (this cannot be updated later). You do not need to pass `bundleProductVariantId` in the `bundleComponents` array during creation.
Request
Query parameters
restrictCreateOrUpdatequerystring[Optional] When using a endpoint that can create or update products by SKU, use this parameter to restrict the endpoint to perform only a creation or only an update based on the existence of that SKU. If you pass `createOnly` and the SKU exists nothing will be updated, and if you pass `updateOnly` and the SKU doesn't exist nothing will be created.
allowedcreateOnlyupdateOnlymodifyContentquerystringShould content fields of the parent/variant be modified
allowednoneupdateupdateNonNullmodifyIdentifiersquerystringShould identifier fields (ie Master SKU, UPC, MPN, GTIN, ASIN, Reference Identifier) of the variant be modified
allowednoneupdateupdateNonNullmodifyDimensionsquerystringShould dimension fields (ie weight, length, width, height) of the variant be modified
allowednoneupdateupdateNonNullmodifyOptionsquerystringShould options of the parent/variant be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyImagesquerystringShould images of the parent/variant be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyInventoryLinksquerystringShould inventory links of the product variant be updated
allowednoneupdatemergedeleteIncludeddeleteAllmodifyQuantityOverwritequerystringShould the quantity overwrite be updated? Use in combination with the quantityOverwrite object and associated variant quantity field(s) to overwrite any to a locked value or to remove any overwrites.
allowednoneupdatedeleteupdateNonNullmodifyPriceOverwritequerystringShould the price overwrite be updated? Use in combination with the priceOverwrite object and associated variant pricing field(s) to overwrite any to a locked value or to remove any overwrite(s)..
allowednoneupdateupdateNonNulldeletemodifyBundleComponentsquerystringShould bundle components of the product variant be updated
allowednoneupdatemergedeleteIncludeddeleteAllmodifyVariantCustomFieldsquerystringShould custom fields of the variant be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyProductAlternativesquerystringShould product alternatives of the variant be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyRequiresFflquerystringShould the `requiresFfl` field be modified
allowednoneupdateupdateNonNull
Body
application/jsonpriceOverwriteobjectpriceOverwrittenbooleanTrue 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
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
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
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]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 request
post
/product/products/variantcurl -X POST "https://api.flxpoint.com/product/products/variant" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"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": {
"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
},
"bundleProductVariantId": 0,
"componentProductVariantId": 0
}
],
"listingLinks": [
{
"listingVariantId": 0,
"channelId": 0
}
],
"customAggregateFields": [
{
"id": 0,
"productVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": 0,
"aggregateFieldDataTypeId": 0,
"customAggregateFieldOptionId": 0,
"name": "string",
"handle": "string",
"ignoreOutOfStock": true,
"accountId": 0
},
"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": 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
},
"description": "string",
"tags": [
"string"
],
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"linkedSourceCount": 0
}'Example body · application/json
{
"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": {
"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
},
"bundleProductVariantId": 0,
"componentProductVariantId": 0
}
],
"listingLinks": [
{
"listingVariantId": 0,
"channelId": 0
}
],
"customAggregateFields": [
{
"id": 0,
"productVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": 0,
"aggregateFieldDataTypeId": 0,
"customAggregateFieldOptionId": 0,
"name": "string",
"handle": "string",
"ignoreOutOfStock": true,
"accountId": 0
},
"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": 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
},
"description": "string",
"tags": [
"string"
],
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"linkedSourceCount": 0
}Responses
200OK - Existing variant was updated OR the `restrictCreateOrUpdate` param was provided with a value of `createOnly` and the variant already existed in which case nothing was modified and the existing variant will be returned.application/json
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
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
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
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
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]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
{
"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": {
"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
},
"bundleProductVariantId": 0,
"componentProductVariantId": 0
}
],
"listingLinks": [
{
"listingVariantId": 0,
"channelId": 0
}
],
"customAggregateFields": [
{
"id": 0,
"productVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": 0,
"aggregateFieldDataTypeId": 0,
"customAggregateFieldOptionId": 0,
"name": "string",
"handle": "string",
"ignoreOutOfStock": true,
"accountId": 0
},
"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": 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
},
"description": "string",
"tags": [
"string"
],
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"linkedSourceCount": 0
}201CREATED - A new variant was createdapplication/json
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
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
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
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
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]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
{
"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": {
"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
},
"bundleProductVariantId": 0,
"componentProductVariantId": 0
}
],
"listingLinks": [
{
"listingVariantId": 0,
"channelId": 0
}
],
"customAggregateFields": [
{
"id": 0,
"productVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": 0,
"aggregateFieldDataTypeId": 0,
"customAggregateFieldOptionId": 0,
"name": "string",
"handle": "string",
"ignoreOutOfStock": true,
"accountId": 0
},
"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": 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
},
"description": "string",
"tags": [
"string"
],
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"linkedSourceCount": 0
}204NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the variant product does not exist. This will return an empty/null response body.application/json
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
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
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
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
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]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
{
"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": {
"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
},
"bundleProductVariantId": 0,
"componentProductVariantId": 0
}
],
"listingLinks": [
{
"listingVariantId": 0,
"channelId": 0
}
],
"customAggregateFields": [
{
"id": 0,
"productVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": 0,
"aggregateFieldDataTypeId": 0,
"customAggregateFieldOptionId": 0,
"name": "string",
"handle": "string",
"ignoreOutOfStock": true,
"accountId": 0
},
"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": 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
},
"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.
409Conflict - If the SKU provided already exists on a different variant a conflict will be returnedapplication/json
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
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
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
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
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]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
{
"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": {
"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
},
"bundleProductVariantId": 0,
"componentProductVariantId": 0
}
],
"listingLinks": [
{
"listingVariantId": 0,
"channelId": 0
}
],
"customAggregateFields": [
{
"id": 0,
"productVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": 0,
"aggregateFieldDataTypeId": 0,
"customAggregateFieldOptionId": 0,
"name": "string",
"handle": "string",
"ignoreOutOfStock": true,
"accountId": 0
},
"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": 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
},
"description": "string",
"tags": [
"string"
],
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"linkedSourceCount": 0
}OpenAPI fragment
{
"post": {
"summary": "Create/Update Product Variant",
"description": "Create/Update a product variant. \n\n**Note on Bundles:** To create a bundle, you must set the `bundle` field to `true` in the initial creation request (this cannot be updated later). You do not need to pass `bundleProductVariantId` in the `bundleComponents` array during creation.",
"parameters": [
{
"name": "restrictCreateOrUpdate",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"createOnly",
"updateOnly"
]
},
"description": "[Optional] When using a endpoint that can create or update products by SKU, use this parameter to restrict the endpoint to perform only a creation or only an update based on the existence of that SKU. If you pass `createOnly` and the SKU exists nothing will be updated, and if you pass `updateOnly` and the SKU doesn't exist nothing will be created."
},
{
"name": "modifyContent",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"description": "Should content fields of the parent/variant be modified"
},
{
"name": "modifyIdentifiers",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"description": "Should identifier fields (ie Master SKU, UPC, MPN, GTIN, ASIN, Reference Identifier) of the variant be modified"
},
{
"name": "modifyDimensions",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"description": "Should dimension fields (ie weight, length, width, height) of the variant be modified"
},
{
"name": "modifyOptions",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"merge",
"deleteIncluded",
"deleteAll"
]
},
"description": "Should options of the parent/variant be modified"
},
{
"name": "modifyImages",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"merge",
"deleteIncluded",
"deleteAll"
]
},
"description": "Should images of the parent/variant be modified"
},
{
"name": "modifyInventoryLinks",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"merge",
"deleteIncluded",
"deleteAll"
]
},
"description": "Should inventory links of the product variant be updated"
},
{
"name": "modifyQuantityOverwrite",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"delete",
"updateNonNull"
]
},
"description": "Should the quantity overwrite be updated? Use in combination with the quantityOverwrite object and associated variant quantity field(s) to overwrite any to a locked value or to remove any overwrites."
},
{
"name": "modifyPriceOverwrite",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull",
"delete"
]
},
"description": "Should the price overwrite be updated? Use in combination with the priceOverwrite object and associated variant pricing field(s) to overwrite any to a locked value or to remove any overwrite(s).."
},
{
"name": "modifyBundleComponents",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"merge",
"deleteIncluded",
"deleteAll"
]
},
"description": "Should bundle components of the product variant be updated"
},
{
"name": "modifyVariantCustomFields",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"merge",
"deleteIncluded",
"deleteAll"
]
},
"description": "Should custom fields of the variant be modified"
},
{
"schema": {
"type": "string",
"enum": [
"none",
"update",
"merge",
"deleteIncluded",
"deleteAll"
]
},
"in": "query",
"name": "modifyProductAlternatives",
"description": "Should product alternatives of the variant be modified"
},
{
"name": "modifyRequiresFfl",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"description": "Should the `requiresFfl` field be modified"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVariantCreateUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Existing variant was updated OR the `restrictCreateOrUpdate` param was provided with a value of `createOnly` and the variant already existed in which case nothing was modified and the existing variant will be returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVariant"
}
}
}
},
"201": {
"description": "CREATED - A new variant was created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVariant"
}
}
}
},
"204": {
"description": "NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the variant product does not exist. This will return an empty/null response body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVariant"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"409": {
"description": "Conflict - If the SKU provided already exists on a different variant a conflict will be returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVariant"
}
}
}
}
}
}
}Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight