GET /inventory-feed-fields/{id}.json

GET /inventory-feed-fields/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.


  • 200

    Successful response

    Hide response attributes Show response attributes object
    • createdAt string(date-time)

      Created at

    • enabled boolean | null Required


      Default value is true.

    • id integer(int32)


    • inventoryFeedId integer(int32) Required

      Inventory feed

    • Inventory quantity boolean

    • inventoryQuantityDefault integer(int32) | null

      Inventory quantity default

    • metaFieldsScope string | null

      Meta fields scope

    • name string Required

      The header name is case sensitive, so make sure it matches exactly with your document's header.

    • normalizeImageUrl boolean | null

      Normalize image url

    • optionName string | null

      Option name

    • parseNumber boolean | null

      Parse number

    • prefix string | null


    • 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


      Values are barcode, compareAtPrice, costPrice, description, externalGroupId, externalId, grams, handle, images, inventoryQuantity, inventoryQuantityBoolean, metaFields, name, option, productType, requiresShipping, retailPrice, sku, tags, vendorName, or weight.

    • seperator string | null


    • slugify boolean | null


    • strip array[string] | null


    • 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

GET /inventory-feed-fields/{id}.json
curl \
 -X GET{id}.json
Response examples (200)
  "createdAt": "2023-05-04T09:42:00+00:00",
  "enabled": true,
  "id": 42,
  "inventoryFeedId": 42,
  "inventoryQuantityBoolean": "string",
  "inventoryQuantityDefault": 42,
  "metaFieldsScope": "string",
  "name": "string",
  "normalizeImageUrl": true,
  "optionName": "string",
  "parseNumber": true,
  "prefix": "string",
  "priceOperator": "addition",
  "priceOperatorField": "string",
  "priceOperatorValue": 0,
  "purpose": "barcode",
  "seperator": "string",
  "slugify": true,
  "strip": [
  "subfieldPurpose": "inventoryQuantity",
  "subfieldRegex": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"