FlxpointAPI Help CenterBeta

Create/Update Listing Variant

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

Use this when you want to create 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.

Create/Update a listing variant

Request

Query parameters
  • restrictCreateOrUpdatequerystring

    [Optional] When using a endpoint that can create or update products by SKU, use this parameter to restrict the endpoint to perform only a creation or only an update based on the existence of that SKU. If you pass `createOnly` and the SKU exists nothing will be updated, and if you pass `updateOnly` and the SKU doesn't exist nothing will be created.

    allowedcreateOnlyupdateOnly
  • modifyContentquerystring

    Should content fields of the parent/variant be modified

    allowednoneupdateupdateNonNull
  • modifyIdentifiersquerystring

    Should identifier fields (ie Master SKU, UPC, MPN, GTIN, ASIN, Reference Identifier) of the variant be modified

    allowednoneupdateupdateNonNull
  • modifyDimensionsquerystring

    Should dimension fields (ie weight, length, width, height) of the variant be modified

    allowednoneupdateupdateNonNull
  • modifyOptionsquerystring

    Should options of the parent/variant be modified

    allowednoneupdatemergedeleteIncludeddeleteAll
  • modifyImagesquerystring

    Should images of the parent/variant be modified

    allowednoneupdatemergedeleteIncludeddeleteAll
  • modifyQuantityOverwritequerystring

    Should the quantity overwrite be updated? Use in combination with the quantityOverwrite object and associated variant quantity field(s) to overwrite any to a locked value or to remove any overwrites.

    allowednoneupdatedeleteupdateNonNull
  • modifyPriceOverwritequerystring

    Should the price overwrite be updated? Use in combination with the priceOverwrite object and associated variant pricing field(s) to overwrite any to a locked value or to remove any overwrite(s)..

    allowednoneupdateupdateNonNulldelete
  • modifyPublishDataquerystring

    Should publish fields (ie `publishError`, `staticContentUpdatedAt`, `staticContentSyncedAt`) of the parent/variant be modified

    allowednoneupdateupdateNonNull
  • modifySyncDataquerystring

    Should sync fields (ie `syncError`, `dynamicContentUpdatedAt`, `dynamicContentSyncedAt`) of the parent/variant be modified

    allowednoneupdateupdateNonNull
  • modifyStatusDataquerystring

    Should status fields (ie `pausedAt`, `listingStatusId`, `changeToListingStatusId`, `scheduledToDeleteAt`) of the parent/variant be modified

    allowednoneupdateupdateNonNull
  • modifyChannelDataquerystring

    Should channel related fields (ie `externalLIstingId`, `linkAttemptedAt`, `linkedToRegularProduct`, `externalReferenceId`, `externalReferenceIdType`) of the parent/variant be modified

    allowednoneupdateupdateNonNull
  • modifyVariantCustomFieldsquerystring

    Should custom fields of the variant be modified

    allowednoneupdatemergedeleteIncludeddeleteAll
  • modifyRequiresFflquerystring

    Should the `requiresFfl` field be modified

    allowednoneupdateupdateNonNull
Bodyapplication/json
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
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
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]
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]
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
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 request

post/listing/variants
curl -X POST "https://api.flxpoint.com/listing/variants" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "priceOverwrite": {
           "priceOverwritten": true,
           "costOverwritten": true,
           "msrpOverwritten": true,
           "mapOverwritten": true,
           "shippingCostOverwritten": true,
           "dropshipFeeOverwritten": true,
           "dynamicPrice": 0,
           "dynamicCost": 0,
           "dynamicMsrp": 0,
           "dynamicMap": 0,
           "dynamicShippingCost": 0,
           "dynamicDropshipFee": 0
         },
         "quantityOverwrite": {
           "quantityOverwritten": true,
           "dynamicQuantity": 0,
           "orderVolumeProtectionLockedAt": "string",
           "lastManualQuantity": 0,
           "isLockedByOrderVolumeProtection": true
         },
         "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": 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
             }
           ],
           "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
               ],
               "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
             }
           ],
           "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": 0,
               "aggregateFieldDataTypeId": 0,
               "customAggregateFieldOptionId": 0,
               "name": "string",
               "handle": "string",
               "ignoreOutOfStock": true,
               "accountId": 0
             },
             "name": "string",
             "value": 0,
             "customAggregateFieldId": 0
           }
         ],
         "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
         "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
       }'
Example body · application/json
{
  "priceOverwrite": {
    "priceOverwritten": true,
    "costOverwritten": true,
    "msrpOverwritten": true,
    "mapOverwritten": true,
    "shippingCostOverwritten": true,
    "dropshipFeeOverwritten": true,
    "dynamicPrice": 0,
    "dynamicCost": 0,
    "dynamicMsrp": 0,
    "dynamicMap": 0,
    "dynamicShippingCost": 0,
    "dynamicDropshipFee": 0
  },
  "quantityOverwrite": {
    "quantityOverwritten": true,
    "dynamicQuantity": 0,
    "orderVolumeProtectionLockedAt": "string",
    "lastManualQuantity": 0,
    "isLockedByOrderVolumeProtection": true
  },
  "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": 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
      }
    ],
    "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
        ],
        "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
      }
    ],
    "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": 0,
        "aggregateFieldDataTypeId": 0,
        "customAggregateFieldOptionId": 0,
        "name": "string",
        "handle": "string",
        "ignoreOutOfStock": true,
        "accountId": 0
      },
      "name": "string",
      "value": 0,
      "customAggregateFieldId": 0
    }
  ],
  "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
  "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
}

Responses

200OK - Existing variant was updated OR the `restrictCreateOrUpdate` param was provided with a value of `createOnly` and the variant already existed in which case nothing was modified and the existing variant will be returned.application/json
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
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
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]
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]
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
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": 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
      }
    ],
    "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
        ],
        "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
      }
    ],
    "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": 0,
        "aggregateFieldDataTypeId": 0,
        "customAggregateFieldOptionId": 0,
        "name": "string",
        "handle": "string",
        "ignoreOutOfStock": true,
        "accountId": 0
      },
      "name": "string",
      "value": 0,
      "customAggregateFieldId": 0
    }
  ],
  "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
  "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
}
201CREATED - A new variant was createdapplication/json
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
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
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]
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]
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
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": 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
      }
    ],
    "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
        ],
        "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
      }
    ],
    "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": 0,
        "aggregateFieldDataTypeId": 0,
        "customAggregateFieldOptionId": 0,
        "name": "string",
        "handle": "string",
        "ignoreOutOfStock": true,
        "accountId": 0
      },
      "name": "string",
      "value": 0,
      "customAggregateFieldId": 0
    }
  ],
  "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
  "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
}
204NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the variant listing does not exist. This will return an empty/null response body.application/json
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
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
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]
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]
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
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": 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
      }
    ],
    "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
        ],
        "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
      }
    ],
    "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": 0,
        "aggregateFieldDataTypeId": 0,
        "customAggregateFieldOptionId": 0,
        "name": "string",
        "handle": "string",
        "ignoreOutOfStock": true,
        "accountId": 0
      },
      "name": "string",
      "value": 0,
      "customAggregateFieldId": 0
    }
  ],
  "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
  "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
}
400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

409Conflict - If the SKU provided already exists on a different variant a conflict will be returnedapplication/json
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
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
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]
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]
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
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": 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
      }
    ],
    "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
        ],
        "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
      }
    ],
    "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": 0,
        "aggregateFieldDataTypeId": 0,
        "customAggregateFieldOptionId": 0,
        "name": "string",
        "handle": "string",
        "ignoreOutOfStock": true,
        "accountId": 0
      },
      "name": "string",
      "value": 0,
      "customAggregateFieldId": 0
    }
  ],
  "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
  "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
}
OpenAPI fragment
{
  "post": {
    "summary": "Create/Update Listing Variant",
    "description": "Create/Update a listing variant",
    "parameters": [
      {
        "name": "restrictCreateOrUpdate",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "createOnly",
            "updateOnly"
          ]
        },
        "description": "[Optional] When using a endpoint that can create or update products by SKU, use this parameter to restrict the endpoint to perform only a creation or only an update based on the existence of that SKU. If you pass `createOnly` and the SKU exists nothing will be updated, and if you pass `updateOnly` and the SKU doesn't exist nothing will be created."
      },
      {
        "name": "modifyContent",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "description": "Should content fields of the parent/variant be modified"
      },
      {
        "name": "modifyIdentifiers",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "description": "Should identifier fields (ie Master SKU, UPC, MPN, GTIN, ASIN, Reference Identifier) of the variant be modified"
      },
      {
        "name": "modifyDimensions",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "description": "Should dimension fields (ie weight, length, width, height) of the variant be modified"
      },
      {
        "name": "modifyOptions",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "merge",
            "deleteIncluded",
            "deleteAll"
          ]
        },
        "description": "Should options of the parent/variant be modified"
      },
      {
        "name": "modifyImages",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "merge",
            "deleteIncluded",
            "deleteAll"
          ]
        },
        "description": "Should images of the parent/variant be modified"
      },
      {
        "name": "modifyQuantityOverwrite",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "delete",
            "updateNonNull"
          ]
        },
        "description": "Should the quantity overwrite be updated?  Use in combination with the quantityOverwrite object and associated variant quantity field(s) to overwrite any to a locked value or to remove any overwrites."
      },
      {
        "name": "modifyPriceOverwrite",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull",
            "delete"
          ]
        },
        "description": "Should the price overwrite be updated?  Use in combination with the priceOverwrite object and associated variant pricing field(s) to overwrite any to a locked value or to remove any overwrite(s).."
      },
      {
        "name": "modifyPublishData",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "allowEmptyValue": true,
        "description": "Should publish fields (ie `publishError`, `staticContentUpdatedAt`, `staticContentSyncedAt`) of the parent/variant be modified"
      },
      {
        "name": "modifySyncData",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "allowEmptyValue": true,
        "description": "Should sync fields (ie `syncError`, `dynamicContentUpdatedAt`, `dynamicContentSyncedAt`) of the parent/variant be modified"
      },
      {
        "name": "modifyStatusData",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "allowEmptyValue": true,
        "description": "Should status fields (ie `pausedAt`, `listingStatusId`, `changeToListingStatusId`, `scheduledToDeleteAt`) of the parent/variant be modified"
      },
      {
        "name": "modifyChannelData",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "allowEmptyValue": true,
        "description": "Should channel related fields (ie `externalLIstingId`, `linkAttemptedAt`, `linkedToRegularProduct`, `externalReferenceId`, `externalReferenceIdType`) of the parent/variant be modified"
      },
      {
        "name": "modifyVariantCustomFields",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "merge",
            "deleteIncluded",
            "deleteAll"
          ]
        },
        "description": "Should custom fields of the variant be modified"
      },
      {
        "name": "modifyRequiresFfl",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "updateNonNull"
          ]
        },
        "description": "Should the `requiresFfl` field be modified"
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListingVariantCreateUpdateRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK - Existing variant was updated OR the `restrictCreateOrUpdate` param was provided with a value of `createOnly` and the variant already existed in which case nothing was modified and the existing variant will be returned.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ListingVariant"
            }
          }
        },
        "headers": {}
      },
      "201": {
        "description": "CREATED - A new variant was created",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ListingVariant"
            }
          }
        }
      },
      "204": {
        "description": "NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the variant listing does not exist. This will return an empty/null response body.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ListingVariant"
            }
          }
        }
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "409": {
        "description": "Conflict - If the SKU provided already exists on a different variant a conflict will be returned",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ListingVariant"
            }
          }
        }
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight