FlxpointAPI Help CenterBeta

Get Product Variants

gethttps://api.flxpoint.com/product/variants

Use this when you want to pull product data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

This endpoint will fetch back a list of Product Variants. You cannot use both `findBySKUs` and `findByIds` in a single request

Request

Query parameters
  • pagequeryinteger

    page number

  • pageSizequeryinteger

    number of elements per page

  • updatedAfterquerystring (date-time)

    Only retrieves back inventory records that hae been updated after the date specified

  • skusqueryarray[string]

    Finds elements matching these SKUs. Max must be less than or equal to pageSize.

  • upcsqueryarray[string]

    Finds elements matching these UPCs. Max must be less than or equal to pageSize.

  • idsqueryarray[integer]

    Finds elements matching these IDs. Max must be less than or equal to pageSize.

  • includeOverwritesqueryboolean

    If `true` will include a list of Price/Quantity overwrites

  • includeCustomAggregatesqueryboolean

    If "false" is passed, the "customAggregates"(Fields) node will not be populated. Custom Aggregates are similar to custom fields, but they can be aggregated across multiple sources.

  • includeCustomFieldsqueryboolean

    If "true" is passed, the "customFields" nodes will be populated.

  • includeImagesqueryboolean

    If "false" is passed, the "image" and "parent.image" nodes will not be populated

  • includeOptionsqueryboolean

    If "false" is passed, the "options" and "parent.options" nodes will not be populated

  • includeInventoryLinksqueryboolean

    If `true`, `inventoryLinks` will be populated with a list of `Inventory Variant IDs` that this product is associated to.

  • includeListingLinksqueryboolean

    If `true`, `listingLinks` will be populated with a list of `Listing Variant IDs` that this product is associated to.

  • includeParentqueryboolean

    If "true" is passed, the "parent" node will be populated with Parent information. NOTE : The "variants" will be empty in this node to prevent circular references.

  • includeAttributesqueryboolean

    If "true" is passed, the "parent.attributes" node will be populated.

  • includeCategoriesqueryboolean

    If "true" is passed, the parent category nodes will be populated.

  • includeBundleComponentsqueryboolean

    Use this to include `ProductBundleComponents` associated with the product variant. </br> By default they are not included.

  • includeTagsqueryboolean

    Determines if "tags" are returned in the response

Example request

get/product/variants
curl -X GET "https://api.flxpoint.com/product/variants" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json
array[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The 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.
dynamicCostnumber
The 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.
dynamicMsrpnumber
The 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.
dynamicMapnumber
The 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.
dynamicShippingCostnumber
The 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.
dynamicDropshipFeenumber
The 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.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The 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.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates 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
componentQuantityintegerrequired
componentProductVariantobject
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The 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.
dynamicCostnumber
The 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.
dynamicMsrpnumber
The 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.
dynamicMapnumber
The 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.
dynamicShippingCostnumber
The 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.
dynamicDropshipFeenumber
The 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.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The 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.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates 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
componentQuantityintegerrequired
componentProductVariantProductVariant
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldCustomAggregateField
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryInventoryCategory
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryInventoryCategory
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryInventoryCategory
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldobject
idinteger
aggregateFieldDataTypeIdinteger
customAggregateFieldOptionIdinteger
namestring
handlestring
ignoreOutOfStockboolean
default false
accountIdinteger
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
idinteger
optionIdinteger
valuestring
positioninteger
globalPositioninteger
globalOptionValueIdinteger (int64)
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The 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.
dynamicCostnumber
The 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.
dynamicMsrpnumber
The 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.
dynamicMapnumber
The 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.
dynamicShippingCostnumber
The 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.
dynamicDropshipFeenumber
The 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.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The 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.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates 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
componentQuantityintegerrequired
componentProductVariantProductVariant
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldCustomAggregateField
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryInventoryCategory
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryInventoryCategory
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryInventoryCategory
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The 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": null,
          "quantityOverwrite": null,
          "productParentId": null,
          "price": null,
          "salePrice": null,
          "estimatedShippingCost": null,
          "estimatedDropshipFee": null,
          "inventoryListPrice": null,
          "imagesFetched": null,
          "productBuilderId": null,
          "builtWithMappingTemplateId": null,
          "builtAt": null,
          "rebuiltAt": null,
          "inventoryLinks": null,
          "productAlternatives": null,
          "referenceIdentifier": null,
          "id": null,
          "sku": null,
          "title": null,
          "mpn": null,
          "upc": null,
          "ean": null,
          "asin": null,
          "msrp": null,
          "map": null,
          "weight": null,
          "length": null,
          "width": null,
          "height": null,
          "insertedAt": null,
          "updatedAt": null,
          "archived": null,
          "cost": null,
          "quantity": null,
          "pendingFulfillmentQuantity": null,
          "weightUnit": null,
          "dimensionUnit": null,
          "dimensionalWeight": null,
          "images": null,
          "options": null,
          "bundle": null,
          "bundleComponents": null,
          "listingLinks": null,
          "customAggregateFields": null,
          "scheduledToDeleteAt": null,
          "customFields": null,
          "parent": null,
          "description": null,
          "tags": null,
          "requiresFfl": null,
          "imageFetcherEventTriggered": null,
          "linkedSourceCount": null
        },
        "bundleProductVariantId": 0,
        "componentProductVariantId": 0
      }
    ],
    "listingLinks": [
      {
        "listingVariantId": 0,
        "channelId": 0
      }
    ],
    "customAggregateFields": [
      {
        "id": 0,
        "productVariantId": 0,
        "accountId": 0,
        "customAggregateField": {
          "id": null,
          "aggregateFieldDataTypeId": null,
          "customAggregateFieldOptionId": null,
          "name": null,
          "handle": null,
          "ignoreOutOfStock": null,
          "accountId": null
        },
        "name": "string",
        "value": 0,
        "customAggregateFieldId": 0
      }
    ],
    "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
    "customFields": [
      {
        "id": 0,
        "customFieldValueId": 0,
        "customFieldId": 0,
        "name": "string",
        "value": "string",
        "originalInventoryName": "string",
        "originalInventoryValue": "string",
        "mergeToCustomFieldId": 0,
        "mergeToCustomFieldName": "string",
        "mergeToCustomFieldValueId": 0,
        "mergeToCustomFieldValue": "string"
      }
    ],
    "parent": {
      "id": 0,
      "sku": "string",
      "title": "string",
      "description": "string",
      "manufacturer": "string",
      "insertedAt": "2026-04-20T00:00:00Z",
      "updatedAt": "2026-04-20T00:00:00Z",
      "archived": true,
      "categoryOne": {
        "accountId": 0,
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "customized": true,
        "id": 0,
        "name": "string",
        "parentCategoryId": 0,
        "inventoryCategory": {
          "sourceId": null,
          "productCategoryId": null,
          "id": null,
          "name": null,
          "excluded": null,
          "parentCategoryId": null
        }
      },
      "categoryTwo": {
        "accountId": 0,
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "customized": true,
        "id": 0,
        "name": "string",
        "parentCategoryId": 0,
        "inventoryCategory": {
          "sourceId": null,
          "productCategoryId": null,
          "id": null,
          "name": null,
          "excluded": null,
          "parentCategoryId": null
        }
      },
      "categoryThree": {
        "accountId": 0,
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "customized": true,
        "id": 0,
        "name": "string",
        "parentCategoryId": 0,
        "inventoryCategory": {
          "sourceId": null,
          "productCategoryId": null,
          "id": null,
          "name": null,
          "excluded": null,
          "parentCategoryId": null
        }
      },
      "images": [
        {
          "productParentId": null,
          "productVariantId": null,
          "md5Checksum": null,
          "originalUrl": null,
          "fetched": null,
          "fetchAttempts": null,
          "archived": null,
          "id": null,
          "url": null,
          "sortOrder": null
        }
      ],
      "options": [
        {
          "productParentId": null,
          "id": null,
          "name": null,
          "globalOptionId": null,
          "optionValues": null
        }
      ],
      "attributes": [
        {
          "id": null,
          "attributeId": null,
          "attributeValueId": null,
          "name": null,
          "originalInventoryName": null,
          "value": null,
          "originalInventoryValue": null,
          "isPrivate": null,
          "mergeToAttributeId": null,
          "mergeToAttributeName": null,
          "mergeToAttributeValueId": null,
          "mergeToAttributeValue": null,
          "mergeToAttributeIsPrivate": null
        }
      ],
      "customFields": [
        {
          "id": null,
          "customFieldValueId": null,
          "customFieldId": null,
          "name": null,
          "value": null,
          "originalInventoryName": null,
          "originalInventoryValue": null,
          "mergeToCustomFieldId": null,
          "mergeToCustomFieldName": null,
          "mergeToCustomFieldValueId": null,
          "mergeToCustomFieldValue": null
        }
      ],
      "variants": [
        {
          "priceOverwrite": null,
          "quantityOverwrite": null,
          "productParentId": null,
          "price": null,
          "salePrice": null,
          "estimatedShippingCost": null,
          "estimatedDropshipFee": null,
          "inventoryListPrice": null,
          "imagesFetched": null,
          "productBuilderId": null,
          "builtWithMappingTemplateId": null,
          "builtAt": null,
          "rebuiltAt": null,
          "inventoryLinks": null,
          "productAlternatives": null,
          "referenceIdentifier": null,
          "id": null,
          "sku": null,
          "title": null,
          "mpn": null,
          "upc": null,
          "ean": null,
          "asin": null,
          "msrp": null,
          "map": null,
          "weight": null,
          "length": null,
          "width": null,
          "height": null,
          "insertedAt": null,
          "updatedAt": null,
          "archived": null,
          "cost": null,
          "quantity": null,
          "pendingFulfillmentQuantity": null,
          "weightUnit": null,
          "dimensionUnit": null,
          "dimensionalWeight": null,
          "images": null,
          "options": null,
          "bundle": null,
          "bundleComponents": null,
          "listingLinks": null,
          "customAggregateFields": null,
          "scheduledToDeleteAt": null,
          "customFields": null,
          "parent": null,
          "description": null,
          "tags": null,
          "requiresFfl": null,
          "imageFetcherEventTriggered": null,
          "linkedSourceCount": null
        }
      ],
      "categoryOneId": 0,
      "categoryTwoId": 0,
      "categoryThreeId": 0,
      "imagesFetched": true,
      "productBuilderId": 0,
      "builtWithMappingTemplateId": 0,
      "builtAt": "2026-04-20T00:00:00Z",
      "rebuiltAt": "2026-04-20T00:00:00Z",
      "tags": [
        "string"
      ],
      "listingLinks": [
        {
          "listingParentId": null,
          "channelId": null
        }
      ],
      "imageFetcherEventTriggered": true
    },
    "description": "string",
    "tags": [
      "string"
    ],
    "requiresFfl": true,
    "imageFetcherEventTriggered": true,
    "linkedSourceCount": 0
  }
]
400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

OpenAPI fragment
{
  "get": {
    "summary": "Get Product Variants",
    "description": "This endpoint will fetch back a list of Product Variants. You cannot use both `findBySKUs` and `findByIds` in a single request",
    "parameters": [
      {
        "name": "page",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 1
        },
        "description": "page number"
      },
      {
        "name": "pageSize",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 50,
          "maximum": 100
        },
        "description": "number of elements per page"
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time"
        },
        "in": "query",
        "name": "updatedAfter",
        "description": "Only retrieves back inventory records that hae been updated after the date specified"
      },
      {
        "schema": {
          "type": "array",
          "maxItems": 100,
          "example": "SKU123,SKU456,SKU789",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "in": "query",
        "name": "skus",
        "description": "Finds elements matching these SKUs. Max must be less than or equal to pageSize.",
        "style": "form",
        "explode": false
      },
      {
        "schema": {
          "type": "array",
          "maxItems": 100,
          "example": "012345678905,012345678912",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        },
        "in": "query",
        "name": "upcs",
        "description": "Finds elements matching these UPCs. Max must be less than or equal to pageSize.",
        "style": "form",
        "explode": false
      },
      {
        "schema": {
          "type": "array",
          "maxItems": 100,
          "example": "123,456,789",
          "uniqueItems": true,
          "items": {
            "type": "integer"
          }
        },
        "in": "query",
        "name": "ids",
        "description": "Finds elements matching these IDs. Max must be less than or equal to pageSize.",
        "style": "form",
        "explode": false
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "includeOverwrites",
        "description": "If `true` will include a list of Price/Quantity overwrites"
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeCustomAggregates",
        "description": "If \"false\" is passed, the \"customAggregates\"(Fields) node will not be populated. Custom Aggregates are similar to custom fields, but they can be aggregated across multiple sources. "
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeCustomFields",
        "description": "If \"true\" is passed, the \"customFields\" nodes will be populated. "
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeImages",
        "description": "If \"false\" is passed, the \"image\" and \"parent.image\" nodes will not be populated"
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeOptions",
        "description": "If \"false\" is passed, the \"options\" and \"parent.options\" nodes will not be populated"
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeInventoryLinks",
        "description": "If `true`, `inventoryLinks` will be populated with a list of `Inventory Variant IDs` that this product is associated to."
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeListingLinks",
        "description": "If `true`, `listingLinks` will be populated with a list of `Listing Variant IDs` that this product is associated to."
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeParent",
        "description": "If \"true\" is passed, the \"parent\" node will be populated with Parent information. NOTE : The \"variants\" will be empty in this node to prevent circular references."
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeAttributes",
        "description": "If \"true\" is passed, the \"parent.attributes\" node will be populated. "
      },
      {
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "name": "includeCategories",
        "description": "If \"true\" is passed, the parent category nodes will  be populated."
      },
      {
        "name": "includeBundleComponents",
        "schema": {
          "type": "boolean",
          "default": false
        },
        "in": "query",
        "description": "Use this to include `ProductBundleComponents` associated with the product variant. </br> By default they are not included."
      },
      {
        "name": "includeTags",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        },
        "description": "Determines if \"tags\" are returned in the response"
      }
    ],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProductVariant"
              }
            }
          }
        }
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight