POST /inventory-import-fields.json

application/json

Body Required

inventoryImportId integer(int32) Required

Inventory import
name string Required

Name
priceListId integer(int32) | null

Price list
purpose string Required

Purpose

Values are automaticallyBackorder, backorderQuantity, barcode, compareAtPrice, costPrice, denyThreshold, grams, inventoryPolicy, inventoryQuantity, price, sku, or vendorSku.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- id integer(int32) | null
  
  Id
- inventoryImportId integer(int32) Required
  
  Inventory import
- name string Required
  
  Name
- priceListId integer(int32) | null
  
  Price list
- purpose string Required
  
  Purpose
  
  Values are automaticallyBackorder, backorderQuantity, barcode, compareAtPrice, costPrice, denyThreshold, grams, inventoryPolicy, inventoryQuantity, price, sku, or vendorSku.
- updatedAt string(date-time)
  
  Updated at

POST /inventory-import-fields.json

curl \
 --request POST 'http://api.example.com/v1/inventory-import-fields.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"inventoryImportId":42,"name":"string","priceListId":42,"purpose":"automaticallyBackorder"}'

Request examples

{
  "inventoryImportId": 42,
  "name": "string",
  "priceListId": 42,
  "purpose": "automaticallyBackorder"
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "id": 42,
  "inventoryImportId": 42,
  "name": "string",
  "priceListId": 42,
  "purpose": "automaticallyBackorder",
  "updatedAt": "2025-05-04T09:42:00Z"
}