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

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

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

curl \
 -X GET http://api.example.com/v1/inventory-feed-fields/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "createdAt": "2024-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": [
    "string"
  ],
  "subfieldPurpose": "inventoryQuantity",
  "subfieldRegex": "string",
  "updatedAt": "2024-05-04T09:42:00+00:00"
}