Rebuild Listing Variant

posthttps://api.flxpoint.com/listing/{channelId}/builder/re-build/variant/{listingVariantId}

Use this when you want to create listing 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.

Request

Bodyapplication/json

mappingTemplateIdinteger

A specific mapping template that should be used to build the listing. If not provided the default mapping template will be used/created.

rebuildIfExistsboolean

Rebuild the listing if the product variant is already built and linked to a listing in the channel

Example request

post/listing/{channelId}/builder/re-build/variant/{listingVariantId}

curl -X POST "https://api.flxpoint.com/listing/{channelId}/builder/re-build/variant/{listingVariantId}" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "mappingTemplateId": 0,
         "rebuildIfExists": true
       }'

Example body · application/json

{
  "mappingTemplateId": 0,
  "rebuildIfExists": true
}

Responses

200OKapplication/json

successbooleanrequired

errorstring

Example response

{
  "success": true,
  "error": "string"
}

400Bad Requestapplication/json

successbooleanrequired

errorstring

Example response

{
  "success": true,
  "error": "string"
}

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "post": {
    "summary": "Rebuild Listing Variant",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListingBuilderRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReBuildResponse"
            },
            "examples": {
              "example-1": {
                "value": {
                  "success": true
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReBuildResponse"
            },
            "examples": {
              "example-1": {
                "value": {
                  "success": false,
                  "error": "Something happened"
                }
              }
            }
          }
        }
      },
      "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