FlxpointAPI Help CenterBeta

Create/Update Product Parent

posthttps://api.flxpoint.com/product/products/parent

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

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

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

Create/Update a product parent

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

    Should options of the parent/variant be modified

    allowednoneupdatemergedeleteIncludeddeleteAll
  • modifyImagesquerystring

    Should images of the parent/variant be modified

    allowednoneupdatemergedeleteIncludeddeleteAll
  • modifyAttributesquerystring

    Should attributes of the parent be modified

    allowednoneupdatemergedeleteIncludeddeleteAll
  • modifyCustomFieldsquerystring

    Should custom fields of the parent be modified

    allowednoneupdatemergedeleteIncludeddeleteAll
  • modifyCategoriesquerystring

    Should categories of the parent be modified

    allowednoneupdatedelete
Bodyapplication/json
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
idinteger
optionIdinteger
valuestring
positioninteger
globalPositioninteger
globalOptionValueIdinteger (int64)
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]deprecated
DEPRECATED : Variants included in this call will not be updated. You need to use the dedicated variant endpoint to update these. Currently if you pass variants here we will return them unmodified, however, in the future this property will be removed completely so you should not code in a way that is dependent on this functionality.
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
componentQuantityintegerrequired
componentProductVariantobject
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldobject
idinteger
aggregateFieldDataTypeIdinteger
customAggregateFieldOptionIdinteger
namestring
handlestring
ignoreOutOfStockboolean
default false
accountIdinteger
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)

Example request

post/product/products/parent
curl -X POST "https://api.flxpoint.com/product/products/parent" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "id": 0,
         "sku": "string",
         "title": "string",
         "description": "string",
         "manufacturer": "string",
         "insertedAt": "2026-04-20T00:00:00Z",
         "updatedAt": "2026-04-20T00:00:00Z",
         "archived": true,
         "categoryOne": {
           "accountId": 0,
           "insertedAt": "2026-04-20T00:00:00Z",
           "updatedAt": "2026-04-20T00:00:00Z",
           "customized": true,
           "id": 0,
           "name": "string",
           "parentCategoryId": 0,
           "inventoryCategory": {
             "sourceId": 0,
             "productCategoryId": 0,
             "id": 0,
             "name": "string",
             "excluded": true,
             "parentCategoryId": 0
           }
         },
         "categoryTwo": {
           "accountId": 0,
           "insertedAt": "2026-04-20T00:00:00Z",
           "updatedAt": "2026-04-20T00:00:00Z",
           "customized": true,
           "id": 0,
           "name": "string",
           "parentCategoryId": 0,
           "inventoryCategory": {
             "sourceId": 0,
             "productCategoryId": 0,
             "id": 0,
             "name": "string",
             "excluded": true,
             "parentCategoryId": 0
           }
         },
         "categoryThree": {
           "accountId": 0,
           "insertedAt": "2026-04-20T00:00:00Z",
           "updatedAt": "2026-04-20T00:00:00Z",
           "customized": true,
           "id": 0,
           "name": "string",
           "parentCategoryId": 0,
           "inventoryCategory": {
             "sourceId": 0,
             "productCategoryId": 0,
             "id": 0,
             "name": "string",
             "excluded": true,
             "parentCategoryId": 0
           }
         },
         "images": [
           {
             "productParentId": 0,
             "productVariantId": 0,
             "md5Checksum": "string",
             "originalUrl": "string",
             "fetched": true,
             "fetchAttempts": 0,
             "archived": true,
             "id": 0,
             "url": "string",
             "sortOrder": 0
           }
         ],
         "options": [
           {
             "productParentId": 0,
             "id": 0,
             "name": "string",
             "globalOptionId": 0,
             "optionValues": [
               {
                 "id": null,
                 "optionId": null,
                 "value": null,
                 "position": null,
                 "globalPosition": null,
                 "globalOptionValueId": 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": true,
               "costOverwritten": true,
               "msrpOverwritten": true,
               "mapOverwritten": true,
               "shippingCostOverwritten": true,
               "dropshipFeeOverwritten": true,
               "dynamicPrice": 0,
               "dynamicCost": 0,
               "dynamicMsrp": 0,
               "dynamicMap": 0,
               "dynamicShippingCost": 0,
               "dynamicDropshipFee": 0
             },
             "quantityOverwrite": {
               "quantityOverwritten": true,
               "dynamicQuantity": 0,
               "orderVolumeProtectionLockedAt": "string",
               "lastManualQuantity": 0,
               "isLockedByOrderVolumeProtection": true
             },
             "productParentId": 0,
             "price": 0,
             "salePrice": 0,
             "estimatedShippingCost": 0,
             "estimatedDropshipFee": 0,
             "inventoryListPrice": 0,
             "imagesFetched": true,
             "productBuilderId": 0,
             "builtWithMappingTemplateId": 0,
             "builtAt": "2026-04-20T00:00:00Z",
             "rebuiltAt": "2026-04-20T00:00:00Z",
             "inventoryLinks": [
               {
                 "id": null,
                 "productVariantId": null,
                 "inventoryVariantId": null
               }
             ],
             "productAlternatives": [
               {
                 "id": null,
                 "sku": null,
                 "title": null,
                 "quantity": null,
                 "cost": null,
                 "price": null,
                 "image": null,
                 "parentId": null
               }
             ],
             "referenceIdentifier": "string",
             "id": 0,
             "sku": "string",
             "title": "string",
             "mpn": "string",
             "upc": "string",
             "ean": "string",
             "asin": "string",
             "msrp": 0,
             "map": 0,
             "weight": 0,
             "length": 0,
             "width": 0,
             "height": 0,
             "insertedAt": "2026-04-20T00:00:00Z",
             "updatedAt": "2026-04-20T00:00:00Z",
             "archived": true,
             "cost": 0,
             "quantity": 0,
             "pendingFulfillmentQuantity": 0,
             "weightUnit": {
               "handle": "pound",
               "abbreviatedHandle": "lb"
             },
             "dimensionUnit": {
               "handle": "inch",
               "abbreviatedHandle": "in"
             },
             "dimensionalWeight": 0,
             "images": [
               {
                 "productParentId": null,
                 "productVariantId": null,
                 "md5Checksum": null,
                 "originalUrl": null,
                 "fetched": null,
                 "fetchAttempts": null,
                 "archived": null,
                 "id": null,
                 "url": null,
                 "sortOrder": null
               }
             ],
             "options": [
               {
                 "productParentOptionId": null,
                 "globalOptionValueId": null,
                 "productVariantId": null,
                 "id": null,
                 "position": null,
                 "name": null,
                 "value": null,
                 "globalPosition": null
               }
             ],
             "bundle": true,
             "bundleComponents": [
               {
                 "componentQuantity": null,
                 "componentProductVariant": null,
                 "bundleProductVariantId": null,
                 "componentProductVariantId": null
               }
             ],
             "listingLinks": [
               {
                 "listingVariantId": null,
                 "channelId": null
               }
             ],
             "customAggregateFields": [
               {
                 "id": null,
                 "productVariantId": null,
                 "accountId": null,
                 "customAggregateField": null,
                 "name": null,
                 "value": null,
                 "customAggregateFieldId": null
               }
             ],
             "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
             "customFields": [
               {
                 "id": null,
                 "customFieldValueId": null,
                 "customFieldId": null,
                 "name": null,
                 "value": null,
                 "originalInventoryName": null,
                 "originalInventoryValue": null,
                 "mergeToCustomFieldId": null,
                 "mergeToCustomFieldName": null,
                 "mergeToCustomFieldValueId": null,
                 "mergeToCustomFieldValue": null
               }
             ],
             "parent": {
               "id": 0,
               "sku": "string",
               "title": "string",
               "description": "string",
               "manufacturer": "string",
               "insertedAt": "2026-04-20T00:00:00Z",
               "updatedAt": "2026-04-20T00:00:00Z",
               "archived": true,
               "categoryOne": {
                 "accountId": null,
                 "insertedAt": null,
                 "updatedAt": null,
                 "customized": null,
                 "id": null,
                 "name": null,
                 "parentCategoryId": null,
                 "inventoryCategory": null
               },
               "categoryTwo": {
                 "accountId": null,
                 "insertedAt": null,
                 "updatedAt": null,
                 "customized": null,
                 "id": null,
                 "name": null,
                 "parentCategoryId": null,
                 "inventoryCategory": null
               },
               "categoryThree": {
                 "accountId": null,
                 "insertedAt": null,
                 "updatedAt": null,
                 "customized": null,
                 "id": null,
                 "name": null,
                 "parentCategoryId": null,
                 "inventoryCategory": null
               },
               "images": [
                 null
               ],
               "options": [
                 null
               ],
               "attributes": [
                 null
               ],
               "customFields": [
                 null
               ],
               "variants": [
                 null
               ],
               "categoryOneId": 0,
               "categoryTwoId": 0,
               "categoryThreeId": 0,
               "imagesFetched": true,
               "productBuilderId": 0,
               "builtWithMappingTemplateId": 0,
               "builtAt": "2026-04-20T00:00:00Z",
               "rebuiltAt": "2026-04-20T00:00:00Z",
               "tags": [
                 null
               ],
               "listingLinks": [
                 null
               ],
               "imageFetcherEventTriggered": true
             },
             "description": "string",
             "tags": [
               "string"
             ],
             "requiresFfl": true,
             "imageFetcherEventTriggered": true,
             "linkedSourceCount": 0
           }
         ],
         "categoryOneId": 0,
         "categoryTwoId": 0,
         "categoryThreeId": 0,
         "imagesFetched": true,
         "productBuilderId": 0,
         "builtWithMappingTemplateId": 0,
         "builtAt": "2026-04-20T00:00:00Z",
         "rebuiltAt": "2026-04-20T00:00:00Z"
       }'
Example body · application/json
{
  "id": 0,
  "sku": "string",
  "title": "string",
  "description": "string",
  "manufacturer": "string",
  "insertedAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "archived": true,
  "categoryOne": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryTwo": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryThree": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "images": [
    {
      "productParentId": 0,
      "productVariantId": 0,
      "md5Checksum": "string",
      "originalUrl": "string",
      "fetched": true,
      "fetchAttempts": 0,
      "archived": true,
      "id": 0,
      "url": "string",
      "sortOrder": 0
    }
  ],
  "options": [
    {
      "productParentId": 0,
      "id": 0,
      "name": "string",
      "globalOptionId": 0,
      "optionValues": [
        {
          "id": null,
          "optionId": null,
          "value": null,
          "position": null,
          "globalPosition": null,
          "globalOptionValueId": 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": true,
        "costOverwritten": true,
        "msrpOverwritten": true,
        "mapOverwritten": true,
        "shippingCostOverwritten": true,
        "dropshipFeeOverwritten": true,
        "dynamicPrice": 0,
        "dynamicCost": 0,
        "dynamicMsrp": 0,
        "dynamicMap": 0,
        "dynamicShippingCost": 0,
        "dynamicDropshipFee": 0
      },
      "quantityOverwrite": {
        "quantityOverwritten": true,
        "dynamicQuantity": 0,
        "orderVolumeProtectionLockedAt": "string",
        "lastManualQuantity": 0,
        "isLockedByOrderVolumeProtection": true
      },
      "productParentId": 0,
      "price": 0,
      "salePrice": 0,
      "estimatedShippingCost": 0,
      "estimatedDropshipFee": 0,
      "inventoryListPrice": 0,
      "imagesFetched": true,
      "productBuilderId": 0,
      "builtWithMappingTemplateId": 0,
      "builtAt": "2026-04-20T00:00:00Z",
      "rebuiltAt": "2026-04-20T00:00:00Z",
      "inventoryLinks": [
        {
          "id": null,
          "productVariantId": null,
          "inventoryVariantId": null
        }
      ],
      "productAlternatives": [
        {
          "id": null,
          "sku": null,
          "title": null,
          "quantity": null,
          "cost": null,
          "price": null,
          "image": null,
          "parentId": null
        }
      ],
      "referenceIdentifier": "string",
      "id": 0,
      "sku": "string",
      "title": "string",
      "mpn": "string",
      "upc": "string",
      "ean": "string",
      "asin": "string",
      "msrp": 0,
      "map": 0,
      "weight": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "insertedAt": "2026-04-20T00:00:00Z",
      "updatedAt": "2026-04-20T00:00:00Z",
      "archived": true,
      "cost": 0,
      "quantity": 0,
      "pendingFulfillmentQuantity": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "dimensionalWeight": 0,
      "images": [
        {
          "productParentId": null,
          "productVariantId": null,
          "md5Checksum": null,
          "originalUrl": null,
          "fetched": null,
          "fetchAttempts": null,
          "archived": null,
          "id": null,
          "url": null,
          "sortOrder": null
        }
      ],
      "options": [
        {
          "productParentOptionId": null,
          "globalOptionValueId": null,
          "productVariantId": null,
          "id": null,
          "position": null,
          "name": null,
          "value": null,
          "globalPosition": null
        }
      ],
      "bundle": true,
      "bundleComponents": [
        {
          "componentQuantity": null,
          "componentProductVariant": null,
          "bundleProductVariantId": null,
          "componentProductVariantId": null
        }
      ],
      "listingLinks": [
        {
          "listingVariantId": null,
          "channelId": null
        }
      ],
      "customAggregateFields": [
        {
          "id": null,
          "productVariantId": null,
          "accountId": null,
          "customAggregateField": null,
          "name": null,
          "value": null,
          "customAggregateFieldId": null
        }
      ],
      "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
      "customFields": [
        {
          "id": null,
          "customFieldValueId": null,
          "customFieldId": null,
          "name": null,
          "value": null,
          "originalInventoryName": null,
          "originalInventoryValue": null,
          "mergeToCustomFieldId": null,
          "mergeToCustomFieldName": null,
          "mergeToCustomFieldValueId": null,
          "mergeToCustomFieldValue": null
        }
      ],
      "parent": {
        "id": 0,
        "sku": "string",
        "title": "string",
        "description": "string",
        "manufacturer": "string",
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "archived": true,
        "categoryOne": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryTwo": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryThree": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "images": [
          null
        ],
        "options": [
          null
        ],
        "attributes": [
          null
        ],
        "customFields": [
          null
        ],
        "variants": [
          null
        ],
        "categoryOneId": 0,
        "categoryTwoId": 0,
        "categoryThreeId": 0,
        "imagesFetched": true,
        "productBuilderId": 0,
        "builtWithMappingTemplateId": 0,
        "builtAt": "2026-04-20T00:00:00Z",
        "rebuiltAt": "2026-04-20T00:00:00Z",
        "tags": [
          null
        ],
        "listingLinks": [
          null
        ],
        "imageFetcherEventTriggered": true
      },
      "description": "string",
      "tags": [
        "string"
      ],
      "requiresFfl": true,
      "imageFetcherEventTriggered": true,
      "linkedSourceCount": 0
    }
  ],
  "categoryOneId": 0,
  "categoryTwoId": 0,
  "categoryThreeId": 0,
  "imagesFetched": true,
  "productBuilderId": 0,
  "builtWithMappingTemplateId": 0,
  "builtAt": "2026-04-20T00:00:00Z",
  "rebuiltAt": "2026-04-20T00:00:00Z"
}

Responses

200OK - Existing parent was updated OR the `restrictCreateOrUpdate` param was provided with a value of `createOnly` and the parent already existed in which case nothing was modified and the existing parent will be returned.application/json
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
idinteger
optionIdinteger
valuestring
positioninteger
globalPositioninteger
globalOptionValueIdinteger (int64)
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
componentQuantityintegerrequired
componentProductVariantobject
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldobject
idinteger
aggregateFieldDataTypeIdinteger
customAggregateFieldOptionIdinteger
namestring
handlestring
ignoreOutOfStockboolean
default false
accountIdinteger
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
Example response
{
  "id": 0,
  "sku": "string",
  "title": "string",
  "description": "string",
  "manufacturer": "string",
  "insertedAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "archived": true,
  "categoryOne": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryTwo": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryThree": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "images": [
    {
      "productParentId": 0,
      "productVariantId": 0,
      "md5Checksum": "string",
      "originalUrl": "string",
      "fetched": true,
      "fetchAttempts": 0,
      "archived": true,
      "id": 0,
      "url": "string",
      "sortOrder": 0
    }
  ],
  "options": [
    {
      "productParentId": 0,
      "id": 0,
      "name": "string",
      "globalOptionId": 0,
      "optionValues": [
        {
          "id": null,
          "optionId": null,
          "value": null,
          "position": null,
          "globalPosition": null,
          "globalOptionValueId": 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": true,
        "costOverwritten": true,
        "msrpOverwritten": true,
        "mapOverwritten": true,
        "shippingCostOverwritten": true,
        "dropshipFeeOverwritten": true,
        "dynamicPrice": 0,
        "dynamicCost": 0,
        "dynamicMsrp": 0,
        "dynamicMap": 0,
        "dynamicShippingCost": 0,
        "dynamicDropshipFee": 0
      },
      "quantityOverwrite": {
        "quantityOverwritten": true,
        "dynamicQuantity": 0,
        "orderVolumeProtectionLockedAt": "string",
        "lastManualQuantity": 0,
        "isLockedByOrderVolumeProtection": true
      },
      "productParentId": 0,
      "price": 0,
      "salePrice": 0,
      "estimatedShippingCost": 0,
      "estimatedDropshipFee": 0,
      "inventoryListPrice": 0,
      "imagesFetched": true,
      "productBuilderId": 0,
      "builtWithMappingTemplateId": 0,
      "builtAt": "2026-04-20T00:00:00Z",
      "rebuiltAt": "2026-04-20T00:00:00Z",
      "inventoryLinks": [
        {
          "id": null,
          "productVariantId": null,
          "inventoryVariantId": null
        }
      ],
      "productAlternatives": [
        {
          "id": null,
          "sku": null,
          "title": null,
          "quantity": null,
          "cost": null,
          "price": null,
          "image": null,
          "parentId": null
        }
      ],
      "referenceIdentifier": "string",
      "id": 0,
      "sku": "string",
      "title": "string",
      "mpn": "string",
      "upc": "string",
      "ean": "string",
      "asin": "string",
      "msrp": 0,
      "map": 0,
      "weight": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "insertedAt": "2026-04-20T00:00:00Z",
      "updatedAt": "2026-04-20T00:00:00Z",
      "archived": true,
      "cost": 0,
      "quantity": 0,
      "pendingFulfillmentQuantity": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "dimensionalWeight": 0,
      "images": [
        {
          "productParentId": null,
          "productVariantId": null,
          "md5Checksum": null,
          "originalUrl": null,
          "fetched": null,
          "fetchAttempts": null,
          "archived": null,
          "id": null,
          "url": null,
          "sortOrder": null
        }
      ],
      "options": [
        {
          "productParentOptionId": null,
          "globalOptionValueId": null,
          "productVariantId": null,
          "id": null,
          "position": null,
          "name": null,
          "value": null,
          "globalPosition": null
        }
      ],
      "bundle": true,
      "bundleComponents": [
        {
          "componentQuantity": null,
          "componentProductVariant": null,
          "bundleProductVariantId": null,
          "componentProductVariantId": null
        }
      ],
      "listingLinks": [
        {
          "listingVariantId": null,
          "channelId": null
        }
      ],
      "customAggregateFields": [
        {
          "id": null,
          "productVariantId": null,
          "accountId": null,
          "customAggregateField": null,
          "name": null,
          "value": null,
          "customAggregateFieldId": null
        }
      ],
      "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
      "customFields": [
        {
          "id": null,
          "customFieldValueId": null,
          "customFieldId": null,
          "name": null,
          "value": null,
          "originalInventoryName": null,
          "originalInventoryValue": null,
          "mergeToCustomFieldId": null,
          "mergeToCustomFieldName": null,
          "mergeToCustomFieldValueId": null,
          "mergeToCustomFieldValue": null
        }
      ],
      "parent": {
        "id": 0,
        "sku": "string",
        "title": "string",
        "description": "string",
        "manufacturer": "string",
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "archived": true,
        "categoryOne": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryTwo": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryThree": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "images": [
          null
        ],
        "options": [
          null
        ],
        "attributes": [
          null
        ],
        "customFields": [
          null
        ],
        "variants": [
          null
        ],
        "categoryOneId": 0,
        "categoryTwoId": 0,
        "categoryThreeId": 0,
        "imagesFetched": true,
        "productBuilderId": 0,
        "builtWithMappingTemplateId": 0,
        "builtAt": "2026-04-20T00:00:00Z",
        "rebuiltAt": "2026-04-20T00:00:00Z",
        "tags": [
          null
        ],
        "listingLinks": [
          null
        ],
        "imageFetcherEventTriggered": true
      },
      "description": "string",
      "tags": [
        "string"
      ],
      "requiresFfl": true,
      "imageFetcherEventTriggered": true,
      "linkedSourceCount": 0
    }
  ],
  "categoryOneId": 0,
  "categoryTwoId": 0,
  "categoryThreeId": 0,
  "imagesFetched": true,
  "productBuilderId": 0,
  "builtWithMappingTemplateId": 0,
  "builtAt": "2026-04-20T00:00:00Z",
  "rebuiltAt": "2026-04-20T00:00:00Z",
  "tags": [
    "string"
  ],
  "listingLinks": [
    {
      "listingParentId": 0,
      "channelId": 0
    }
  ],
  "imageFetcherEventTriggered": true
}
201CREATED - A new parent was createdapplication/json
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
idinteger
optionIdinteger
valuestring
positioninteger
globalPositioninteger
globalOptionValueIdinteger (int64)
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
componentQuantityintegerrequired
componentProductVariantobject
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldobject
idinteger
aggregateFieldDataTypeIdinteger
customAggregateFieldOptionIdinteger
namestring
handlestring
ignoreOutOfStockboolean
default false
accountIdinteger
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
Example response
{
  "id": 0,
  "sku": "string",
  "title": "string",
  "description": "string",
  "manufacturer": "string",
  "insertedAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "archived": true,
  "categoryOne": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryTwo": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryThree": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "images": [
    {
      "productParentId": 0,
      "productVariantId": 0,
      "md5Checksum": "string",
      "originalUrl": "string",
      "fetched": true,
      "fetchAttempts": 0,
      "archived": true,
      "id": 0,
      "url": "string",
      "sortOrder": 0
    }
  ],
  "options": [
    {
      "productParentId": 0,
      "id": 0,
      "name": "string",
      "globalOptionId": 0,
      "optionValues": [
        {
          "id": null,
          "optionId": null,
          "value": null,
          "position": null,
          "globalPosition": null,
          "globalOptionValueId": 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": true,
        "costOverwritten": true,
        "msrpOverwritten": true,
        "mapOverwritten": true,
        "shippingCostOverwritten": true,
        "dropshipFeeOverwritten": true,
        "dynamicPrice": 0,
        "dynamicCost": 0,
        "dynamicMsrp": 0,
        "dynamicMap": 0,
        "dynamicShippingCost": 0,
        "dynamicDropshipFee": 0
      },
      "quantityOverwrite": {
        "quantityOverwritten": true,
        "dynamicQuantity": 0,
        "orderVolumeProtectionLockedAt": "string",
        "lastManualQuantity": 0,
        "isLockedByOrderVolumeProtection": true
      },
      "productParentId": 0,
      "price": 0,
      "salePrice": 0,
      "estimatedShippingCost": 0,
      "estimatedDropshipFee": 0,
      "inventoryListPrice": 0,
      "imagesFetched": true,
      "productBuilderId": 0,
      "builtWithMappingTemplateId": 0,
      "builtAt": "2026-04-20T00:00:00Z",
      "rebuiltAt": "2026-04-20T00:00:00Z",
      "inventoryLinks": [
        {
          "id": null,
          "productVariantId": null,
          "inventoryVariantId": null
        }
      ],
      "productAlternatives": [
        {
          "id": null,
          "sku": null,
          "title": null,
          "quantity": null,
          "cost": null,
          "price": null,
          "image": null,
          "parentId": null
        }
      ],
      "referenceIdentifier": "string",
      "id": 0,
      "sku": "string",
      "title": "string",
      "mpn": "string",
      "upc": "string",
      "ean": "string",
      "asin": "string",
      "msrp": 0,
      "map": 0,
      "weight": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "insertedAt": "2026-04-20T00:00:00Z",
      "updatedAt": "2026-04-20T00:00:00Z",
      "archived": true,
      "cost": 0,
      "quantity": 0,
      "pendingFulfillmentQuantity": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "dimensionalWeight": 0,
      "images": [
        {
          "productParentId": null,
          "productVariantId": null,
          "md5Checksum": null,
          "originalUrl": null,
          "fetched": null,
          "fetchAttempts": null,
          "archived": null,
          "id": null,
          "url": null,
          "sortOrder": null
        }
      ],
      "options": [
        {
          "productParentOptionId": null,
          "globalOptionValueId": null,
          "productVariantId": null,
          "id": null,
          "position": null,
          "name": null,
          "value": null,
          "globalPosition": null
        }
      ],
      "bundle": true,
      "bundleComponents": [
        {
          "componentQuantity": null,
          "componentProductVariant": null,
          "bundleProductVariantId": null,
          "componentProductVariantId": null
        }
      ],
      "listingLinks": [
        {
          "listingVariantId": null,
          "channelId": null
        }
      ],
      "customAggregateFields": [
        {
          "id": null,
          "productVariantId": null,
          "accountId": null,
          "customAggregateField": null,
          "name": null,
          "value": null,
          "customAggregateFieldId": null
        }
      ],
      "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
      "customFields": [
        {
          "id": null,
          "customFieldValueId": null,
          "customFieldId": null,
          "name": null,
          "value": null,
          "originalInventoryName": null,
          "originalInventoryValue": null,
          "mergeToCustomFieldId": null,
          "mergeToCustomFieldName": null,
          "mergeToCustomFieldValueId": null,
          "mergeToCustomFieldValue": null
        }
      ],
      "parent": {
        "id": 0,
        "sku": "string",
        "title": "string",
        "description": "string",
        "manufacturer": "string",
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "archived": true,
        "categoryOne": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryTwo": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryThree": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "images": [
          null
        ],
        "options": [
          null
        ],
        "attributes": [
          null
        ],
        "customFields": [
          null
        ],
        "variants": [
          null
        ],
        "categoryOneId": 0,
        "categoryTwoId": 0,
        "categoryThreeId": 0,
        "imagesFetched": true,
        "productBuilderId": 0,
        "builtWithMappingTemplateId": 0,
        "builtAt": "2026-04-20T00:00:00Z",
        "rebuiltAt": "2026-04-20T00:00:00Z",
        "tags": [
          null
        ],
        "listingLinks": [
          null
        ],
        "imageFetcherEventTriggered": true
      },
      "description": "string",
      "tags": [
        "string"
      ],
      "requiresFfl": true,
      "imageFetcherEventTriggered": true,
      "linkedSourceCount": 0
    }
  ],
  "categoryOneId": 0,
  "categoryTwoId": 0,
  "categoryThreeId": 0,
  "imagesFetched": true,
  "productBuilderId": 0,
  "builtWithMappingTemplateId": 0,
  "builtAt": "2026-04-20T00:00:00Z",
  "rebuiltAt": "2026-04-20T00:00:00Z",
  "tags": [
    "string"
  ],
  "listingLinks": [
    {
      "listingParentId": 0,
      "channelId": 0
    }
  ],
  "imageFetcherEventTriggered": true
}
204NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the parent product does not exist. This will return an empty/null response body.application/json
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
idinteger
optionIdinteger
valuestring
positioninteger
globalPositioninteger
globalOptionValueIdinteger (int64)
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
componentQuantityintegerrequired
componentProductVariantobject
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldobject
idinteger
aggregateFieldDataTypeIdinteger
customAggregateFieldOptionIdinteger
namestring
handlestring
ignoreOutOfStockboolean
default false
accountIdinteger
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
Example response
{
  "id": 0,
  "sku": "string",
  "title": "string",
  "description": "string",
  "manufacturer": "string",
  "insertedAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "archived": true,
  "categoryOne": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryTwo": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryThree": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "images": [
    {
      "productParentId": 0,
      "productVariantId": 0,
      "md5Checksum": "string",
      "originalUrl": "string",
      "fetched": true,
      "fetchAttempts": 0,
      "archived": true,
      "id": 0,
      "url": "string",
      "sortOrder": 0
    }
  ],
  "options": [
    {
      "productParentId": 0,
      "id": 0,
      "name": "string",
      "globalOptionId": 0,
      "optionValues": [
        {
          "id": null,
          "optionId": null,
          "value": null,
          "position": null,
          "globalPosition": null,
          "globalOptionValueId": 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": true,
        "costOverwritten": true,
        "msrpOverwritten": true,
        "mapOverwritten": true,
        "shippingCostOverwritten": true,
        "dropshipFeeOverwritten": true,
        "dynamicPrice": 0,
        "dynamicCost": 0,
        "dynamicMsrp": 0,
        "dynamicMap": 0,
        "dynamicShippingCost": 0,
        "dynamicDropshipFee": 0
      },
      "quantityOverwrite": {
        "quantityOverwritten": true,
        "dynamicQuantity": 0,
        "orderVolumeProtectionLockedAt": "string",
        "lastManualQuantity": 0,
        "isLockedByOrderVolumeProtection": true
      },
      "productParentId": 0,
      "price": 0,
      "salePrice": 0,
      "estimatedShippingCost": 0,
      "estimatedDropshipFee": 0,
      "inventoryListPrice": 0,
      "imagesFetched": true,
      "productBuilderId": 0,
      "builtWithMappingTemplateId": 0,
      "builtAt": "2026-04-20T00:00:00Z",
      "rebuiltAt": "2026-04-20T00:00:00Z",
      "inventoryLinks": [
        {
          "id": null,
          "productVariantId": null,
          "inventoryVariantId": null
        }
      ],
      "productAlternatives": [
        {
          "id": null,
          "sku": null,
          "title": null,
          "quantity": null,
          "cost": null,
          "price": null,
          "image": null,
          "parentId": null
        }
      ],
      "referenceIdentifier": "string",
      "id": 0,
      "sku": "string",
      "title": "string",
      "mpn": "string",
      "upc": "string",
      "ean": "string",
      "asin": "string",
      "msrp": 0,
      "map": 0,
      "weight": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "insertedAt": "2026-04-20T00:00:00Z",
      "updatedAt": "2026-04-20T00:00:00Z",
      "archived": true,
      "cost": 0,
      "quantity": 0,
      "pendingFulfillmentQuantity": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "dimensionalWeight": 0,
      "images": [
        {
          "productParentId": null,
          "productVariantId": null,
          "md5Checksum": null,
          "originalUrl": null,
          "fetched": null,
          "fetchAttempts": null,
          "archived": null,
          "id": null,
          "url": null,
          "sortOrder": null
        }
      ],
      "options": [
        {
          "productParentOptionId": null,
          "globalOptionValueId": null,
          "productVariantId": null,
          "id": null,
          "position": null,
          "name": null,
          "value": null,
          "globalPosition": null
        }
      ],
      "bundle": true,
      "bundleComponents": [
        {
          "componentQuantity": null,
          "componentProductVariant": null,
          "bundleProductVariantId": null,
          "componentProductVariantId": null
        }
      ],
      "listingLinks": [
        {
          "listingVariantId": null,
          "channelId": null
        }
      ],
      "customAggregateFields": [
        {
          "id": null,
          "productVariantId": null,
          "accountId": null,
          "customAggregateField": null,
          "name": null,
          "value": null,
          "customAggregateFieldId": null
        }
      ],
      "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
      "customFields": [
        {
          "id": null,
          "customFieldValueId": null,
          "customFieldId": null,
          "name": null,
          "value": null,
          "originalInventoryName": null,
          "originalInventoryValue": null,
          "mergeToCustomFieldId": null,
          "mergeToCustomFieldName": null,
          "mergeToCustomFieldValueId": null,
          "mergeToCustomFieldValue": null
        }
      ],
      "parent": {
        "id": 0,
        "sku": "string",
        "title": "string",
        "description": "string",
        "manufacturer": "string",
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "archived": true,
        "categoryOne": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryTwo": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryThree": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "images": [
          null
        ],
        "options": [
          null
        ],
        "attributes": [
          null
        ],
        "customFields": [
          null
        ],
        "variants": [
          null
        ],
        "categoryOneId": 0,
        "categoryTwoId": 0,
        "categoryThreeId": 0,
        "imagesFetched": true,
        "productBuilderId": 0,
        "builtWithMappingTemplateId": 0,
        "builtAt": "2026-04-20T00:00:00Z",
        "rebuiltAt": "2026-04-20T00:00:00Z",
        "tags": [
          null
        ],
        "listingLinks": [
          null
        ],
        "imageFetcherEventTriggered": true
      },
      "description": "string",
      "tags": [
        "string"
      ],
      "requiresFfl": true,
      "imageFetcherEventTriggered": true,
      "linkedSourceCount": 0
    }
  ],
  "categoryOneId": 0,
  "categoryTwoId": 0,
  "categoryThreeId": 0,
  "imagesFetched": true,
  "productBuilderId": 0,
  "builtWithMappingTemplateId": 0,
  "builtAt": "2026-04-20T00:00:00Z",
  "rebuiltAt": "2026-04-20T00:00:00Z",
  "tags": [
    "string"
  ],
  "listingLinks": [
    {
      "listingParentId": 0,
      "channelId": 0
    }
  ],
  "imageFetcherEventTriggered": true
}
401Unauthorized

No schema documented for this status.

409Conflict - If the SKU provided already exists on a different parent a conflict will be returnedapplication/json
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
idinteger
optionIdinteger
valuestring
positioninteger
globalPositioninteger
globalOptionValueIdinteger (int64)
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
idinteger
productVariantIdinteger
inventoryVariantIdinteger (int64)required
productAlternativesarray[AlternateVariant]
idinteger
skustring
titlestring
quantityinteger
costnumber
pricenumber
imagestring
parentIdinteger
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductVariantOption]
productParentOptionIdinteger
globalOptionValueIdinteger (int64)
productVariantIdinteger
idinteger
positioninteger
namestringrequired
valuestringrequired
globalPositioninteger
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
componentQuantityintegerrequired
componentProductVariantobject
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
bundleProductVariantIdinteger
componentProductVariantIdintegerrequired
listingLinksarray[ProductVariantListingLink]
listingVariantIdintegerrequired
channelIdintegerrequired
customAggregateFieldsarray[ProductVariantCustomAggregateField]
idinteger (int64)
productVariantIdinteger
accountIdinteger
customAggregateFieldobject
idinteger
aggregateFieldDataTypeIdinteger
customAggregateFieldOptionIdinteger
namestring
handlestring
ignoreOutOfStockboolean
default false
accountIdinteger
namestring
valuenumber
customAggregateFieldIdinteger
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryTwoobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
categoryThreeobject
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdinteger
insertedAtstring (date-time)
updatedAtstring (date-time)
customizedboolean
idinteger
namestringrequired
parentCategoryIdinteger
inventoryCategoryobject
sourceIdinteger
productCategoryIdinteger
A product Category this inventory category is mapped to
idinteger
namestringrequired
excludedboolean
parentCategoryIdinteger
imagesarray[ProductImage]
productParentIdinteger
productVariantIdinteger
md5Checksumstring
originalUrlstring
fetchedboolean
fetchAttemptsinteger
archivedboolean
idinteger
urlstringrequired
sortOrderinteger
optionsarray[ProductParentOption]
productParentIdinteger
idinteger
namestringrequired
globalOptionIdinteger (int64)
optionValuesarray[OptionValue]
attributesarray[ProductParentAttribute]
idinteger (int64)
attributeIdinteger
attributeValueIdinteger
namestringrequired
originalInventoryNamestring
valuestringrequired
originalInventoryValuestring
isPrivateboolean
mergeToAttributeIdinteger
mergeToAttributeNamestring
mergeToAttributeValueIdinteger
mergeToAttributeValuestring
mergeToAttributeIsPrivateboolean
customFieldsarray[ProductParentCustomField]
idinteger (int64)
customFieldValueIdinteger
customFieldIdinteger
namestringrequired
valuestringrequired
originalInventoryNamestring
originalInventoryValuestring
mergeToCustomFieldIdinteger
mergeToCustomFieldNamestring
mergeToCustomFieldValueIdinteger
mergeToCustomFieldValuestring
variantsarray[ProductVariant]
priceOverwriteobject
priceOverwrittenboolean
True if the dynamic price is overwritten to a locked value.
costOverwrittenboolean
True if the dynamic cost is overwritten to a locked value.
msrpOverwrittenboolean
True if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenboolean
True if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenboolean
True if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenboolean
True if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumber
The price value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant price upon removing an overwrite.
dynamicCostnumber
The cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant cost upon removing an overwrite.
dynamicMsrpnumber
The MSRP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MSRP upon removing an overwrite.
dynamicMapnumber
The MAP value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant MAP upon removing an overwrite.
dynamicShippingCostnumber
The estimated shipping cost value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated shipping cost upon removing an overwrite.
dynamicDropshipFeenumber
The estimated dropship fee value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant estimated dropship fee upon removing an overwrite.
quantityOverwriteobject
quantityOverwrittenboolean
True if the dynamic quantity is overwritten to a locked value.
dynamicQuantityinteger
The quantity value that is dynamically calculated based on the aggregate rules and/or workflow rules configured. This value will be restored as the variant quantity upon removing an overwrite.
orderVolumeProtectionLockedAtstring
The timestamp of when the item was locked by order volume protection.
lastManualQuantityinteger
The previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionboolean
A boolean value representing if the variant is locked by order volume protection.
default "false"
productParentIdinteger
pricenumber
The dynamic price, or locked price if overwritten.
salePricenumber
estimatedShippingCostnumber
The dynamic estimated shipping cost, or locked estimated shipping cost if overwritten.
estimatedDropshipFeenumber
The dynamic estimated dropship fee, or locked estimated dropship fee if overwritten.
inventoryListPricenumber
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
inventoryLinksarray[ProductVariantInventoryLink]
productAlternativesarray[AlternateVariant]
referenceIdentifierstring
idinteger
skustringrequired
titlestring
mpnstring
upcstring
eanstring
asinstring
msrpnumber
The dynamic MSRP, or locked MSRP if overwritten.
mapnumber
The dynamic MAP, or locked MAP if overwritten.
weightnumber
lengthnumber
widthnumber
heightnumber
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
costnumber
The dynamic cost, or locked cost if overwritten.
quantityinteger
The dynamic quantity, or locked quantity if overwritten.
pendingFulfillmentQuantityinteger
The # of items on active orders that are waiting to be added to Fulfillment Requests
weightUnitobject
handlestring
allowedpoundouncegramkilogram
abbreviatedHandlestring
allowedlbozgkg
dimensionUnitobject
handlestring
allowedinchcentimeter
abbreviatedHandlestring
allowedincm
dimensionalWeightnumber
imagesarray[ProductImage]
optionsarray[ProductVariantOption]
bundleboolean
Indicates if this variant is a bundle. This must be set to `true` upon the creation of the variant and cannot be changed after the fact.
bundleComponentsarray[ProductBundleComponent]
Only available when the product is a part of a bundle
listingLinksarray[ProductVariantListingLink]
customAggregateFieldsarray[ProductVariantCustomAggregateField]
scheduledToDeleteAtstring (date-time)
customFieldsarray[ProductVariantCustomField]
parentobject
idinteger
skustringrequired
titlestring
descriptionstring
manufacturerstring
insertedAtstring (date-time)
updatedAtstring (date-time)
archivedboolean
categoryOneProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryTwoProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
categoryThreeProductCategory
A product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
imagesarray[ProductImage]
optionsarray[ProductParentOption]
attributesarray[ProductParentAttribute]
customFieldsarray[ProductParentCustomField]
variantsarray[ProductVariant]
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
listingLinksarray[ProductParentListingLink]
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
descriptionstring
tagsarray[string]
string
requiresFflboolean
Indicate if FFL information will be required to fulfill this product variant
imageFetcherEventTriggeredboolean
linkedSourceCountinteger
The number of sources (inventory variants) linked to the product that act as means of fulfillment
categoryOneIdinteger
categoryTwoIdinteger
categoryThreeIdinteger
imagesFetchedboolean
productBuilderIdinteger
builtWithMappingTemplateIdinteger
builtAtstring (date-time)
rebuiltAtstring (date-time)
tagsarray[string]
string
listingLinksarray[ProductParentListingLink]
listingParentIdintegerrequired
channelIdintegerrequired
imageFetcherEventTriggeredboolean
Example response
{
  "id": 0,
  "sku": "string",
  "title": "string",
  "description": "string",
  "manufacturer": "string",
  "insertedAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "archived": true,
  "categoryOne": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryTwo": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "categoryThree": {
    "accountId": 0,
    "insertedAt": "2026-04-20T00:00:00Z",
    "updatedAt": "2026-04-20T00:00:00Z",
    "customized": true,
    "id": 0,
    "name": "string",
    "parentCategoryId": 0,
    "inventoryCategory": {
      "sourceId": 0,
      "productCategoryId": 0,
      "id": 0,
      "name": "string",
      "excluded": true,
      "parentCategoryId": 0
    }
  },
  "images": [
    {
      "productParentId": 0,
      "productVariantId": 0,
      "md5Checksum": "string",
      "originalUrl": "string",
      "fetched": true,
      "fetchAttempts": 0,
      "archived": true,
      "id": 0,
      "url": "string",
      "sortOrder": 0
    }
  ],
  "options": [
    {
      "productParentId": 0,
      "id": 0,
      "name": "string",
      "globalOptionId": 0,
      "optionValues": [
        {
          "id": null,
          "optionId": null,
          "value": null,
          "position": null,
          "globalPosition": null,
          "globalOptionValueId": 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": true,
        "costOverwritten": true,
        "msrpOverwritten": true,
        "mapOverwritten": true,
        "shippingCostOverwritten": true,
        "dropshipFeeOverwritten": true,
        "dynamicPrice": 0,
        "dynamicCost": 0,
        "dynamicMsrp": 0,
        "dynamicMap": 0,
        "dynamicShippingCost": 0,
        "dynamicDropshipFee": 0
      },
      "quantityOverwrite": {
        "quantityOverwritten": true,
        "dynamicQuantity": 0,
        "orderVolumeProtectionLockedAt": "string",
        "lastManualQuantity": 0,
        "isLockedByOrderVolumeProtection": true
      },
      "productParentId": 0,
      "price": 0,
      "salePrice": 0,
      "estimatedShippingCost": 0,
      "estimatedDropshipFee": 0,
      "inventoryListPrice": 0,
      "imagesFetched": true,
      "productBuilderId": 0,
      "builtWithMappingTemplateId": 0,
      "builtAt": "2026-04-20T00:00:00Z",
      "rebuiltAt": "2026-04-20T00:00:00Z",
      "inventoryLinks": [
        {
          "id": null,
          "productVariantId": null,
          "inventoryVariantId": null
        }
      ],
      "productAlternatives": [
        {
          "id": null,
          "sku": null,
          "title": null,
          "quantity": null,
          "cost": null,
          "price": null,
          "image": null,
          "parentId": null
        }
      ],
      "referenceIdentifier": "string",
      "id": 0,
      "sku": "string",
      "title": "string",
      "mpn": "string",
      "upc": "string",
      "ean": "string",
      "asin": "string",
      "msrp": 0,
      "map": 0,
      "weight": 0,
      "length": 0,
      "width": 0,
      "height": 0,
      "insertedAt": "2026-04-20T00:00:00Z",
      "updatedAt": "2026-04-20T00:00:00Z",
      "archived": true,
      "cost": 0,
      "quantity": 0,
      "pendingFulfillmentQuantity": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "dimensionalWeight": 0,
      "images": [
        {
          "productParentId": null,
          "productVariantId": null,
          "md5Checksum": null,
          "originalUrl": null,
          "fetched": null,
          "fetchAttempts": null,
          "archived": null,
          "id": null,
          "url": null,
          "sortOrder": null
        }
      ],
      "options": [
        {
          "productParentOptionId": null,
          "globalOptionValueId": null,
          "productVariantId": null,
          "id": null,
          "position": null,
          "name": null,
          "value": null,
          "globalPosition": null
        }
      ],
      "bundle": true,
      "bundleComponents": [
        {
          "componentQuantity": null,
          "componentProductVariant": null,
          "bundleProductVariantId": null,
          "componentProductVariantId": null
        }
      ],
      "listingLinks": [
        {
          "listingVariantId": null,
          "channelId": null
        }
      ],
      "customAggregateFields": [
        {
          "id": null,
          "productVariantId": null,
          "accountId": null,
          "customAggregateField": null,
          "name": null,
          "value": null,
          "customAggregateFieldId": null
        }
      ],
      "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
      "customFields": [
        {
          "id": null,
          "customFieldValueId": null,
          "customFieldId": null,
          "name": null,
          "value": null,
          "originalInventoryName": null,
          "originalInventoryValue": null,
          "mergeToCustomFieldId": null,
          "mergeToCustomFieldName": null,
          "mergeToCustomFieldValueId": null,
          "mergeToCustomFieldValue": null
        }
      ],
      "parent": {
        "id": 0,
        "sku": "string",
        "title": "string",
        "description": "string",
        "manufacturer": "string",
        "insertedAt": "2026-04-20T00:00:00Z",
        "updatedAt": "2026-04-20T00:00:00Z",
        "archived": true,
        "categoryOne": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryTwo": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "categoryThree": {
          "accountId": null,
          "insertedAt": null,
          "updatedAt": null,
          "customized": null,
          "id": null,
          "name": null,
          "parentCategoryId": null,
          "inventoryCategory": null
        },
        "images": [
          null
        ],
        "options": [
          null
        ],
        "attributes": [
          null
        ],
        "customFields": [
          null
        ],
        "variants": [
          null
        ],
        "categoryOneId": 0,
        "categoryTwoId": 0,
        "categoryThreeId": 0,
        "imagesFetched": true,
        "productBuilderId": 0,
        "builtWithMappingTemplateId": 0,
        "builtAt": "2026-04-20T00:00:00Z",
        "rebuiltAt": "2026-04-20T00:00:00Z",
        "tags": [
          null
        ],
        "listingLinks": [
          null
        ],
        "imageFetcherEventTriggered": true
      },
      "description": "string",
      "tags": [
        "string"
      ],
      "requiresFfl": true,
      "imageFetcherEventTriggered": true,
      "linkedSourceCount": 0
    }
  ],
  "categoryOneId": 0,
  "categoryTwoId": 0,
  "categoryThreeId": 0,
  "imagesFetched": true,
  "productBuilderId": 0,
  "builtWithMappingTemplateId": 0,
  "builtAt": "2026-04-20T00:00:00Z",
  "rebuiltAt": "2026-04-20T00:00:00Z",
  "tags": [
    "string"
  ],
  "listingLinks": [
    {
      "listingParentId": 0,
      "channelId": 0
    }
  ],
  "imageFetcherEventTriggered": true
}
OpenAPI fragment
{
  "post": {
    "summary": "Create/Update Product Parent",
    "description": "Create/Update a product parent",
    "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": "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": "modifyAttributes",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "merge",
            "deleteIncluded",
            "deleteAll"
          ]
        },
        "description": "Should attributes of the parent be modified"
      },
      {
        "name": "modifyCustomFields",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "merge",
            "deleteIncluded",
            "deleteAll"
          ]
        },
        "description": "Should custom fields of the parent be modified"
      },
      {
        "name": "modifyCategories",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "none",
            "update",
            "delete"
          ]
        },
        "description": "Should categories of the parent be modified"
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ProductParentRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK - Existing parent was updated OR the `restrictCreateOrUpdate` param was provided with a value of `createOnly` and the parent already existed in which case nothing was modified and the existing parent will be returned.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProductParent"
            }
          }
        }
      },
      "201": {
        "description": "CREATED - A new parent was created",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProductParent"
            }
          }
        }
      },
      "204": {
        "description": "NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the parent product does not exist. This will return an empty/null response body.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProductParent"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      },
      "409": {
        "description": "Conflict - If the SKU provided already exists on a different parent a conflict will be returned",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProductParent"
            }
          }
        }
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight