Get Inventory Variants
https://api.flxpoint.com/inventory/variantsUse this when you want to pull inventory 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 Inventory Variants. If values are provided for both `skus` and `ids` parameters only `ids` will be used.
Request
pagequeryintegerpage number
default 1pageSizequeryintegernumber of elements per page
default 50max 1000sinceIdqueryinteger (int64)If passed, returns only inventory variants with an id greater than this value. When updatedAfter is not set, results are ordered by id, so you can page through all variants quickly by passing the last id from the previous page as sinceId, with page=1.
updatedAfterquerystring (date-time)Only retrieves inventory variants updated after the date specified. When set, results are ordered by updatedAt (oldest first) instead of by id. If sinceId is also set, both filters apply (id greater than sinceId and updated after this date) and results stay ordered by updatedAt, so use page rather than sinceId to move through the results.
sourceIdqueryintegerThis will be automatically populated for Source API Tokens. Required if using an Account API Token
skusqueryarray[string]Finds elements matching these SKUs. Max must be less than or equal to pageSize.
max 100 itemsupcsqueryarray[string]Finds elements matching these UPCs. Max must be less than or equal to pageSize.
max 100 itemsidsqueryarray[integer (int64)]Finds elements matching these IDs. Max must be less than or equal to pageSize.
max 100 itemsincludeParentquerybooleanIf "true" is passed, the "parent" node will be populated with Parent information. NOTE : The "variants" will be empty in this node to prevent circular references.
default falseincludeImagesquerybooleanIf "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 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 falseincludeLinkedProductVariantsquerybooleanIf "false" is passed, the "linkedProductVariants" node will not be populated.
default truefilterNeedsDeletingquerybooleanIf "true" is passed, it will return inventory variants which are scheduled to delete.
default falsefilterArchivedquerybooleanIf "true" is passed, it will return only archived variants. If "false" is passed, only unarchived variants will be returned. The default value of null will return all variants.
filterCustomFieldNamequerystringFilter inventory variants that contain a custom field matching the name provided.
filterCustomFieldValuequerystringFilter inventory variants that contain a custom field matching the value provided. Must be used in conjunction with a passed value for `filterCustomFieldName`, otherwise a `400` bad request will be returned.
Example request
/inventory/variantscurl -X GET "https://api.flxpoint.com/inventory/variants" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OKapplication/json
sourceIdintegerinventoryParentIdintegersupplierVariantIdstringshippingCostnumberdropshipFeenumberinventoryListPricenumberreferenceIdentifierstringinventoryVariantIdstring (int64)deprecatedcommittedQuantityintegerincomingQuantityintegerquantityintegertotalQuantityintegeridinteger (int64)accountIdintegerdeprecatedskustringrequiredtitlestringmpnstringmasterSkustringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)totalQuantityLastChangedAtstring (date-time)archivedbooleancostnumberweightUnitobjecthandlestringpoundouncegramkilogramabbreviatedHandlestringlbozgkgdimensionUnitobjecthandlestringinchcentimeterabbreviatedHandlestringincmdimensionalWeightnumberimagesarray[InventoryImage]idinteger (int64)sourceIdintegerinventoryParentIdintegerinventoryVariantIdinteger (int64)hashstringoriginalUrlstringurlstringrequiredsortOrderintegeroptionsarray[InventoryVariantOption]inventoryParentOptionIdintegerinventoryVariantIdinteger (int64)idinteger (int64)namestringrequiredvaluestringrequiredcustomAggregateFieldsarray[InventoryVariantCustomAggregateField]idinteger (int64)sourceVariantIdinteger (int64)accountIdintegercustomAggregateFieldobjectidintegeraggregateFieldDataTypeIdintegercustomAggregateFieldOptionIdintegernamestringhandlestringignoreOutOfStockbooleanfalseaccountIdintegernamestringvaluenumbercustomAggregateFieldIdintegerparentobjectsourceIdintegerrestrictedbooleanvariantCountintegeridintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryTwoobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryThreeobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegerimagesarray[InventoryImage]idinteger (int64)sourceIdintegerinventoryParentIdintegerinventoryVariantIdinteger (int64)hashstringoriginalUrlstringurlstringrequiredsortOrderintegeroptionsarray[InventoryParentOption]inventoryParentIdintegeridintegernamestringrequiredattributesarray[InventoryParentAttribute]idinteger (int64)attributeIdintegerattributeValueIdintegernamestringrequiredoriginalInventoryNamestringvaluestringrequiredoriginalInventoryValuestringisPrivatebooleanmergeToAttributeIdintegermergeToAttributeNamestringmergeToAttributeValueIdintegermergeToAttributeValuestringmergeToAttributeIsPrivatebooleancustomFieldsarray[InventoryParentCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringvariantsarray[InventoryVariant]sourceIdintegerinventoryParentIdintegersupplierVariantIdstringshippingCostnumberdropshipFeenumberinventoryListPricenumberreferenceIdentifierstringinventoryVariantIdstring (int64)deprecatedcommittedQuantityintegerincomingQuantityintegerquantityintegertotalQuantityintegeridinteger (int64)accountIdintegerdeprecatedskustringrequiredtitlestringmpnstringmasterSkustringupcstringeanstringasinstringmsrpnumbermapnumberweightnumberlengthnumberwidthnumberheightnumberinsertedAtstring (date-time)updatedAtstring (date-time)totalQuantityLastChangedAtstring (date-time)archivedbooleancostnumberweightUnitobjecthandlestringpoundouncegramkilogramabbreviatedHandlestringlbozgkgdimensionUnitobjecthandlestringinchcentimeterabbreviatedHandlestringincmdimensionalWeightnumberimagesarray[InventoryImage]idinteger (int64)sourceIdintegerinventoryParentIdintegerinventoryVariantIdinteger (int64)hashstringoriginalUrlstringurlstringrequiredsortOrderintegeroptionsarray[InventoryVariantOption]inventoryParentOptionIdintegerinventoryVariantIdinteger (int64)idinteger (int64)namestringrequiredvaluestringrequiredcustomAggregateFieldsarray[InventoryVariantCustomAggregateField]idinteger (int64)sourceVariantIdinteger (int64)accountIdintegercustomAggregateFieldCustomAggregateFieldnamestringvaluenumbercustomAggregateFieldIdintegerparentobjectsourceIdintegerrestrictedbooleanvariantCountintegeridintegeraccountIdintegerskustringrequiredtitlestringdescriptionstringmanufacturerstringinsertedAtstring (date-time)updatedAtstring (date-time)archivedbooleancategoryOneobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryTwoobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegercategoryThreeobjectsourceIdintegerproductCategoryIdintegeridintegernamestringrequiredexcludedbooleanparentCategoryIdintegerimagesarray[InventoryImage]optionsarray[InventoryParentOption]attributesarray[InventoryParentAttribute]customFieldsarray[InventoryParentCustomField]variantsarray[InventoryVariant]categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegercontentUpdatedAtstring (date-time)lastArchivedAtstring (date-time)lastUnarchivedAtstring (date-time)linkedProductVariantsarray[InventoryProductVariantLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredscheduledToDeleteAtstring (date-time)customFieldsarray[InventoryVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringallowBackordersbooleanbinLocationstringdescriptionstringcontentUpdatedAtstring (date-time)requiresFflbooleanlastArchivedAtstring (date-time)lastUnarchivedAtstring (date-time)categoryOneIdintegercategoryTwoIdintegercategoryThreeIdintegercontentUpdatedAtstring (date-time)lastArchivedAtstring (date-time)lastUnarchivedAtstring (date-time)linkedProductVariantsarray[InventoryProductVariantLink]idintegerproductVariantIdintegerinventoryVariantIdinteger (int64)requiredscheduledToDeleteAtstring (date-time)customFieldsarray[InventoryVariantCustomField]idinteger (int64)customFieldValueIdintegercustomFieldIdintegernamestringrequiredvaluestringrequiredoriginalInventoryNamestringoriginalInventoryValuestringmergeToCustomFieldIdintegermergeToCustomFieldNamestringmergeToCustomFieldValueIdintegermergeToCustomFieldValuestringallowBackordersbooleanbinLocationstringdescriptionstringcontentUpdatedAtstring (date-time)requiresFflbooleanlastArchivedAtstring (date-time)lastUnarchivedAtstring (date-time)[
{
"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": 0,
"sourceId": 0,
"inventoryParentId": 0,
"inventoryVariantId": 0,
"hash": "string",
"originalUrl": "string",
"url": "string",
"sortOrder": 0
}
],
"options": [
{
"inventoryParentOptionId": 0,
"inventoryVariantId": 0,
"id": 0,
"name": "string",
"value": "string"
}
],
"customAggregateFields": [
{
"id": 0,
"sourceVariantId": 0,
"accountId": 0,
"customAggregateField": {
"id": null,
"aggregateFieldDataTypeId": null,
"customAggregateFieldOptionId": null,
"name": null,
"handle": null,
"ignoreOutOfStock": null,
"accountId": null
},
"name": "string",
"value": 0,
"customAggregateFieldId": 0
}
],
"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": 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": null,
"sourceId": null,
"inventoryParentId": null,
"inventoryVariantId": null,
"hash": null,
"originalUrl": null,
"url": null,
"sortOrder": null
}
],
"options": [
{
"inventoryParentId": null,
"id": null,
"name": null
}
],
"attributes": [
{
"id": null,
"attributeId": null,
"attributeValueId": null,
"name": null,
"originalInventoryName": null,
"value": null,
"originalInventoryValue": null,
"isPrivate": null,
"mergeToAttributeId": null,
"mergeToAttributeName": null,
"mergeToAttributeValueId": null,
"mergeToAttributeValue": null,
"mergeToAttributeIsPrivate": null
}
],
"customFields": [
{
"id": null,
"customFieldValueId": null,
"customFieldId": null,
"name": null,
"value": null,
"originalInventoryName": null,
"originalInventoryValue": null,
"mergeToCustomFieldId": null,
"mergeToCustomFieldName": null,
"mergeToCustomFieldValueId": null,
"mergeToCustomFieldValue": null
}
],
"variants": [
{
"sourceId": null,
"inventoryParentId": null,
"supplierVariantId": null,
"shippingCost": null,
"dropshipFee": null,
"inventoryListPrice": null,
"referenceIdentifier": null,
"inventoryVariantId": null,
"committedQuantity": null,
"incomingQuantity": null,
"quantity": null,
"totalQuantity": null,
"id": null,
"accountId": null,
"sku": null,
"title": null,
"mpn": null,
"masterSku": null,
"upc": null,
"ean": null,
"asin": null,
"msrp": null,
"map": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"insertedAt": null,
"updatedAt": null,
"totalQuantityLastChangedAt": null,
"archived": null,
"cost": null,
"weightUnit": null,
"dimensionUnit": null,
"dimensionalWeight": null,
"images": null,
"options": null,
"customAggregateFields": null,
"parent": null,
"linkedProductVariants": null,
"scheduledToDeleteAt": null,
"customFields": null,
"allowBackorders": null,
"binLocation": null,
"description": null,
"contentUpdatedAt": null,
"requiresFfl": null,
"lastArchivedAt": null,
"lastUnarchivedAt": 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": 0,
"productVariantId": 0,
"inventoryVariantId": 0
}
],
"scheduledToDeleteAt": "2026-04-20T00:00:00Z",
"customFields": [
{
"id": 0,
"customFieldValueId": 0,
"customFieldId": 0,
"name": "string",
"value": "string",
"originalInventoryName": "string",
"originalInventoryValue": "string",
"mergeToCustomFieldId": 0,
"mergeToCustomFieldName": "string",
"mergeToCustomFieldValueId": 0,
"mergeToCustomFieldValue": "string"
}
],
"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"
}
]401Unauthorized
No schema documented for this status.
OpenAPI fragment
{
"get": {
"summary": "Get Inventory Variants",
"description": "This endpoint will fetch back a list of Inventory Variants. If values are provided for both `skus` and `ids` parameters only `ids` will be used.",
"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": 50,
"maximum": 1000
},
"description": "number of elements per page"
},
{
"schema": {
"type": "integer",
"format": "int64"
},
"in": "query",
"name": "sinceId",
"description": "If passed, returns only inventory variants with an id greater than this value. When updatedAfter is not set, results are ordered by id, so you can page through all variants quickly by passing the last id from the previous page as sinceId, with page=1."
},
{
"schema": {
"type": "string",
"format": "date-time"
},
"in": "query",
"name": "updatedAfter",
"description": "Only retrieves inventory variants updated after the date specified. When set, results are ordered by updatedAt (oldest first) instead of by id. If sinceId is also set, both filters apply (id greater than sinceId and updated after this date) and results stay ordered by updatedAt, so use page rather than sinceId to move through the results."
},
{
"schema": {
"type": "integer"
},
"in": "query",
"name": "sourceId",
"description": "This will be automatically populated for Source API Tokens. Required if using an Account API Token"
},
{
"schema": {
"type": "array",
"maxItems": 100,
"example": "SKU123,SKU456,SKU789",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"in": "query",
"name": "skus",
"description": "Finds elements matching these SKUs. Max must be less than or equal to pageSize.",
"style": "form",
"explode": false
},
{
"schema": {
"type": "array",
"maxItems": 100,
"example": "012345678905,012345678912",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"in": "query",
"name": "upcs",
"description": "Finds elements matching these UPCs. Max must be less than or equal to pageSize.",
"style": "form",
"explode": false
},
{
"schema": {
"type": "array",
"maxItems": 100,
"example": "123,456,789",
"uniqueItems": true,
"items": {
"type": "integer",
"format": "int64"
}
},
"in": "query",
"name": "ids",
"description": "Finds elements matching these IDs. Max must be less than or equal to pageSize.",
"style": "form",
"explode": false
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "includeParent",
"description": "If \"true\" is passed, the \"parent\" node will be populated with Parent information. NOTE : The \"variants\" will be empty in this node to prevent circular references."
},
{
"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. "
},
{
"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. "
},
{
"schema": {
"type": "boolean",
"default": true
},
"in": "query",
"name": "includeLinkedProductVariants",
"description": "If \"false\" is passed, the \"linkedProductVariants\" node will not be populated."
},
{
"schema": {
"type": "boolean",
"default": false
},
"in": "query",
"name": "filterNeedsDeleting",
"description": "If \"true\" is passed, it will return inventory variants which are scheduled to delete."
},
{
"schema": {
"type": "boolean"
},
"in": "query",
"name": "filterArchived",
"description": "If \"true\" is passed, it will return only archived variants. If \"false\" is passed, only unarchived variants will be returned. The default value of null will return all variants."
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "filterCustomFieldName",
"description": "Filter inventory variants that contain a custom field matching the name provided."
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "filterCustomFieldValue",
"description": "Filter inventory variants that contain a custom field matching the value provided. Must be used in conjunction with a passed value for `filterCustomFieldName`, otherwise a `400` bad request will be returned."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryVariant"
}
}
}
}
},
"401": {
"description": "Unauthorized"
}
}
}
}