[Deprecated] Get Inventory Parent

gethttps://api.flxpoint.com/inventory/{sourceId}/parentDeprecated

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

Request

Query parameters

findBySkuquerystring
Find a parent/variant by SKU
findByIdqueryinteger
Find a variant/parent by ID
includeVariantsqueryboolean
Include variants for the parent

Example request

get/inventory/{sourceId}/parent

curl -X GET "https://api.flxpoint.com/inventory/{sourceId}/parent" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

sourceIdinteger

restrictedboolean

variantCountinteger

idinteger

accountIdinteger

skustringrequired

titlestring

descriptionstring

manufacturerstring

insertedAtstring (date-time)

updatedAtstring (date-time)

archivedboolean

categoryOneobject

sourceIdinteger

productCategoryIdinteger

A product Category this inventory category is mapped to

idinteger

namestringrequired

excludedboolean

parentCategoryIdinteger

categoryTwoobject

sourceIdinteger

productCategoryIdinteger

A product Category this inventory category is mapped to

idinteger

namestringrequired

excludedboolean

parentCategoryIdinteger

categoryThreeobject

sourceIdinteger

productCategoryIdinteger

A product Category this inventory category is mapped to

idinteger

namestringrequired

excludedboolean

parentCategoryIdinteger

imagesarray[InventoryImage]

idinteger (int64)

sourceIdinteger

inventoryParentIdinteger

inventoryVariantIdinteger (int64)

hashstring

originalUrlstring

urlstringrequired

sortOrderinteger

optionsarray[InventoryParentOption]

inventoryParentIdinteger

idinteger

namestringrequired

attributesarray[InventoryParentAttribute]

idinteger (int64)

attributeIdinteger

attributeValueIdinteger

namestringrequired

originalInventoryNamestring

valuestringrequired

originalInventoryValuestring

isPrivateboolean

mergeToAttributeIdinteger

mergeToAttributeNamestring

mergeToAttributeValueIdinteger

mergeToAttributeValuestring

mergeToAttributeIsPrivateboolean

customFieldsarray[InventoryParentCustomField]

idinteger (int64)

customFieldValueIdinteger

customFieldIdinteger

namestringrequired

valuestringrequired

originalInventoryNamestring

originalInventoryValuestring

mergeToCustomFieldIdinteger

mergeToCustomFieldNamestring

mergeToCustomFieldValueIdinteger

mergeToCustomFieldValuestring

variantsarray[InventoryVariant]

sourceIdinteger

inventoryParentIdinteger

supplierVariantIdstring

shippingCostnumber

dropshipFeenumber

inventoryListPricenumber

referenceIdentifierstring

inventoryVariantIdstring (int64)deprecated

committedQuantityinteger

incomingQuantityinteger

quantityinteger

totalQuantityinteger

idinteger (int64)

accountIdintegerdeprecated

skustringrequired

titlestring

mpnstring

masterSkustring

If available from your data source populate with your primary product master SKU to enable easily linking to your existing products or as the foundation to build new product master SKUs from.

upcstring

eanstring

asinstring

msrpnumber

mapnumber

weightnumber

lengthnumber

widthnumber

heightnumber

insertedAtstring (date-time)

updatedAtstring (date-time)

totalQuantityLastChangedAtstring (date-time)

archivedboolean

costnumber

weightUnitobject

handlestring

allowedpoundouncegramkilogram

abbreviatedHandlestring

allowedlbozgkg

dimensionUnitobject

handlestring

allowedinchcentimeter

abbreviatedHandlestring

allowedincm

dimensionalWeightnumber

imagesarray[InventoryImage]

idinteger (int64)

sourceIdinteger

inventoryParentIdinteger

inventoryVariantIdinteger (int64)

hashstring

originalUrlstring

urlstringrequired

sortOrderinteger

optionsarray[InventoryVariantOption]

inventoryParentOptionIdinteger

inventoryVariantIdinteger (int64)

idinteger (int64)

namestringrequired

valuestringrequired

customAggregateFieldsarray[InventoryVariantCustomAggregateField]

idinteger (int64)

sourceVariantIdinteger (int64)

accountIdinteger

customAggregateFieldobject

idinteger

aggregateFieldDataTypeIdinteger

customAggregateFieldOptionIdinteger

namestring

handlestring

ignoreOutOfStockboolean

default false

accountIdinteger

namestring

valuenumber

customAggregateFieldIdinteger

parentobject

sourceIdinteger

restrictedboolean

variantCountinteger

idinteger

accountIdinteger

skustringrequired

titlestring

descriptionstring

manufacturerstring

insertedAtstring (date-time)

updatedAtstring (date-time)

archivedboolean

categoryOneobject

sourceIdinteger

productCategoryIdinteger

A product Category this inventory category is mapped to

idinteger

namestringrequired

excludedboolean

parentCategoryIdinteger

categoryTwoobject

sourceIdinteger

productCategoryIdinteger

A product Category this inventory category is mapped to

idinteger

namestringrequired

excludedboolean

parentCategoryIdinteger

categoryThreeobject

sourceIdinteger

productCategoryIdinteger

A product Category this inventory category is mapped to

idinteger

namestringrequired

excludedboolean

parentCategoryIdinteger

imagesarray[InventoryImage]

idinteger (int64)

sourceIdinteger

inventoryParentIdinteger

inventoryVariantIdinteger (int64)

hashstring

originalUrlstring

urlstringrequired

sortOrderinteger

optionsarray[InventoryParentOption]

inventoryParentIdinteger

idinteger

namestringrequired

attributesarray[InventoryParentAttribute]

idinteger (int64)

attributeIdinteger

attributeValueIdinteger

namestringrequired

originalInventoryNamestring

valuestringrequired

originalInventoryValuestring

isPrivateboolean

mergeToAttributeIdinteger

mergeToAttributeNamestring

mergeToAttributeValueIdinteger

mergeToAttributeValuestring

mergeToAttributeIsPrivateboolean

customFieldsarray[InventoryParentCustomField]

idinteger (int64)

customFieldValueIdinteger

customFieldIdinteger

namestringrequired

valuestringrequired

originalInventoryNamestring

originalInventoryValuestring

mergeToCustomFieldIdinteger

mergeToCustomFieldNamestring

mergeToCustomFieldValueIdinteger

mergeToCustomFieldValuestring

variantsarray[InventoryVariant]

sourceIdinteger

inventoryParentIdinteger

supplierVariantIdstring

shippingCostnumber

dropshipFeenumber

inventoryListPricenumber

referenceIdentifierstring

inventoryVariantIdstring (int64)deprecated

committedQuantityinteger

incomingQuantityinteger

quantityinteger

totalQuantityinteger

idinteger (int64)

accountIdintegerdeprecated

skustringrequired

titlestring

mpnstring

masterSkustring

If available from your data source populate with your primary product master SKU to enable easily linking to your existing products or as the foundation to build new product master SKUs from.

upcstring

eanstring

asinstring

msrpnumber

mapnumber

weightnumber

lengthnumber

widthnumber

heightnumber

insertedAtstring (date-time)

updatedAtstring (date-time)

totalQuantityLastChangedAtstring (date-time)

archivedboolean

costnumber

weightUnitobject

handlestring

allowedpoundouncegramkilogram

abbreviatedHandlestring

allowedlbozgkg

dimensionUnitobject

handlestring

allowedinchcentimeter

abbreviatedHandlestring

allowedincm

dimensionalWeightnumber

imagesarray[InventoryImage]

optionsarray[InventoryVariantOption]

customAggregateFieldsarray[InventoryVariantCustomAggregateField]

parentobject

sourceIdinteger

restrictedboolean

variantCountinteger

idinteger

accountIdinteger

skustringrequired

titlestring

descriptionstring

manufacturerstring

insertedAtstring (date-time)

updatedAtstring (date-time)

archivedboolean

categoryOneInventoryCategory

categoryTwoInventoryCategory

categoryThreeInventoryCategory

imagesarray[InventoryImage]

optionsarray[InventoryParentOption]

attributesarray[InventoryParentAttribute]

customFieldsarray[InventoryParentCustomField]

variantsarray[InventoryVariant]

categoryOneIdinteger

categoryTwoIdinteger

categoryThreeIdinteger

contentUpdatedAtstring (date-time)

lastArchivedAtstring (date-time)

lastUnarchivedAtstring (date-time)

linkedProductVariantsarray[ProductVariantInventoryLink]

scheduledToDeleteAtstring (date-time)

customFieldsarray[InventoryVariantCustomField]

allowBackordersboolean

binLocationstring

An identifier representing the location of a bin in an internal warehouse

descriptionstring

contentUpdatedAtstring (date-time)

requiresFflboolean

Indicate if FFL information will be required to fulfill this inventory variant

lastArchivedAtstring (date-time)

lastUnarchivedAtstring (date-time)

categoryOneIdinteger

categoryTwoIdinteger

categoryThreeIdinteger

contentUpdatedAtstring (date-time)

lastArchivedAtstring (date-time)

lastUnarchivedAtstring (date-time)

linkedProductVariantsarray[ProductVariantInventoryLink]

idinteger

productVariantIdinteger

inventoryVariantIdinteger (int64)required

scheduledToDeleteAtstring (date-time)

customFieldsarray[InventoryVariantCustomField]

idinteger (int64)

customFieldValueIdinteger

customFieldIdinteger

namestringrequired

valuestringrequired

originalInventoryNamestring

originalInventoryValuestring

mergeToCustomFieldIdinteger

mergeToCustomFieldNamestring

mergeToCustomFieldValueIdinteger

mergeToCustomFieldValuestring

allowBackordersboolean

binLocationstring

An identifier representing the location of a bin in an internal warehouse

descriptionstring

contentUpdatedAtstring (date-time)

requiresFflboolean

Indicate if FFL information will be required to fulfill this inventory variant

lastArchivedAtstring (date-time)

lastUnarchivedAtstring (date-time)

categoryOneIdinteger

categoryTwoIdinteger

categoryThreeIdinteger

contentUpdatedAtstring (date-time)

lastArchivedAtstring (date-time)

lastUnarchivedAtstring (date-time)

Example response

{
  "sourceId": 0,
  "restricted": true,
  "variantCount": 0,
  "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": {
    "sourceId": 0,
    "productCategoryId": 0,
    "id": 0,
    "name": "string",
    "excluded": true,
    "parentCategoryId": 0
  },
  "categoryTwo": {
    "sourceId": 0,
    "productCategoryId": 0,
    "id": 0,
    "name": "string",
    "excluded": true,
    "parentCategoryId": 0
  },
  "categoryThree": {
    "sourceId": 0,
    "productCategoryId": 0,
    "id": 0,
    "name": "string",
    "excluded": true,
    "parentCategoryId": 0
  },
  "images": [
    {
      "id": 0,
      "sourceId": 0,
      "inventoryParentId": 0,
      "inventoryVariantId": 0,
      "hash": "string",
      "originalUrl": "string",
      "url": "string",
      "sortOrder": 0
    }
  ],
  "options": [
    {
      "inventoryParentId": 0,
      "id": 0,
      "name": "string"
    }
  ],
  "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": [
    {
      "sourceId": 0,
      "inventoryParentId": 0,
      "supplierVariantId": "string",
      "shippingCost": 0,
      "dropshipFee": 0,
      "inventoryListPrice": 0,
      "referenceIdentifier": "string",
      "inventoryVariantId": "string",
      "committedQuantity": 0,
      "incomingQuantity": 0,
      "quantity": 0,
      "totalQuantity": 0,
      "id": 0,
      "accountId": 0,
      "sku": "string",
      "title": "string",
      "mpn": "string",
      "masterSku": "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",
      "totalQuantityLastChangedAt": "2026-04-20T00:00:00Z",
      "archived": true,
      "cost": 0,
      "weightUnit": {
        "handle": "pound",
        "abbreviatedHandle": "lb"
      },
      "dimensionUnit": {
        "handle": "inch",
        "abbreviatedHandle": "in"
      },
      "dimensionalWeight": 0,
      "images": [
        {
          "id": null,
          "sourceId": null,
          "inventoryParentId": null,
          "inventoryVariantId": null,
          "hash": null,
          "originalUrl": null,
          "url": null,
          "sortOrder": null
        }
      ],
      "options": [
        {
          "inventoryParentOptionId": null,
          "inventoryVariantId": null,
          "id": null,
          "name": null,
          "value": null
        }
      ],
      "customAggregateFields": [
        {
          "id": null,
          "sourceVariantId": null,
          "accountId": null,
          "customAggregateField": null,
          "name": null,
          "value": null,
          "customAggregateFieldId": null
        }
      ],
      "parent": {
        "sourceId": 0,
        "restricted": true,
        "variantCount": 0,
        "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": {
          "sourceId": null,
          "productCategoryId": null,
          "id": null,
          "name": null,
          "excluded": null,
          "parentCategoryId": null
        },
        "categoryTwo": {
          "sourceId": null,
          "productCategoryId": null,
          "id": null,
          "name": null,
          "excluded": null,
          "parentCategoryId": null
        },
        "categoryThree": {
          "sourceId": null,
          "productCategoryId": null,
          "id": null,
          "name": null,
          "excluded": null,
          "parentCategoryId": null
        },
        "images": [
          null
        ],
        "options": [
          null
        ],
        "attributes": [
          null
        ],
        "customFields": [
          null
        ],
        "variants": [
          null
        ],
        "categoryOneId": 0,
        "categoryTwoId": 0,
        "categoryThreeId": 0,
        "contentUpdatedAt": "2026-04-20T00:00:00Z",
        "lastArchivedAt": "2026-04-20T00:00:00Z",
        "lastUnarchivedAt": "2026-04-20T00:00:00Z"
      },
      "linkedProductVariants": [
        {
          "id": null,
          "productVariantId": null,
          "inventoryVariantId": null
        }
      ],
      "scheduledToDeleteAt": "2026-04-20T00:00:00Z",
      "customFields": [
        {
          "id": null,
          "customFieldValueId": null,
          "customFieldId": null,
          "name": null,
          "value": null,
          "originalInventoryName": null,
          "originalInventoryValue": null,
          "mergeToCustomFieldId": null,
          "mergeToCustomFieldName": null,
          "mergeToCustomFieldValueId": null,
          "mergeToCustomFieldValue": null
        }
      ],
      "allowBackorders": true,
      "binLocation": "string",
      "description": "string",
      "contentUpdatedAt": "2026-04-20T00:00:00Z",
      "requiresFfl": true,
      "lastArchivedAt": "2026-04-20T00:00:00Z",
      "lastUnarchivedAt": "2026-04-20T00:00:00Z"
    }
  ],
  "categoryOneId": 0,
  "categoryTwoId": 0,
  "categoryThreeId": 0,
  "contentUpdatedAt": "2026-04-20T00:00:00Z",
  "lastArchivedAt": "2026-04-20T00:00:00Z",
  "lastUnarchivedAt": "2026-04-20T00:00:00Z"
}

400If neither `findBySku` or `findById` is passed.

No schema documented for this status.

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "get": {
    "summary": "[Deprecated] Get Inventory Parent",
    "description": "",
    "parameters": [
      {
        "name": "findBySku",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "Find a parent/variant by SKU"
      },
      {
        "name": "findById",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "description": "Find a variant/parent by ID"
      },
      {
        "name": "includeVariants",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        },
        "description": "Include variants for the parent"
      }
    ],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/InventoryParent"
            }
          }
        }
      },
      "400": {
        "description": "If neither `findBySku` or `findById` is passed."
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight