Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • createdAt string(date-time)

    Created at

  • enabled boolean | null Required

    Enabled

    Default value is true.

  • id integer(int32)

    Id

  • inventoryFeedId integer(int32) Required

    Inventory feed

  • inventoryQuantityBoolean string | null

    Inventory quantity boolean

  • inventoryQuantityDefault integer(int32) | null

    Inventory quantity default

  • metaFieldsScope string | null

    Meta fields scope

  • name string Required

    Name

  • normalizeImageUrl boolean | null

    Normalize image url

  • optionName string | null

    Option name

  • parseNumber boolean | null

    Parse number

  • prefix string | null

    Prefix

  • priceOperator string | null Required

    Price operator

    Values are addition, subtract, multiply, or divide. Default value is addition.

  • priceOperatorField string | null

    Price operator field

  • priceOperatorValue number | null Required

    Price operator value

    Default value is 0.

  • purpose string Required

    Purpose

    Values are barcode, compareAtPrice, costPrice, countryOfOrigin, description, distanceUnit, externalGroupId, externalId, grams, handle, hsCode, images, inventoryLocation, inventoryPolicy, inventoryQuantity, inventoryQuantityBoolean, location, metaFields, mpn, name, option, packingDepth, packingHeight, packingWidth, productType, requiresShipping, retailPrice, sku, tags, vendorName, or weight.

  • seperator string | null

    Seperator

  • slugify boolean | null

    Slugify

  • strip array[string] | null

    Strip

  • subfieldPurpose string | null

    Subfield purpose

    Values are inventoryQuantity, externalId, externalGroupId, sku, vendorName, costPrice, retailPrice, name, images, productType, requiresShipping, barcode, grams, options, tags, or description.

  • subfieldRegex string | null

    Subfield regex

  • updatedAt string(date-time)

    Updated at