Create/Update Listing Parent
post
https://api.flxpoint.com/listing/parentsUse this when you want to create listing data through the API.
🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
Create/Update a listing 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.
allowedcreateOnlyupdateOnlymodifyContentquerystringShould content fields of the parent/variant be modified
allowednoneupdateupdateNonNullmodifyOptionsquerystringShould options of the parent/variant be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyImagesquerystringShould images of the parent/variant be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyAttributesquerystringShould attributes of the parent be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyCustomFieldsquerystringShould custom fields of the parent be modified
allowednoneupdatemergedeleteIncludeddeleteAllmodifyCategoriesquerystringShould categories of the parent be modified
allowednoneupdatedeletemodifyPublishDataquerystringShould publish fields (ie `publishError`, `staticContentUpdatedAt`, `staticContentSyncedAt`) of the parent/variant be modified
allowednoneupdateupdateNonNullmodifyChannelDataquerystringShould channel related fields (ie `externalLIstingId`, `linkAttemptedAt`, `linkedToRegularProduct`, `externalReferenceId`, `externalReferenceIdType`) of the parent/variant be modified
allowednoneupdateupdateNonNullmodifySyncDataquerystringShould sync fields (ie `syncError`, `dynamicContentUpdatedAt`, `dynamicContentSyncedAt`) of the parent/variant be modified
allowednoneupdateupdateNonNullmodifyStatusDataquerystringShould status fields (ie `pausedAt`, `listingStatusId`, `changeToListingStatusId`, `scheduledToDeleteAt`) of the parent/variant be modified
allowednoneupdateupdateNonNullmodifyCategoryAiDataquerystringShould category ai data be modified
allowednoneupdatedelete
Body
application/jsonidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]deprecatedDEPRECATED : 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.
priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingVariantOption]listingParentOptionIdintegerglobalOptionValueIdinteger (int64)listingVariantIdintegeridintegernamestringrequiredvaluestringrequiredpositionintegerglobalPositionintegerchannelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]optionsarray[ListingVariantOption]channelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryTwoListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryThreeListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
imagesarray[ListingImage]optionsarray[ListingParentOption]attributesarray[ListingParentAttribute]customFieldsarray[ListingParentCustomField]variantsarray[ListingVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusListingStatuschangeToListingStatusListingStatuspausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]tagsarray[string]descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]idinteger (int64)listingVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleandefault
falseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringtagsarray[string]string
descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)Example request
post
/listing/parentscurl -X POST "https://api.flxpoint.com/listing/parents" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"images": [
{
"listingParentId": 0,
"listingVariantId": 0,
"md5Checksum": "string",
"id": 0,
"url": "string",
"sortOrder": 0,
"createdAt": "2026-04-20T00:00:00Z",
"publishedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
"publishing": true,
"externalListingId": "string",
"listingError": "string",
"productParentImageId": 0,
"productVariantImageId": 0
}
],
"options": [
{
"listingParentId": 0,
"globalOptionId": 0,
"id": 0,
"name": "string",
"optionValues": [
{
"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
},
"listingParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"id": 0,
"accountId": 0,
"sku": "string",
"masterSku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"dimensionalWeight": 0,
"images": [
{
"listingParentId": null,
"listingVariantId": null,
"md5Checksum": null,
"id": null,
"url": null,
"sortOrder": null,
"createdAt": null,
"publishedAt": null,
"staticContentUpdatedAt": null,
"staticContentSyncedAt": null,
"dynamicContentUpdatedAt": null,
"dynamicCOntentSyncedAt": null,
"publishing": null,
"externalListingId": null,
"listingError": null,
"productParentImageId": null,
"productVariantImageId": null
}
],
"options": [
{
"listingParentOptionId": null,
"globalOptionValueId": null,
"listingVariantId": null,
"id": null,
"name": null,
"value": null,
"position": null,
"globalPosition": null
}
],
"channelId": 0,
"productVariantId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"pausedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"linkedToRegularProduct": true,
"externalReferenceId": "string",
"externalReferenceIdType": "string",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"listingParent": {
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryTwo": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryThree": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"images": [
null
],
"options": [
null
],
"attributes": [
null
],
"customFields": [
null
],
"variants": [
null
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": null,
"handle": null,
"name": null
},
"changeToListingStatus": {
"id": null,
"handle": null,
"name": null
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
null
],
"imageFetcherEventTriggered": true
},
"customAggregateFields": [
{
"id": null,
"listingVariantId": null,
"accountId": null,
"customAggregateField": null,
"name": null,
"value": null,
"customAggregateFieldId": null
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"profit": 0,
"profitPercentage": 0,
"profitWithFees": 0,
"profitWithFeesPercentage": 0,
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"tags": [
"string"
],
"description": "string",
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"priceProtection": true,
"linkedSourceCount": 0
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"pausedAt": "2026-04-20T00:00:00Z"
}'Example body · application/json
{
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"images": [
{
"listingParentId": 0,
"listingVariantId": 0,
"md5Checksum": "string",
"id": 0,
"url": "string",
"sortOrder": 0,
"createdAt": "2026-04-20T00:00:00Z",
"publishedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
"publishing": true,
"externalListingId": "string",
"listingError": "string",
"productParentImageId": 0,
"productVariantImageId": 0
}
],
"options": [
{
"listingParentId": 0,
"globalOptionId": 0,
"id": 0,
"name": "string",
"optionValues": [
{
"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
},
"listingParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"id": 0,
"accountId": 0,
"sku": "string",
"masterSku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"dimensionalWeight": 0,
"images": [
{
"listingParentId": null,
"listingVariantId": null,
"md5Checksum": null,
"id": null,
"url": null,
"sortOrder": null,
"createdAt": null,
"publishedAt": null,
"staticContentUpdatedAt": null,
"staticContentSyncedAt": null,
"dynamicContentUpdatedAt": null,
"dynamicCOntentSyncedAt": null,
"publishing": null,
"externalListingId": null,
"listingError": null,
"productParentImageId": null,
"productVariantImageId": null
}
],
"options": [
{
"listingParentOptionId": null,
"globalOptionValueId": null,
"listingVariantId": null,
"id": null,
"name": null,
"value": null,
"position": null,
"globalPosition": null
}
],
"channelId": 0,
"productVariantId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"pausedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"linkedToRegularProduct": true,
"externalReferenceId": "string",
"externalReferenceIdType": "string",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"listingParent": {
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryTwo": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryThree": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"images": [
null
],
"options": [
null
],
"attributes": [
null
],
"customFields": [
null
],
"variants": [
null
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": null,
"handle": null,
"name": null
},
"changeToListingStatus": {
"id": null,
"handle": null,
"name": null
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
null
],
"imageFetcherEventTriggered": true
},
"customAggregateFields": [
{
"id": null,
"listingVariantId": null,
"accountId": null,
"customAggregateField": null,
"name": null,
"value": null,
"customAggregateFieldId": null
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"profit": 0,
"profitPercentage": 0,
"profitWithFees": 0,
"profitWithFeesPercentage": 0,
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"tags": [
"string"
],
"description": "string",
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"priceProtection": true,
"linkedSourceCount": 0
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"pausedAt": "2026-04-20T00:00:00Z"
}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
idintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingVariantOption]listingParentOptionIdintegerglobalOptionValueIdinteger (int64)listingVariantIdintegeridintegernamestringrequiredvaluestringrequiredpositionintegerglobalPositionintegerchannelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]optionsarray[ListingVariantOption]channelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryTwoListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryThreeListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
imagesarray[ListingImage]optionsarray[ListingParentOption]attributesarray[ListingParentAttribute]customFieldsarray[ListingParentCustomField]variantsarray[ListingVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusListingStatuschangeToListingStatusListingStatuspausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]tagsarray[string]descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]idinteger (int64)listingVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleandefault
falseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringtagsarray[string]string
descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleanExample response
{
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"images": [
{
"listingParentId": 0,
"listingVariantId": 0,
"md5Checksum": "string",
"id": 0,
"url": "string",
"sortOrder": 0,
"createdAt": "2026-04-20T00:00:00Z",
"publishedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
"publishing": true,
"externalListingId": "string",
"listingError": "string",
"productParentImageId": 0,
"productVariantImageId": 0
}
],
"options": [
{
"listingParentId": 0,
"globalOptionId": 0,
"id": 0,
"name": "string",
"optionValues": [
{
"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
},
"listingParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"id": 0,
"accountId": 0,
"sku": "string",
"masterSku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"dimensionalWeight": 0,
"images": [
{
"listingParentId": null,
"listingVariantId": null,
"md5Checksum": null,
"id": null,
"url": null,
"sortOrder": null,
"createdAt": null,
"publishedAt": null,
"staticContentUpdatedAt": null,
"staticContentSyncedAt": null,
"dynamicContentUpdatedAt": null,
"dynamicCOntentSyncedAt": null,
"publishing": null,
"externalListingId": null,
"listingError": null,
"productParentImageId": null,
"productVariantImageId": null
}
],
"options": [
{
"listingParentOptionId": null,
"globalOptionValueId": null,
"listingVariantId": null,
"id": null,
"name": null,
"value": null,
"position": null,
"globalPosition": null
}
],
"channelId": 0,
"productVariantId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"pausedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"linkedToRegularProduct": true,
"externalReferenceId": "string",
"externalReferenceIdType": "string",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"listingParent": {
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryTwo": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryThree": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"images": [
null
],
"options": [
null
],
"attributes": [
null
],
"customFields": [
null
],
"variants": [
null
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": null,
"handle": null,
"name": null
},
"changeToListingStatus": {
"id": null,
"handle": null,
"name": null
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
null
],
"imageFetcherEventTriggered": true
},
"customAggregateFields": [
{
"id": null,
"listingVariantId": null,
"accountId": null,
"customAggregateField": null,
"name": null,
"value": null,
"customAggregateFieldId": null
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"profit": 0,
"profitPercentage": 0,
"profitWithFees": 0,
"profitWithFeesPercentage": 0,
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"tags": [
"string"
],
"description": "string",
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"priceProtection": true,
"linkedSourceCount": 0
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
"string"
],
"imageFetcherEventTriggered": true
}201CREATED - A new parent was createdapplication/json
idintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingVariantOption]listingParentOptionIdintegerglobalOptionValueIdinteger (int64)listingVariantIdintegeridintegernamestringrequiredvaluestringrequiredpositionintegerglobalPositionintegerchannelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]optionsarray[ListingVariantOption]channelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryTwoListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryThreeListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
imagesarray[ListingImage]optionsarray[ListingParentOption]attributesarray[ListingParentAttribute]customFieldsarray[ListingParentCustomField]variantsarray[ListingVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusListingStatuschangeToListingStatusListingStatuspausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]tagsarray[string]descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]idinteger (int64)listingVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleandefault
falseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringtagsarray[string]string
descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleanExample response
{
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"images": [
{
"listingParentId": 0,
"listingVariantId": 0,
"md5Checksum": "string",
"id": 0,
"url": "string",
"sortOrder": 0,
"createdAt": "2026-04-20T00:00:00Z",
"publishedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
"publishing": true,
"externalListingId": "string",
"listingError": "string",
"productParentImageId": 0,
"productVariantImageId": 0
}
],
"options": [
{
"listingParentId": 0,
"globalOptionId": 0,
"id": 0,
"name": "string",
"optionValues": [
{
"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
},
"listingParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"id": 0,
"accountId": 0,
"sku": "string",
"masterSku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"dimensionalWeight": 0,
"images": [
{
"listingParentId": null,
"listingVariantId": null,
"md5Checksum": null,
"id": null,
"url": null,
"sortOrder": null,
"createdAt": null,
"publishedAt": null,
"staticContentUpdatedAt": null,
"staticContentSyncedAt": null,
"dynamicContentUpdatedAt": null,
"dynamicCOntentSyncedAt": null,
"publishing": null,
"externalListingId": null,
"listingError": null,
"productParentImageId": null,
"productVariantImageId": null
}
],
"options": [
{
"listingParentOptionId": null,
"globalOptionValueId": null,
"listingVariantId": null,
"id": null,
"name": null,
"value": null,
"position": null,
"globalPosition": null
}
],
"channelId": 0,
"productVariantId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"pausedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"linkedToRegularProduct": true,
"externalReferenceId": "string",
"externalReferenceIdType": "string",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"listingParent": {
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryTwo": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryThree": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"images": [
null
],
"options": [
null
],
"attributes": [
null
],
"customFields": [
null
],
"variants": [
null
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": null,
"handle": null,
"name": null
},
"changeToListingStatus": {
"id": null,
"handle": null,
"name": null
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
null
],
"imageFetcherEventTriggered": true
},
"customAggregateFields": [
{
"id": null,
"listingVariantId": null,
"accountId": null,
"customAggregateField": null,
"name": null,
"value": null,
"customAggregateFieldId": null
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"profit": 0,
"profitPercentage": 0,
"profitWithFees": 0,
"profitWithFeesPercentage": 0,
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"tags": [
"string"
],
"description": "string",
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"priceProtection": true,
"linkedSourceCount": 0
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
"string"
],
"imageFetcherEventTriggered": true
}204NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the parent listing does not exist. This will return an empty/null response body.application/json
idintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingVariantOption]listingParentOptionIdintegerglobalOptionValueIdinteger (int64)listingVariantIdintegeridintegernamestringrequiredvaluestringrequiredpositionintegerglobalPositionintegerchannelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]optionsarray[ListingVariantOption]channelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryTwoListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryThreeListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
imagesarray[ListingImage]optionsarray[ListingParentOption]attributesarray[ListingParentAttribute]customFieldsarray[ListingParentCustomField]variantsarray[ListingVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusListingStatuschangeToListingStatusListingStatuspausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]tagsarray[string]descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]idinteger (int64)listingVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleandefault
falseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringtagsarray[string]string
descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleanExample response
{
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"images": [
{
"listingParentId": 0,
"listingVariantId": 0,
"md5Checksum": "string",
"id": 0,
"url": "string",
"sortOrder": 0,
"createdAt": "2026-04-20T00:00:00Z",
"publishedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
"publishing": true,
"externalListingId": "string",
"listingError": "string",
"productParentImageId": 0,
"productVariantImageId": 0
}
],
"options": [
{
"listingParentId": 0,
"globalOptionId": 0,
"id": 0,
"name": "string",
"optionValues": [
{
"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
},
"listingParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"id": 0,
"accountId": 0,
"sku": "string",
"masterSku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"dimensionalWeight": 0,
"images": [
{
"listingParentId": null,
"listingVariantId": null,
"md5Checksum": null,
"id": null,
"url": null,
"sortOrder": null,
"createdAt": null,
"publishedAt": null,
"staticContentUpdatedAt": null,
"staticContentSyncedAt": null,
"dynamicContentUpdatedAt": null,
"dynamicCOntentSyncedAt": null,
"publishing": null,
"externalListingId": null,
"listingError": null,
"productParentImageId": null,
"productVariantImageId": null
}
],
"options": [
{
"listingParentOptionId": null,
"globalOptionValueId": null,
"listingVariantId": null,
"id": null,
"name": null,
"value": null,
"position": null,
"globalPosition": null
}
],
"channelId": 0,
"productVariantId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"pausedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"linkedToRegularProduct": true,
"externalReferenceId": "string",
"externalReferenceIdType": "string",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"listingParent": {
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryTwo": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryThree": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"images": [
null
],
"options": [
null
],
"attributes": [
null
],
"customFields": [
null
],
"variants": [
null
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": null,
"handle": null,
"name": null
},
"changeToListingStatus": {
"id": null,
"handle": null,
"name": null
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
null
],
"imageFetcherEventTriggered": true
},
"customAggregateFields": [
{
"id": null,
"listingVariantId": null,
"accountId": null,
"customAggregateField": null,
"name": null,
"value": null,
"customAggregateFieldId": null
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"profit": 0,
"profitPercentage": 0,
"profitWithFees": 0,
"profitWithFeesPercentage": 0,
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"tags": [
"string"
],
"description": "string",
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"priceProtection": true,
"linkedSourceCount": 0
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
"string"
],
"imageFetcherEventTriggered": true
}400When a invalid data condition is provided
No schema documented for this status.
401Unauthorized
No schema documented for this status.
409Conflict - If the SKU provided already exists on a different parent a conflict will be returnedapplication/json
idintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingVariantOption]listingParentOptionIdintegerglobalOptionValueIdinteger (int64)listingVariantIdintegeridintegernamestringrequiredvaluestringrequiredpositionintegerglobalPositionintegerchannelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectA product category. These are primarily created during the product building process, and are initially seeded/populated from the passed `inventoryCategory`.
accountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegerA product Category this inventory category is mapped to
idintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegeroptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleanTrue if the dynamic price is overwritten to a locked value.
costOverwrittenbooleanTrue if the dynamic cost is overwritten to a locked value.
msrpOverwrittenbooleanTrue if the dynamic MSRP is overwritten to a locked value.
mapOverwrittenbooleanTrue if the dynamic MAP is overwritten to a locked value.
shippingCostOverwrittenbooleanTrue if the dynamic estimated shipping cost is overwritten to a locked value.
dropshipFeeOverwrittenbooleanTrue if the dynamic estimated dropship fee is overwritten to a locked value.
dynamicPricenumberThe 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.
dynamicCostnumberThe 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.
dynamicMsrpnumberThe 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.
dynamicMapnumberThe 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.
dynamicShippingCostnumberThe 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.
dynamicDropshipFeenumberThe 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.
quantityOverwriteobjectquantityOverwrittenbooleanTrue if the dynamic quantity is overwritten to a locked value.
dynamicQuantityintegerThe 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.
orderVolumeProtectionLockedAtstringThe timestamp of when the item was locked by order volume protection.
lastManualQuantityintegerThe previous manually locked quantity. This value is only populated when a quantity overwritten variant gets locked by order volume protection.
isLockedByOrderVolumeProtectionbooleanA boolean value representing if the variant is locked by order volume protection.
default
"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringYour master SKU is the SKU you use at your central product catalog level that is used as the primary means of identifying and linking your different listings across all your channels to your single central product
titlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringallowed
poundouncegramkilogramabbreviatedHandlestringallowed
lbozgkgdimensionUnitobjecthandlestringallowed
inchcentimeterabbreviatedHandlestringallowed
incmdimensionalWeightnumberimagesarray[ListingImage]optionsarray[ListingVariantOption]channelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryTwoListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
categoryThreeListingCategoryA listing category. These are primarily created during the listing building process, and are initially seeded/populated from the passed `productCategory`.
imagesarray[ListingImage]optionsarray[ListingParentOption]attributesarray[ListingParentAttribute]customFieldsarray[ListingParentCustomField]variantsarray[ListingVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusListingStatuschangeToListingStatusListingStatuspausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]tagsarray[string]descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]idinteger (int64)listingVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleandefault
falseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringtagsarray[string]string
descriptionstringrequiresFflbooleanIndicate if FFL information will be required to fulfill this listing variant
imageFetcherEventTriggeredbooleanpriceProtectionbooleanWill be marked as true when any of these conditions are met :
-List Price <= Cost
-Cost = 0 or Is Empty
-No Linked Inventory),
linkedSourceCountintegerThe number of sources that are linked to the listings associated product
categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequiredallowed
not_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]string
imageFetcherEventTriggeredbooleanExample response
{
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": 0,
"productCategoryId": 0,
"id": 0,
"name": "string",
"excluded": true,
"parentCategoryId": 0
}
},
"channelId": 0,
"productCategoryId": 0
},
"images": [
{
"listingParentId": 0,
"listingVariantId": 0,
"md5Checksum": "string",
"id": 0,
"url": "string",
"sortOrder": 0,
"createdAt": "2026-04-20T00:00:00Z",
"publishedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
"publishing": true,
"externalListingId": "string",
"listingError": "string",
"productParentImageId": 0,
"productVariantImageId": 0
}
],
"options": [
{
"listingParentId": 0,
"globalOptionId": 0,
"id": 0,
"name": "string",
"optionValues": [
{
"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
},
"listingParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"id": 0,
"accountId": 0,
"sku": "string",
"masterSku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"weightUnit": {
"handle": "pound",
"abbreviatedHandle": "lb"
},
"dimensionUnit": {
"handle": "inch",
"abbreviatedHandle": "in"
},
"dimensionalWeight": 0,
"images": [
{
"listingParentId": null,
"listingVariantId": null,
"md5Checksum": null,
"id": null,
"url": null,
"sortOrder": null,
"createdAt": null,
"publishedAt": null,
"staticContentUpdatedAt": null,
"staticContentSyncedAt": null,
"dynamicContentUpdatedAt": null,
"dynamicCOntentSyncedAt": null,
"publishing": null,
"externalListingId": null,
"listingError": null,
"productParentImageId": null,
"productVariantImageId": null
}
],
"options": [
{
"listingParentOptionId": null,
"globalOptionValueId": null,
"listingVariantId": null,
"id": null,
"name": null,
"value": null,
"position": null,
"globalPosition": null
}
],
"channelId": 0,
"productVariantId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"pausedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"linkedToRegularProduct": true,
"externalReferenceId": "string",
"externalReferenceIdType": "string",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"listingParent": {
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryTwo": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"categoryThree": {
"accountId": null,
"insertedAt": null,
"updatedAt": null,
"customized": null,
"id": null,
"name": null,
"parentCategoryId": null,
"productCategory": null,
"channelId": null,
"productCategoryId": null
},
"images": [
null
],
"options": [
null
],
"attributes": [
null
],
"customFields": [
null
],
"variants": [
null
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": null,
"handle": null,
"name": null
},
"changeToListingStatus": {
"id": null,
"handle": null,
"name": null
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
null
],
"imageFetcherEventTriggered": true
},
"customAggregateFields": [
{
"id": null,
"listingVariantId": null,
"accountId": null,
"customAggregateField": null,
"name": null,
"value": null,
"customAggregateFieldId": null
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"profit": 0,
"profitPercentage": 0,
"profitWithFees": 0,
"profitWithFeesPercentage": 0,
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"tags": [
"string"
],
"description": "string",
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"priceProtection": true,
"linkedSourceCount": 0
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
"string"
],
"imageFetcherEventTriggered": true
}OpenAPI fragment
{
"post": {
"summary": "Create/Update Listing Parent",
"description": "Create/Update a listing 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"
},
{
"name": "modifyPublishData",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"allowEmptyValue": true,
"description": "Should publish fields (ie `publishError`, `staticContentUpdatedAt`, `staticContentSyncedAt`) of the parent/variant be modified"
},
{
"name": "modifyChannelData",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"allowEmptyValue": true,
"description": "Should channel related fields (ie `externalLIstingId`, `linkAttemptedAt`, `linkedToRegularProduct`, `externalReferenceId`, `externalReferenceIdType`) of the parent/variant be modified"
},
{
"name": "modifySyncData",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"allowEmptyValue": true,
"description": "Should sync fields (ie `syncError`, `dynamicContentUpdatedAt`, `dynamicContentSyncedAt`) of the parent/variant be modified"
},
{
"name": "modifyStatusData",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"updateNonNull"
]
},
"allowEmptyValue": true,
"description": "Should status fields (ie `pausedAt`, `listingStatusId`, `changeToListingStatusId`, `scheduledToDeleteAt`) of the parent/variant be modified"
},
{
"name": "modifyCategoryAiData",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"none",
"update",
"delete"
]
},
"description": "Should category ai data be modified"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListingParentRequest"
}
}
}
},
"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/ListingParent"
}
}
}
},
"201": {
"description": "CREATED - A new parent was created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListingParent"
}
}
}
},
"204": {
"description": "NO CONTENT - Only possible when using the `restrictCreateOrUpdate = updateOnly` param and the parent listing does not exist. This will return an empty/null response body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListingParent"
}
}
}
},
"400": {
"description": "When a invalid data condition is provided"
},
"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/ListingParent"
}
}
}
}
}
}
}Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight