FlxpointAPI Help CenterBeta

Get Listing Variants

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

Use this when you want to pull listing 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 Listing Variants! If you're a new integrator, it's recommended to read the `Integrating as a Channel` guide.

Request

Query parameters
  • pagequeryinteger

    page number

  • pageSizequeryinteger

    number of elements per page

  • channelIdqueryinteger

    This will be automatically populated for Channel API Tokens. Required if using an Account API Token

  • updatedAfterquerystring (date-time)

    Only retrieves back listing variants that hae been updated after the date specified

  • basicsUpdatedAfterquerystring (date-time)

    Only retrieves back listing variants that have had basic info updated after the date specified. This includes primary fields like `price` and `quantity`

  • syncqueryboolean

    Read our API Guides to learn about this flag. Passing `true` requires you to respond for the interaction.

  • 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 (int64)]

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

  • 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.

  • 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

  • includeAttributesqueryboolean

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

  • includeCategoriesqueryboolean

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

  • includeCustomFieldsqueryboolean

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

  • 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.

  • includeOverwritesqueryboolean

    will include dynamic prices and quantities if they are overwritten with fixed values

  • includeTagsqueryboolean

    Determines if "tags" are returned in the response

Example request

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

Responses

200OKapplication/json
array[ListingVariant]
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"
listingParentIdinteger
pricenumber
salePricenumber
estimatedShippingCostnumber
estimatedDropshipFeenumber
inventoryListPricenumber
imagesFetchedboolean
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
idinteger
accountIdinteger
skustringrequired
masterSkustring
Your master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
mapnumber
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
quantityinteger
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ListingImage]
listingParentIdinteger
listingVariantIdinteger
md5Checksumstring
idinteger
urlstringrequired
sortOrderinteger
createdAtstring (date-time)
publishedAtstring (date-time)
staticContentUpdatedAtstring (date-time)
staticContentSyncedAtstring (date-time)
dynamicContentUpdatedAtstring (date-time)
dynamicCOntentSyncedAtstring (date-time)
publishingboolean
externalListingIdstring
listingErrorstring
productParentImageIdinteger
productVariantImageIdinteger
optionsarray[ListingVariantOption]
listingParentOptionIdinteger
globalOptionValueIdinteger (int64)
listingVariantIdinteger
idinteger
namestringrequired
valuestringrequired
positioninteger
globalPositioninteger
channelIdintegerrequired
productVariantIdintegerrequired
externalListingIdstring
publishErrorstring
syncErrorstring
pausedAtstring (date-time)
staticContentUpdatedAtstring (date-time)
staticContentSyncedAtstring (date-time)
dynamicContentUpdatedAtstring (date-time)
dynamicContentSyncedAtstring (date-time)
linkAttemptedAtstring (date-time)
linkedToRegularProductboolean
externalReferenceIdstring
externalReferenceIdTypestring
listingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
changeToListingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
listingParentobject
idinteger
accountIdinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
productCategoryobject
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
channelIdintegerrequired
productCategoryIdinteger
categoryTwoobject
A listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
productCategoryobject
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
channelIdintegerrequired
productCategoryIdinteger
categoryThreeobject
A listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
productCategoryobject
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
channelIdintegerrequired
productCategoryIdinteger
imagesarray[ListingImage]
listingParentIdinteger
listingVariantIdinteger
md5Checksumstring
idinteger
urlstringrequired
sortOrderinteger
createdAtstring (date-time)
publishedAtstring (date-time)
staticContentUpdatedAtstring (date-time)
staticContentSyncedAtstring (date-time)
dynamicContentUpdatedAtstring (date-time)
dynamicCOntentSyncedAtstring (date-time)
publishingboolean
externalListingIdstring
listingErrorstring
productParentImageIdinteger
productVariantImageIdinteger
optionsarray[ListingParentOption]
listingParentIdinteger
globalOptionIdinteger (int64)
idinteger
namestringrequired
optionValuesarray[OptionValue]
idinteger
optionIdinteger
valuestring
positioninteger
globalPositioninteger
globalOptionValueIdinteger (int64)
attributesarray[ListingParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ListingParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ListingVariant]
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"
listingParentIdinteger
pricenumber
salePricenumber
estimatedShippingCostnumber
estimatedDropshipFeenumber
inventoryListPricenumber
imagesFetchedboolean
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
idinteger
accountIdinteger
skustringrequired
masterSkustring
Your master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
mapnumber
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
quantityinteger
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ListingImage]
listingParentIdinteger
listingVariantIdinteger
md5Checksumstring
idinteger
urlstringrequired
sortOrderinteger
createdAtstring (date-time)
publishedAtstring (date-time)
staticContentUpdatedAtstring (date-time)
staticContentSyncedAtstring (date-time)
dynamicContentUpdatedAtstring (date-time)
dynamicCOntentSyncedAtstring (date-time)
publishingboolean
externalListingIdstring
listingErrorstring
productParentImageIdinteger
productVariantImageIdinteger
optionsarray[ListingVariantOption]
listingParentOptionIdinteger
globalOptionValueIdinteger (int64)
listingVariantIdinteger
idinteger
namestringrequired
valuestringrequired
positioninteger
globalPositioninteger
channelIdintegerrequired
productVariantIdintegerrequired
externalListingIdstring
publishErrorstring
syncErrorstring
pausedAtstring (date-time)
staticContentUpdatedAtstring (date-time)
staticContentSyncedAtstring (date-time)
dynamicContentUpdatedAtstring (date-time)
dynamicContentSyncedAtstring (date-time)
linkAttemptedAtstring (date-time)
linkedToRegularProductboolean
externalReferenceIdstring
externalReferenceIdTypestring
listingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
changeToListingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
listingParentobject
idinteger
accountIdinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
productCategoryProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
channelIdintegerrequired
productCategoryIdinteger
categoryTwoobject
A listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
productCategoryProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
channelIdintegerrequired
productCategoryIdinteger
categoryThreeobject
A listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
productCategoryProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
channelIdintegerrequired
productCategoryIdinteger
imagesarray[ListingImage]
optionsarray[ListingParentOption]
attributesarray[ListingParentAttribute]
customFieldsarray[ListingParentCustomField]
variantsarray[ListingVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
channelIdintegerrequired
productParentIdintegerrequired
externalListingIdstring
publishErrorstring
syncErrorstring
staticContentUpdatedAtstring (date-time)
staticContentSyncedAtstring (date-time)
linkAttemptedAtstring (date-time)
listingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
changeToListingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
pausedAtstring (date-time)
scheduledToDeleteAtstring (date-time)
tagsarray[string]
imageFetcherEventTriggeredboolean
customAggregateFieldsarray[ListingVariantCustomAggregateField]
idinteger (int64)
listingVariantIdinteger
accountIdinteger
customAggregateFieldCustomAggregateField
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
profitnumber
profitPercentagenumber
profitWithFeesnumber
profitWithFeesPercentagenumber
customFieldsarray[ListingVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
tagsarray[string]
string
descriptionstring
requiresFflboolean
Indicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredboolean
priceProtectionboolean
Will be marked as true when any of these conditions are met : -List Price <= Cost -Cost = 0 or Is Empty -No Linked Inventory),
linkedSourceCountinteger
The number of sources that are linked to the listings associated product
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
channelIdintegerrequired
productParentIdintegerrequired
externalListingIdstring
publishErrorstring
syncErrorstring
staticContentUpdatedAtstring (date-time)
staticContentSyncedAtstring (date-time)
linkAttemptedAtstring (date-time)
listingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
changeToListingStatusobject
idinteger
handlestringrequired
allowednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_data
namestring
pausedAtstring (date-time)
scheduledToDeleteAtstring (date-time)
tagsarray[string]
string
imageFetcherEventTriggeredboolean
customAggregateFieldsarray[ListingVariantCustomAggregateField]
idinteger (int64)
listingVariantIdinteger
accountIdinteger
customAggregateFieldobject
idinteger
aggregateFieldDataTypeIdinteger
customAggregateFieldOptionIdinteger
namestring
handlestring
ignoreOutOfStockboolean
default false
accountIdinteger
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
profitnumber
profitPercentagenumber
profitWithFeesnumber
profitWithFeesPercentagenumber
customFieldsarray[ListingVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
tagsarray[string]
string
descriptionstring
requiresFflboolean
Indicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredboolean
priceProtectionboolean
Will be marked as true when any of these conditions are met : -List Price <= Cost -Cost = 0 or Is Empty -No Linked Inventory),
linkedSourceCountinteger
The number of sources that are linked to the listings associated product
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
    },
    "listingParentId": 0,
    "price": 0,
    "salePrice": 0,
    "estimatedShippingCost": 0,
    "estimatedDropshipFee": 0,
    "inventoryListPrice": 0,
    "imagesFetched": true,
    "builtWithMappingTemplateId": 0,
    "builtAt": "2026-04-20T00:00:00Z",
    "rebuiltAt": "2026-04-20T00:00:00Z",
    "id": 0,
    "accountId": 0,
    "sku": "string",
    "masterSku": "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,
    "weightUnit": {
      "handle": "pound",
      "abbreviatedHandle": "lb"
    },
    "dimensionUnit": {
      "handle": "inch",
      "abbreviatedHandle": "in"
    },
    "dimensionalWeight": 0,
    "images": [
      {
        "listingParentId": 0,
        "listingVariantId": 0,
        "md5Checksum": "string",
        "id": 0,
        "url": "string",
        "sortOrder": 0,
        "createdAt": "2026-04-20T00:00:00Z",
        "publishedAt": "2026-04-20T00:00:00Z",
        "staticContentUpdatedAt": "2026-04-20T00:00:00Z",
        "staticContentSyncedAt": "2026-04-20T00:00:00Z",
        "dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
        "dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
        "publishing": true,
        "externalListingId": "string",
        "listingError": "string",
        "productParentImageId": 0,
        "productVariantImageId": 0
      }
    ],
    "options": [
      {
        "listingParentOptionId": 0,
        "globalOptionValueId": 0,
        "listingVariantId": 0,
        "id": 0,
        "name": "string",
        "value": "string",
        "position": 0,
        "globalPosition": 0
      }
    ],
    "channelId": 0,
    "productVariantId": 0,
    "externalListingId": "string",
    "publishError": "string",
    "syncError": "string",
    "pausedAt": "2026-04-20T00:00:00Z",
    "staticContentUpdatedAt": "2026-04-20T00:00:00Z",
    "staticContentSyncedAt": "2026-04-20T00:00:00Z",
    "dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
    "dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
    "linkAttemptedAt": "2026-04-20T00:00:00Z",
    "linkedToRegularProduct": true,
    "externalReferenceId": "string",
    "externalReferenceIdType": "string",
    "listingStatus": {
      "id": 0,
      "handle": "not_listed",
      "name": "string"
    },
    "changeToListingStatus": {
      "id": 0,
      "handle": "not_listed",
      "name": "string"
    },
    "listingParent": {
      "id": 0,
      "accountId": 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,
        "productCategory": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "channelId": 0,
        "productCategoryId": 0
      },
      "categoryTwo": {
        "accountId": 0,
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "customized": true,
        "id": 0,
        "name": "string",
        "parentCategoryId": 0,
        "productCategory": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "channelId": 0,
        "productCategoryId": 0
      },
      "categoryThree": {
        "accountId": 0,
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "customized": true,
        "id": 0,
        "name": "string",
        "parentCategoryId": 0,
        "productCategory": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "channelId": 0,
        "productCategoryId": 0
      },
      "images": [
        {
          "listingParentId": null,
          "listingVariantId": null,
          "md5Checksum": null,
          "id": null,
          "url": null,
          "sortOrder": null,
          "createdAt": null,
          "publishedAt": null,
          "staticContentUpdatedAt": null,
          "staticContentSyncedAt": null,
          "dynamicContentUpdatedAt": null,
          "dynamicCOntentSyncedAt": null,
          "publishing": null,
          "externalListingId": null,
          "listingError": null,
          "productParentImageId": null,
          "productVariantImageId": null
        }
      ],
      "options": [
        {
          "listingParentId": null,
          "globalOptionId": null,
          "id": null,
          "name": 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,
          "listingParentId": null,
          "price": null,
          "salePrice": null,
          "estimatedShippingCost": null,
          "estimatedDropshipFee": null,
          "inventoryListPrice": null,
          "imagesFetched": null,
          "builtWithMappingTemplateId": null,
          "builtAt": null,
          "rebuiltAt": null,
          "id": null,
          "accountId": null,
          "sku": null,
          "masterSku": 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,
          "weightUnit": null,
          "dimensionUnit": null,
          "dimensionalWeight": null,
          "images": null,
          "options": null,
          "channelId": null,
          "productVariantId": null,
          "externalListingId": null,
          "publishError": null,
          "syncError": null,
          "pausedAt": null,
          "staticContentUpdatedAt": null,
          "staticContentSyncedAt": null,
          "dynamicContentUpdatedAt": null,
          "dynamicContentSyncedAt": null,
          "linkAttemptedAt": null,
          "linkedToRegularProduct": null,
          "externalReferenceId": null,
          "externalReferenceIdType": null,
          "listingStatus": null,
          "changeToListingStatus": null,
          "listingParent": null,
          "customAggregateFields": null,
          "scheduledToDeleteAt": null,
          "profit": null,
          "profitPercentage": null,
          "profitWithFees": null,
          "profitWithFeesPercentage": null,
          "customFields": null,
          "tags": null,
          "description": null,
          "requiresFfl": null,
          "imageFetcherEventTriggered": null,
          "priceProtection": null,
          "linkedSourceCount": null
        }
      ],
      "categoryOneId": 0,
      "categoryTwoId": 0,
      "categoryThreeId": 0,
      "imagesFetched": true,
      "builtWithMappingTemplateId": 0,
      "builtAt": "2026-04-20T00:00:00Z",
      "rebuiltAt": "2026-04-20T00:00:00Z",
      "channelId": 0,
      "productParentId": 0,
      "externalListingId": "string",
      "publishError": "string",
      "syncError": "string",
      "staticContentUpdatedAt": "2026-04-20T00:00:00Z",
      "staticContentSyncedAt": "2026-04-20T00:00:00Z",
      "linkAttemptedAt": "2026-04-20T00:00:00Z",
      "listingStatus": {
        "id": 0,
        "handle": "not_listed",
        "name": "string"
      },
      "changeToListingStatus": {
        "id": 0,
        "handle": "not_listed",
        "name": "string"
      },
      "pausedAt": "2026-04-20T00:00:00Z",
      "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
      "tags": [
        "string"
      ],
      "imageFetcherEventTriggered": true
    },
    "customAggregateFields": [
      {
        "id": 0,
        "listingVariantId": 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",
    "profit": 0,
    "profitPercentage": 0,
    "profitWithFees": 0,
    "profitWithFeesPercentage": 0,
    "customFields": [
      {
        "id": 0,
        "customFieldValueId": 0,
        "customFieldId": 0,
        "name": "string",
        "value": "string",
        "originalInventoryName": "string",
        "originalInventoryValue": "string",
        "mergeToCustomFieldId": 0,
        "mergeToCustomFieldName": "string",
        "mergeToCustomFieldValueId": 0,
        "mergeToCustomFieldValue": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "description": "string",
    "requiresFfl": true,
    "imageFetcherEventTriggered": true,
    "priceProtection": true,
    "linkedSourceCount": 0
  }
]
401Unauthorized

No schema documented for this status.

OpenAPI fragment
{
  "get": {
    "summary": "Get Listing Variants",
    "description": "This endpoint will fetch back a list of Listing Variants! If you're a new integrator, it's recommended to read the `Integrating as a Channel` guide.",
    "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": "integer"
        },
        "in": "query",
        "name": "channelId",
        "description": "This will be automatically populated for Channel API Tokens. Required if using an Account API Token"
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time"
        },
        "in": "query",
        "name": "updatedAfter",
        "description": "Only retrieves back listing variants that hae been updated after the date specified"
      },
      {
        "schema": {
          "type": "string",
          "format": "date-time"
        },
        "in": "query",
        "name": "basicsUpdatedAfter",
        "description": "Only retrieves back listing variants that have had basic info updated after the date specified. \n\n This includes primary fields like `price` and `quantity`"
      },
      {
        "schema": {
          "type": "boolean"
        },
        "in": "query",
        "name": "sync",
        "description": "Read our API Guides to learn about this flag. Passing `true` requires you to respond for the interaction."
      },
      {
        "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",
            "format": "int64"
          }
        },
        "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",
          "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": "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": "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."
      },
      {
        "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": "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. "
      },
      {
        "name": "includeOverwrites",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        },
        "description": "will include dynamic prices and quantities if they are overwritten with fixed values"
      },
      {
        "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/ListingVariant"
              }
            }
          }
        }
      },
      "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