Get Listing Parents
https://api.flxpoint.com/listing/parentsUse this when you want to pull listing data through the API.
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
This endpoint will fetch back a list of Listing Parents. If you're a new integrator, it's recommended to read the `Integrating as a Channel` guide.
Only returns 4000 variants per request. If you are not able to retrieve all variants in a single request, please lower your page size
Request
pagequeryintegerpage number
default 1pageSizequeryintegernumber of elements per page
default 20max 50channelIdqueryintegerThis will be automatically populated for Channel API Tokens. Required if using an Account API Token
skusqueryarray[string]Finds elements matching these SKUs. Max 50
max 50 itemsupdatedAfterquerystring (date-time)Only retrieves back elements that have been updated after the date specified
publishquerybooleanRead our API Guides to learn about this flag. Passing `true` requires you to respond for the interaction.
includeDeletingquerybooleanFilter listing parents based on whether or not they have been deleted
default trueincludePausedquerybooleanFilter listing parents based on whether or not they have been paused
default trueincludeOutOfStockVariantsquerybooleanIf "false" is passed, it will not return out of stock inventory variants.
default trueincludeHavingImagesCachedquerybooleanIf "true" is passed, it will only return inventory parents/variants with cached images.
default falsechangeToListingStatusHandlequerystringOnly retrieves back elements that have been queued to change to the specified listing status.
includeImagesquerybooleanIf "false" is passed, the "image" and "parent.image" nodes will not be populated
default falseincludeOptionsquerybooleanIf "false" is passed, the "options" and "parent.options" nodes will not be populated
default falseincludeAttributesquerybooleanIf "true" is passed, the "parent.attributes" node will be populated.
default falseincludeCategoriesquerybooleanIf "true" is passed, the parent category nodes will be populated.
default falseincludeCustomFieldsquerybooleanIf "true" is passed, the "customFields" nodes will be populated.
default falseincludeVariantsquerybooleanInclude variants for the parent
default falseincludeOverwritesquerybooleanwill include dynamic prices and quantities if they are overwritten with fixed values
default falseincludeCustomAggregatesquerybooleanIf "false" is passed, the "customAggregates"(Fields) node will not be populated. Custom Aggregates are similar to custom fields, but they can be aggregated across multiple sources.
default falseincludeTagsquerybooleanDetermines if "tags" are returned in the response
default false
Example request
/listing/parentscurl -X GET "https://api.flxpoint.com/listing/parents" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OKapplication/json
idintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegerchannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegersizeinteger (int64)compressedbooleanwidthintegerheightintegersharedImagebooleanoptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]idintegeroptionIdintegervaluestringpositionintegerglobalPositionintegerglobalOptionValueIdinteger (int64)attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwriteobjectpriceOverwrittenbooleancostOverwrittenbooleanmsrpOverwrittenbooleanmapOverwrittenbooleanshippingCostOverwrittenbooleandropshipFeeOverwrittenbooleandynamicPricenumberdynamicCostnumberdynamicMsrpnumberdynamicMapnumberdynamicShippingCostnumberdynamicDropshipFeenumberquantityOverwriteobjectquantityOverwrittenbooleandynamicQuantityintegerorderVolumeProtectionLockedAtstringlastManualQuantityintegerisLockedByOrderVolumeProtectionboolean"false"listingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringtitlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitobjecthandlestringpoundouncegramkilogramabbreviatedHandlestringlbozgkgdimensionUnitobjecthandlestringinchcentimeterabbreviatedHandlestringincmdimensionalWeightnumberimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegersizeinteger (int64)compressedbooleanwidthintegerheightintegersharedImagebooleanoptionsarray[ListingVariantOption]listingParentOptionIdintegerglobalOptionValueIdinteger (int64)listingVariantIdintegeridintegernamestringrequiredvaluestringrequiredpositionintegerglobalPositionintegerbundlebooleanchannelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusobjectidintegerhandlestringrequirednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequirednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringlistingParentobjectidintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorychannelIdintegerrequiredproductCategoryIdintegercategoryTwoobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorychannelIdintegerrequiredproductCategoryIdintegercategoryThreeobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerproductCategoryobjectaccountIdintegerinsertedAtstring (date-time)updatedAtstring (date-time)customizedbooleanidintegernamestringrequiredparentCategoryIdintegerinventoryCategoryInventoryCategorychannelIdintegerrequiredproductCategoryIdintegerimagesarray[ListingImage]listingParentIdintegerlistingVariantIdintegermd5ChecksumstringidintegerurlstringrequiredsortOrderintegercreatedAtstring (date-time)publishedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicCOntentSyncedAtstring (date-time)publishingbooleanexternalListingIdstringlistingErrorstringproductParentImageIdintegerproductVariantImageIdintegersizeinteger (int64)compressedbooleanwidthintegerheightintegersharedImagebooleanoptionsarray[ListingParentOption]listingParentIdintegerglobalOptionIdinteger (int64)idintegernamestringrequiredoptionValuesarray[OptionValue]attributesarray[ListingParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[ListingParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[ListingVariant]priceOverwritePriceOverwritequantityOverwriteQuantityOverwritelistingParentIdintegerpricenumbersalePricenumberestimatedShippingCostnumberestimatedDropshipFeenumberinventoryListPricenumberimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)idintegeraccountIdintegerskustringrequiredmasterSkustringtitlestringmpnstringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancostnumberquantityintegerweightUnitWeightUnitdimensionUnitDimensionUnitdimensionalWeightnumberimagesarray[ListingImage]optionsarray[ListingVariantOption]bundlebooleanchannelIdintegerrequiredproductVariantIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringpausedAtstring (date-time)staticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)dynamicContentUpdatedAtstring (date-time)dynamicContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)linkedToRegularProductbooleanexternalReferenceIdstringexternalReferenceIdTypestringlistingStatusListingStatuschangeToListingStatusListingStatuslistingParentListingParentcustomAggregateFieldsarray[ListingVariantCustomAggregateField]scheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]tagsarray[string]descriptionstringrequiresFflbooleanimageFetcherEventTriggeredbooleanpriceProtectionbooleanlinkedSourceCountintegerlocationsarray[ListingChannelLocation]inventoryLinksarray[ListingInventoryLink]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequirednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequirednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]imageFetcherEventTriggeredbooleancustomAggregateFieldsarray[ListingVariantCustomAggregateField]idinteger (int64)listingVariantIdintegeraccountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleanfalseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerscheduledToDeleteAtstring (date-time)profitnumberprofitPercentagenumberprofitWithFeesnumberprofitWithFeesPercentagenumbercustomFieldsarray[ListingVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringtagsarray[string]descriptionstringrequiresFflbooleanimageFetcherEventTriggeredbooleanpriceProtectionbooleanlinkedSourceCountintegerlocationsarray[ListingChannelLocation]channelLocationExternalIdstringsourceIdinteger (int32)inventoryVariantIdinteger (int64)quantityinteger (int32)inventoryLinksarray[ListingInventoryLink]sourceIdinteger (int32)inventoryVariantIdinteger (int64)enabledbooleanwonbooleanquantityinteger (int32)originalQuantityinteger (int32)minimumQuantityinteger (int32)costnumbermsrpnumbermapnumbershippingCostnumberdropshipFeenumbertotalCostnumberinventoryListPricenumberarchivedbooleanchannelLocationExternalIdstringcategoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegerimagesFetchedbooleanbuiltWithMappingTemplateIdintegerbuiltAtstring (date-time)rebuiltAtstring (date-time)channelIdintegerrequiredproductParentIdintegerrequiredexternalListingIdstringpublishErrorstringsyncErrorstringstaticContentUpdatedAtstring (date-time)staticContentSyncedAtstring (date-time)linkAttemptedAtstring (date-time)listingStatusobjectidintegerhandlestringrequirednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringchangeToListingStatusobjectidintegerhandlestringrequirednot_listedlistedhiddendelistedpublishedbroken_linkoverwrite_datanamestringpausedAtstring (date-time)scheduledToDeleteAtstring (date-time)tagsarray[string]imageFetcherEventTriggeredboolean[
{
"id": 0,
"accountId": 0,
"sku": "string",
"title": "string",
"description": "string",
"manufacturer": "string",
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"categoryOne": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": null,
"productCategoryId": null,
"id": null,
"name": null,
"excluded": null,
"parentCategoryId": null
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryTwo": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": null,
"productCategoryId": null,
"id": null,
"name": null,
"excluded": null,
"parentCategoryId": null
}
},
"channelId": 0,
"productCategoryId": 0
},
"categoryThree": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"productCategory": {
"accountId": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"customized": true,
"id": 0,
"name": "string",
"parentCategoryId": 0,
"inventoryCategory": {
"sourceId": null,
"productCategoryId": null,
"id": null,
"name": null,
"excluded": null,
"parentCategoryId": null
}
},
"channelId": 0,
"productCategoryId": 0
},
"images": [
{
"listingParentId": 0,
"listingVariantId": 0,
"md5Checksum": "string",
"id": 0,
"url": "string",
"sortOrder": 0,
"createdAt": "2026-04-20T00:00:00Z",
"publishedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicCOntentSyncedAt": "2026-04-20T00:00:00Z",
"publishing": true,
"externalListingId": "string",
"listingError": "string",
"productParentImageId": 0,
"productVariantImageId": 0,
"size": 0,
"compressed": true,
"width": 0,
"height": 0,
"sharedImage": true
}
],
"options": [
{
"listingParentId": 0,
"globalOptionId": 0,
"id": 0,
"name": "string",
"optionValues": [
null
]
}
],
"attributes": [
{
"id": 0,
"attributeId": 0,
"attributeValueId": 0,
"name": "string",
"originalInventoryName": "string",
"value": "string",
"originalInventoryValue": "string",
"isPrivate": true,
"mergeToAttributeId": 0,
"mergeToAttributeName": "string",
"mergeToAttributeValueId": 0,
"mergeToAttributeValue": "string",
"mergeToAttributeIsPrivate": true
}
],
"customFields": [
{
"id": 0,
"customFieldValueId": 0,
"customFieldId": 0,
"name": "string",
"value": "string",
"originalInventoryName": "string",
"originalInventoryValue": "string",
"mergeToCustomFieldId": 0,
"mergeToCustomFieldName": "string",
"mergeToCustomFieldValueId": 0,
"mergeToCustomFieldValue": "string"
}
],
"variants": [
{
"priceOverwrite": {
"priceOverwritten": null,
"costOverwritten": null,
"msrpOverwritten": null,
"mapOverwritten": null,
"shippingCostOverwritten": null,
"dropshipFeeOverwritten": null,
"dynamicPrice": null,
"dynamicCost": null,
"dynamicMsrp": null,
"dynamicMap": null,
"dynamicShippingCost": null,
"dynamicDropshipFee": null
},
"quantityOverwrite": {
"quantityOverwritten": null,
"dynamicQuantity": null,
"orderVolumeProtectionLockedAt": null,
"lastManualQuantity": null,
"isLockedByOrderVolumeProtection": null
},
"listingParentId": 0,
"price": 0,
"salePrice": 0,
"estimatedShippingCost": 0,
"estimatedDropshipFee": 0,
"inventoryListPrice": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"id": 0,
"accountId": 0,
"sku": "string",
"masterSku": "string",
"title": "string",
"mpn": "string",
"upc": "string",
"ean": "string",
"asin": "string",
"msrp": 0,
"map": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"insertedAt": "2026-04-20T00:00:00Z",
"updatedAt": "2026-04-20T00:00:00Z",
"archived": true,
"cost": 0,
"quantity": 0,
"weightUnit": {
"handle": null,
"abbreviatedHandle": null
},
"dimensionUnit": {
"handle": null,
"abbreviatedHandle": null
},
"dimensionalWeight": 0,
"images": [
null
],
"options": [
null
],
"bundle": true,
"channelId": 0,
"productVariantId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"pausedAt": "2026-04-20T00:00:00Z",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"dynamicContentUpdatedAt": "2026-04-20T00:00:00Z",
"dynamicContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"linkedToRegularProduct": true,
"externalReferenceId": "string",
"externalReferenceIdType": "string",
"listingStatus": {
"id": null,
"handle": null,
"name": null
},
"changeToListingStatus": {
"id": null,
"handle": null,
"name": null
},
"listingParent": {
"id": null,
"accountId": null,
"sku": null,
"title": null,
"description": null,
"manufacturer": null,
"insertedAt": null,
"updatedAt": null,
"archived": null,
"categoryOne": null,
"categoryTwo": null,
"categoryThree": null,
"images": null,
"options": null,
"attributes": null,
"customFields": null,
"variants": null,
"categoryOneId": null,
"categoryTwoId": null,
"categoryThreeId": null,
"imagesFetched": null,
"builtWithMappingTemplateId": null,
"builtAt": null,
"rebuiltAt": null,
"channelId": null,
"productParentId": null,
"externalListingId": null,
"publishError": null,
"syncError": null,
"staticContentUpdatedAt": null,
"staticContentSyncedAt": null,
"linkAttemptedAt": null,
"listingStatus": null,
"changeToListingStatus": null,
"pausedAt": null,
"scheduledToDeleteAt": null,
"tags": null,
"imageFetcherEventTriggered": null
},
"customAggregateFields": [
null
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"profit": 0,
"profitPercentage": 0,
"profitWithFees": 0,
"profitWithFeesPercentage": 0,
"customFields": [
null
],
"tags": [
null
],
"description": "string",
"requiresFfl": true,
"imageFetcherEventTriggered": true,
"priceProtection": true,
"linkedSourceCount": 0,
"locations": [
null
],
"inventoryLinks": [
null
]
}
],
"categoryOneId": 0,
"categoryTwoId": 0,
"categoryThreeId": 0,
"imagesFetched": true,
"builtWithMappingTemplateId": 0,
"builtAt": "2026-04-20T00:00:00Z",
"rebuiltAt": "2026-04-20T00:00:00Z",
"channelId": 0,
"productParentId": 0,
"externalListingId": "string",
"publishError": "string",
"syncError": "string",
"staticContentUpdatedAt": "2026-04-20T00:00:00Z",
"staticContentSyncedAt": "2026-04-20T00:00:00Z",
"linkAttemptedAt": "2026-04-20T00:00:00Z",
"listingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"changeToListingStatus": {
"id": 0,
"handle": "not_listed",
"name": "string"
},
"pausedAt": "2026-04-20T00:00:00Z",
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"tags": [
"string"
],
"imageFetcherEventTriggered": true
}
]401Unauthorized
No schema documented for this status.
OpenAPI fragment
{
"get": {
"summary": "Get Listing Parents",
"description": "This endpoint will fetch back a list of Listing Parents. If you're a new integrator, it's recommended to read the `Integrating as a Channel` guide.\n\nOnly returns 4000 variants per request. If you are not able to retrieve all variants in a single request, please lower your page size",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"description": "page number"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"maximum": 50
},
"description": "number of elements per page"
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "channelId",
"description": "This will be automatically populated for Channel API Tokens. Required if using an Account API Token"
},
{
"schema": {
"type": "array",
"maxItems": 50,
"example": "SKU123,SKU456,SKU789",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"in": "query",
"name": "skus",
"description": "Finds elements matching these SKUs. Max 50",
"style": "form",
"explode": false
},
{
"schema": {
"type": "string",
"format": "date-time"
},
"in": "query",
"name": "updatedAfter",
"description": "Only retrieves back elements that have been updated after the date specified"
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "publish",
"description": "Read our API Guides to learn about this flag. Passing `true` requires you to respond for the interaction."
},
{
"schema": {
"type": "boolean",
"default": true
},
"in": "query",
"name": "includeDeleting",
"description": "Filter listing parents based on whether or not they have been deleted"
},
{
"schema": {
"type": "boolean",
"default": true
},
"in": "query",
"name": "includePaused",
"description": "Filter listing parents based on whether or not they have been paused"
},
{
"schema": {
"type": "boolean",
"default": true
},
"in": "query",
"name": "includeOutOfStockVariants",
"description": "If \"false\" is passed, it will not return out of stock inventory variants."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeHavingImagesCached",
"description": "If \"true\" is passed, it will only return inventory parents/variants with cached images."
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "changeToListingStatusHandle",
"description": "Only retrieves back elements that have been queued to change to the specified listing status."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeImages",
"description": "If \"false\" is passed, the \"image\" and \"parent.image\" nodes will not be populated"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeOptions",
"description": "If \"false\" is passed, the \"options\" and \"parent.options\" nodes will not be populated"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeAttributes",
"description": "If \"true\" is passed, the \"parent.attributes\" node will be populated. "
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeCategories",
"description": "If \"true\" is passed, the parent category nodes will be populated."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeCustomFields",
"description": "If \"true\" is passed, the \"customFields\" nodes will be populated. "
},
{
"name": "includeVariants",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"description": "Include variants for the parent"
},
{
"name": "includeOverwrites",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"description": "will include dynamic prices and quantities if they are overwritten with fixed values"
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeCustomAggregates",
"description": "If \"false\" is passed, the \"customAggregates\"(Fields) node will not be populated. Custom Aggregates are similar to custom fields, but they can be aggregated across multiple sources. "
},
{
"name": "includeTags",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"description": "Determines if \"tags\" are returned in the response"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListingParent"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
}