Build Product from Inventory Variant

posthttps://api.flxpoint.com/product/builder/build/{inventoryVariantId}

Use this when you want to create product builder 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 a product from a specified `inventoryVariantId`

Request

Bodyapplication/json

productBuilderIdinteger

(optional) A specific product builder to use. If null the system default will be used.

mappingTemplateIdinteger

(optional) A specific mapping template to use. If null the system default will be used.

Example request

post/product/builder/build/{inventoryVariantId}

curl -X POST "https://api.flxpoint.com/product/builder/build/{inventoryVariantId}" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "productBuilderId": 0,
         "mappingTemplateId": 0
       }'

Example body · application/json

{
  "productBuilderId": 0,
  "mappingTemplateId": 0
}

Responses

200OK - A list of builder responses. This returns a list as a single inventory variant may match to multiple product variants.application/json

array[ProductBuilderBuildResponse]

builtbooleanrequired

rebuiltbooleanrequired

linkedbooleanrequired

alreadyBuiltAndLinkedbooleanrequired

needsReviewbooleanrequired

productVariantIdinteger

productParentIdinteger

inventoryVariantIdinteger (int64)required

issueobject

idinteger (int64)required

inventoryVariantIdinteger (int64)required

accountIdinteger

insertedAtstring (date-time)

mappingTemplateIdinteger

productBuilderIdinteger

matchedProductVariantIdinteger

The product variant ID that this inventory variant matched with on the basis of a shared GTIN that it will be added as an additional inventory link to.

typestring

allowedmismatchduplicate_sourcesarchivedparent_creationparent_attachmentduplicate_skupending_buildinvalid_upc

statusstring

allowedkeepneeds_reviewdiscard

matchTypestring

The ID type that this inventory variant matched against an existing product variant with.

allowedupcmpneanasinreference_identifiermaster_skuinventory_sku

matchValuestring

The ID value that this inventory variant matched against an existing product variant with.

productMatchTypestring

The ID type that was used to match to an existing product variant from an inventory variant. NOTE : This value will be empty for matches made using the legacy matching style.

allowedupcmpneanasinreference_identifiermaster_sku

triggeredLinkRulesarray[ProductBuilderTriggeredLinkRule]

The product builder link rules that failed when run against this inventory variant and the existing linked ones.

productBuilderLinkRuleobjectrequired

idinteger

value1string

value2string

value3string

value4string

value5string

value6string

outcomeobjectrequired

idinteger

handlestringrequired

allowedfailreview

namestring

typeobjectrequired

idinteger

handlestringrequired

allowedcost_basiccost_rangebrands_not_equaltitle_containsmpn_not_upc

namestring

inventoryVariantIdsarray[integer (int64)]required

integer (int64)

mismatchActionKeepboolean

When the issue is of the type `MISMATCH` setting this to true will allow the next build attempt for the inventory variant to occur. Setting this to false will delete the issue.

duplicateSourceActionKeepboolean

When the issue is of the type `DUPLICATE_SOURCE` setting this to true will allow the next build attempt for the inventory variant to occur and will remove the existing inventory link from the same source. Setting this to false will delete the issue.

duplicateSourceInventoryVariantIdinteger (int64)

The inventory variant ID that is from the same source

archivedActionKeepboolean

When the issue is of the type `ARCHIVE` setting this to true will allow the next build attempt for the inventory variant to occur. Setting this to false will delete the issue.

parentCreationActionKeepboolean

When the issue is of the type `PARENT_CREATION` setting this to true will allow the next build attempt for the inventory parent & variant to occur. Setting this to false will delete the issue.

parentAttachmentActionKeepboolean

When the issue is of the type `PARENT_ATTACHMENT` setting this to true will allow the next build attempt for the inventory variant to occurr. Setting this to false will delete the issue.

duplicateSkuProductVariantIdinteger

duplicateUseSkustring

When the issue is of the type `DUPLICATE_SKU` setting this will cause the next build attempt of the inventory variant to be built with the SKU specified in this property.

generatedVariantSkustring

The variant SKU that was generated by running the inventory variant and all of the other linked inventory variants through the mapping tempmlate.

generatedParentSkustring

The parent SKU that was generated by running the inventory variant and all of the other linked inventory variants through the mapping tempmlate.

parentAttachmentProductParentIdinteger

The ID of the product parent that this inventory variant is pending being attached to.

hasListingsToBuildboolean

default false

internalBuildErrorMessagestring

Internal build error message in case product fails to build with any readable message

internalBuildErrorOnstring (date-time)

If non-null this is a timestamp indicating that the last build of this issue failed

batchIdstring (uuid)

removedDueToStaleMatchbooleanrequired

If an issue previously arose between an inventory variant and a product variant and either of the values the original match occurred on has changed the issue will be removed and the build will not be attempted.

discardedbooleanrequired

productToListingBuilderListarray[ProductToListingBuilder]

channelIdintegerrequired

productToListingQueueIdintegerrequired

Example response

[
  {
    "built": true,
    "rebuilt": true,
    "linked": true,
    "alreadyBuiltAndLinked": true,
    "needsReview": true,
    "productVariantId": 0,
    "productParentId": 0,
    "inventoryVariantId": 0,
    "issue": {
      "id": 0,
      "inventoryVariantId": 0,
      "accountId": 0,
      "insertedAt": "2026-04-20T00:00:00Z",
      "mappingTemplateId": 0,
      "productBuilderId": 0,
      "matchedProductVariantId": 0,
      "type": "mismatch",
      "status": "keep",
      "matchType": "upc",
      "matchValue": "string",
      "productMatchType": "upc",
      "triggeredLinkRules": [
        {
          "productBuilderLinkRule": null,
          "inventoryVariantIds": null
        }
      ],
      "mismatchActionKeep": true,
      "duplicateSourceActionKeep": true,
      "duplicateSourceInventoryVariantId": 0,
      "archivedActionKeep": true,
      "parentCreationActionKeep": true,
      "parentAttachmentActionKeep": true,
      "duplicateSkuProductVariantId": 0,
      "duplicateUseSku": "string",
      "generatedVariantSku": "string",
      "generatedParentSku": "string",
      "parentAttachmentProductParentId": 0,
      "hasListingsToBuild": true,
      "internalBuildErrorMessage": "string",
      "internalBuildErrorOn": "2026-04-20T00:00:00Z",
      "batchId": "string"
    },
    "removedDueToStaleMatch": true,
    "discarded": true,
    "productToListingBuilderList": [
      {
        "channelId": 0,
        "productToListingQueueId": 0
      }
    ]
  }
]

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "post": {
    "summary": "Build Product from Inventory Variant",
    "description": "Create a product from a specified `inventoryVariantId`",
    "parameters": [],
    "requestBody": {
      "description": "",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/InventoryProductBuilderBuildOptions"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK - A list of builder responses. This returns a list as a single inventory variant may match to multiple product variants.",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProductBuilderBuildResponse"
              }
            }
          }
        }
      },
      "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