FlxpointBeta

[Deprecated] Get Listing Pair

gethttps://api.flxpoint.com/listing/variants/{variantId}/pairDeprecated

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 is deprecated. Instead, we'd encourage you to use :

`GET /listing/variants/{id}` and pass `includeParent` flag

Request

Example request

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

Responses

200OKapplication/json
parentobjectrequired
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
sizeinteger (int64)
compressedboolean
widthinteger
heightinteger
sharedImageboolean
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
sizeinteger (int64)
compressedboolean
widthinteger
heightinteger
sharedImageboolean
optionsarray[ListingVariantOption]
listingParentOptionIdinteger
globalOptionValueIdinteger (int64)
listingVariantIdinteger
idinteger
namestringrequired
valuestringrequired
positioninteger
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. Configured at the product level and unchangeable.
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
inventoryCategoryInventoryCategory
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
inventoryCategoryInventoryCategory
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
inventoryCategoryInventoryCategory
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
sizeinteger (int64)
compressedboolean
widthinteger
heightinteger
sharedImageboolean
optionsarray[ListingParentOption]
listingParentIdinteger
globalOptionIdinteger (int64)
idinteger
namestringrequired
optionValuesarray[OptionValue]
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]
priceOverwritePriceOverwrite
quantityOverwriteQuantityOverwrite
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
weightUnitWeightUnit
dimensionUnitDimensionUnit
dimensionalWeightnumber
imagesarray[ListingImage]
optionsarray[ListingVariantOption]
bundleboolean
Indicates if this variant is a bundle. Configured at the product level and unchangeable.
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
listingStatusListingStatus
changeToListingStatusListingStatus
listingParentListingParent
customAggregateFieldsarray[ListingVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
profitnumber
profitPercentagenumber
profitWithFeesnumber
profitWithFeesPercentagenumber
customFieldsarray[ListingVariantCustomField]
tagsarray[string]
Attach-only: tags listed here are added to the variant (created if missing). Tags are never removed by this endpoint - use PATCH /product/variants/{variantId}/tags (or /listing/variants/{variantId}/tags) to remove.
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
locationsarray[ListingChannelLocation]
inventoryLinksarray[ListingInventoryLink]
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]
Attach-only: tags listed here are added to the variant (created if missing). Tags are never removed by this endpoint - use PATCH /product/variants/{variantId}/tags (or /listing/variants/{variantId}/tags) to remove.
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
locationsarray[ListingChannelLocation]
channelLocationExternalIdstring
ID for the Channel Location. Can be found via the `channelLocations` array on the [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/channelLocations`).
sourceIdinteger (int32)
ID for the [Source](#/components/schemas/Source) that fulfills the `inventoryVariantId`.
inventoryVariantIdinteger (int64)
The [Inventory Variant](#/components/schemas/InventoryVariant) ID that is being used for this location.
quantityinteger (int32)
The quantity available from the inventory variant for this location after applying any minimum quantity filters configured in the MLI settings for this channel & location. Can be null if there is no inventory connected.
inventoryLinksarray[ListingInventoryLink]
sourceIdinteger (int32)
ID for the [Source](#/components/schemas/Source) that fulfills the `inventoryVariantId`.
inventoryVariantIdinteger (int64)
The [Inventory Variant](#/components/schemas/InventoryVariant) ID that is being used for this location.
enabledboolean
Was the source for this inventory link enabled in the channel listing strategy settings allowing this inventory variant to participate in quantity and cost calculations.
wonboolean
Did this inventory variant win the best vendor selection. Never populated unless using Best Vendor listing strategy.
quantityinteger (int32)
The quantity available from the inventory variant after applying any optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`).
originalQuantityinteger (int32)
The quantity available from the inventory variant before applying any optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`).
minimumQuantityinteger (int32)
The optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`) that applied for this source and inventory variant.
costnumber
The cost to fulfill the inventory variant
msrpnumber
The inventory variants MSRP
mapnumber
The inventory variants MAP
shippingCostnumber
The cost to ship the inventory variant
dropshipFeenumber
The dropship fee to fulfill the inventory variant
totalCostnumber
The total cost to fulfill the inventory variant. Total cost is `cost + shipping cost + dropship fee`.
inventoryListPricenumber
archivedboolean
If the inventory variant is archived and therefore unfilfillable.
channelLocationExternalIdstring
ID for the Channel Location. Only populated when the listing is in a channel that uses a MLI listing strategy and the inventory link is associated to a source that is associated to a channel location. Can be found via the `channelLocations` array on the [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/channelLocations`).
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
variantobjectrequired
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
sizeinteger (int64)
compressedboolean
widthinteger
heightinteger
sharedImageboolean
optionsarray[ListingVariantOption]
listingParentOptionIdinteger
globalOptionValueIdinteger (int64)
listingVariantIdinteger
idinteger
namestringrequired
valuestringrequired
positioninteger
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. Configured at the product level and unchangeable.
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
sizeinteger (int64)
compressedboolean
widthinteger
heightinteger
sharedImageboolean
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
sizeinteger (int64)
compressedboolean
widthinteger
heightinteger
sharedImageboolean
optionsarray[ListingVariantOption]
listingParentOptionIdinteger
globalOptionValueIdinteger (int64)
listingVariantIdinteger
idinteger
namestringrequired
valuestringrequired
positioninteger
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. Configured at the product level and unchangeable.
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]
Attach-only: tags listed here are added to the variant (created if missing). Tags are never removed by this endpoint - use PATCH /product/variants/{variantId}/tags (or /listing/variants/{variantId}/tags) to remove.
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
locationsarray[ListingChannelLocation]
channelLocationExternalIdstring
ID for the Channel Location. Can be found via the `channelLocations` array on the [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/channelLocations`).
sourceIdinteger (int32)
ID for the [Source](#/components/schemas/Source) that fulfills the `inventoryVariantId`.
inventoryVariantIdinteger (int64)
The [Inventory Variant](#/components/schemas/InventoryVariant) ID that is being used for this location.
quantityinteger (int32)
The quantity available from the inventory variant for this location after applying any minimum quantity filters configured in the MLI settings for this channel & location. Can be null if there is no inventory connected.
inventoryLinksarray[ListingInventoryLink]
sourceIdinteger (int32)
ID for the [Source](#/components/schemas/Source) that fulfills the `inventoryVariantId`.
inventoryVariantIdinteger (int64)
The [Inventory Variant](#/components/schemas/InventoryVariant) ID that is being used for this location.
enabledboolean
Was the source for this inventory link enabled in the channel listing strategy settings allowing this inventory variant to participate in quantity and cost calculations.
wonboolean
Did this inventory variant win the best vendor selection. Never populated unless using Best Vendor listing strategy.
quantityinteger (int32)
The quantity available from the inventory variant after applying any optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`).
originalQuantityinteger (int32)
The quantity available from the inventory variant before applying any optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`).
minimumQuantityinteger (int32)
The optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`) that applied for this source and inventory variant.
costnumber
The cost to fulfill the inventory variant
msrpnumber
The inventory variants MSRP
mapnumber
The inventory variants MAP
shippingCostnumber
The cost to ship the inventory variant
dropshipFeenumber
The dropship fee to fulfill the inventory variant
totalCostnumber
The total cost to fulfill the inventory variant. Total cost is `cost + shipping cost + dropship fee`.
inventoryListPricenumber
archivedboolean
If the inventory variant is archived and therefore unfilfillable.
channelLocationExternalIdstring
ID for the Channel Location. Only populated when the listing is in a channel that uses a MLI listing strategy and the inventory link is associated to a source that is associated to a channel location. Can be found via the `channelLocations` array on the [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/channelLocations`).
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]
Attach-only: tags listed here are added to the variant (created if missing). Tags are never removed by this endpoint - use PATCH /product/variants/{variantId}/tags (or /listing/variants/{variantId}/tags) to remove.
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
locationsarray[ListingChannelLocation]
channelLocationExternalIdstring
ID for the Channel Location. Can be found via the `channelLocations` array on the [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/channelLocations`).
sourceIdinteger (int32)
ID for the [Source](#/components/schemas/Source) that fulfills the `inventoryVariantId`.
inventoryVariantIdinteger (int64)
The [Inventory Variant](#/components/schemas/InventoryVariant) ID that is being used for this location.
quantityinteger (int32)
The quantity available from the inventory variant for this location after applying any minimum quantity filters configured in the MLI settings for this channel & location. Can be null if there is no inventory connected.
inventoryLinksarray[ListingInventoryLink]
sourceIdinteger (int32)
ID for the [Source](#/components/schemas/Source) that fulfills the `inventoryVariantId`.
inventoryVariantIdinteger (int64)
The [Inventory Variant](#/components/schemas/InventoryVariant) ID that is being used for this location.
enabledboolean
Was the source for this inventory link enabled in the channel listing strategy settings allowing this inventory variant to participate in quantity and cost calculations.
wonboolean
Did this inventory variant win the best vendor selection. Never populated unless using Best Vendor listing strategy.
quantityinteger (int32)
The quantity available from the inventory variant after applying any optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`).
originalQuantityinteger (int32)
The quantity available from the inventory variant before applying any optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`).
minimumQuantityinteger (int32)
The optional minimum quantity filters configured in the channels listing strategy [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/listingStrategy`) that applied for this source and inventory variant.
costnumber
The cost to fulfill the inventory variant
msrpnumber
The inventory variants MSRP
mapnumber
The inventory variants MAP
shippingCostnumber
The cost to ship the inventory variant
dropshipFeenumber
The dropship fee to fulfill the inventory variant
totalCostnumber
The total cost to fulfill the inventory variant. Total cost is `cost + shipping cost + dropship fee`.
inventoryListPricenumber
archivedboolean
If the inventory variant is archived and therefore unfilfillable.
channelLocationExternalIdstring
ID for the Channel Location. Only populated when the listing is in a channel that uses a MLI listing strategy and the inventory link is associated to a source that is associated to a channel location. Can be found via the `channelLocations` array on the [Channel](#/components/schemas/Channel) schema (`#/components/schemas/Channel/properties/channelLocations`).
Example response
{
  "parent": {
    "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": 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
        }
      },
      "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": 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
        }
      },
      "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": 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
        }
      },
      "channelId": 0,
      "productCategoryId": 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,
        "size": 0,
        "compressed": true,
        "width": 0,
        "height": 0,
        "sharedImage": true
      }
    ],
    "options": [
      {
        "listingParentId": 0,
        "globalOptionId": 0,
        "id": 0,
        "name": "string",
        "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
        },
        "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": null,
          "abbreviatedHandle": null
        },
        "dimensionUnit": {
          "handle": null,
          "abbreviatedHandle": null
        },
        "dimensionalWeight": 0,
        "images": [
          null
        ],
        "options": [
          null
        ],
        "bundle": true,
        "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": null,
          "handle": null,
          "name": null
        },
        "changeToListingStatus": {
          "id": null,
          "handle": null,
          "name": null
        },
        "listingParent": {
          "id": null,
          "accountId": 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,
          "builtWithMappingTemplateId": null,
          "builtAt": null,
          "rebuiltAt": null,
          "channelId": null,
          "productParentId": null,
          "externalListingId": null,
          "publishError": null,
          "syncError": null,
          "staticContentUpdatedAt": null,
          "staticContentSyncedAt": null,
          "linkAttemptedAt": null,
          "listingStatus": null,
          "changeToListingStatus": null,
          "pausedAt": null,
          "scheduledToDeleteAt": null,
          "tags": null,
          "imageFetcherEventTriggered": null
        },
        "customAggregateFields": [
          null
        ],
        "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
        "profit": 0,
        "profitPercentage": 0,
        "profitWithFees": 0,
        "profitWithFeesPercentage": 0,
        "customFields": [
          null
        ],
        "tags": [
          null
        ],
        "description": "string",
        "requiresFfl": true,
        "imageFetcherEventTriggered": true,
        "priceProtection": true,
        "linkedSourceCount": 0,
        "locations": [
          null
        ],
        "inventoryLinks": [
          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
  },
  "variant": {
    "priceOverwrite": {
      "priceOverwritten": true,
      "costOverwritten": true,
      "msrpOverwritten": true,
      "mapOverwritten": true,
      "shippingCostOverwritten": true,
      "dropshipFeeOverwritten": true,
      "dynamicPrice": 0,
      "dynamicCost": 0,
      "dynamicMsrp": 0,
      "dynamicMap": 0,
      "dynamicShippingCost": 0,
      "dynamicDropshipFee": 0
    },
    "quantityOverwrite": {
      "quantityOverwritten": true,
      "dynamicQuantity": 0,
      "orderVolumeProtectionLockedAt": "string",
      "lastManualQuantity": 0,
      "isLockedByOrderVolumeProtection": true
    },
    "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,
        "size": 0,
        "compressed": true,
        "width": 0,
        "height": 0,
        "sharedImage": true
      }
    ],
    "options": [
      {
        "listingParentOptionId": 0,
        "globalOptionValueId": 0,
        "listingVariantId": 0,
        "id": 0,
        "name": "string",
        "value": "string",
        "position": 0,
        "globalPosition": 0
      }
    ],
    "bundle": true,
    "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,
          "size": null,
          "compressed": null,
          "width": null,
          "height": null,
          "sharedImage": 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,
          "bundle": 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,
          "locations": null,
          "inventoryLinks": 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,
    "locations": [
      {
        "channelLocationExternalId": "2039203-230923",
        "sourceId": 123,
        "inventoryVariantId": 23423423234234,
        "quantity": 5
      }
    ],
    "inventoryLinks": [
      {
        "sourceId": 123,
        "inventoryVariantId": 23423423234234,
        "enabled": true,
        "won": true,
        "quantity": 0,
        "originalQuantity": 25,
        "minimumQuantity": 20,
        "cost": 4.99,
        "msrp": 8.99,
        "map": 7.99,
        "shippingCost": 4,
        "dropshipFee": 2,
        "totalCost": 10.99,
        "inventoryListPrice": 0,
        "archived": true,
        "channelLocationExternalId": "2039203-230923"
      }
    ]
  }
}
401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment
{
  "get": {
    "summary": "[Deprecated] Get Listing Pair",
    "description": "This endpoint is deprecated. Instead, we'd encourage you to use : \n\n`GET /listing/variants/{id}` and pass `includeParent` flag",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ListingPair"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight