Add an Item

POST /items

Api key auth

Add a new item

application/json

Body

item object
Hide item attributes Show item attributes object
- title string Required
- description string
- product_code string Required
  
  Unique product code, applicable only for the parent item
- sku string
- upc string
- status string
  
  Values are draft or published.
- category_id string(guid) Required
- vendor_id string(guid)
- brand_id string(guid)
- options array[object]
  Hide options attributes Show options attributes object
  
  name string
  
  values array[string]
  
  _destroy boolean
- msrp string(float)
- unit_price string(float)
  
  Unit price of the item under default pricing
- map string(float)
  
  Minimum Advertised Price
- moq integer(int32)
  
  Minimum Order Quantity
- quantity_multiplier integer(int32)
  
  Multiple of quantity to be ordered

Responses

201 application/json

Item created
Hide response attributes Show response attributes object
- id string(guid)
  
  System generated unique identifier. Don't include this in POST request body.
- title string Required
- description string
- product_code string Required
  
  Unique product code, applicable only for the parent item
- sku string
- upc string
- status string
  
  Values are draft or published.
- category_id string(guid) Required
- vendor_id string(guid)
- brand_id string(guid)
- options array[object]
  
  Hide options attributes Show options attributes object
  
  name string
  
  values array[string]
  
  _destroy boolean
- msrp string(float)
- unit_price string(float)
  
  Unit price of the item under default pricing
- map string(float)
  
  Minimum Advertised Price
- moq integer(int32)
  
  Minimum Order Quantity
- quantity_multiplier integer(int32)
  
  Multiple of quantity to be ordered
- variants_count integer(int32)
  
  Number of variants available for the item
- category_name string
  
  Category Name to which the item belongs
- vendor_name string
  
  Vendor Name
- brand_name string
  
  Brand Name

POST /items

curl \
 --request POST 'https://stg.getfoundation.com/api/external/v1/items' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"item":{"title":"Dog Collar","description":"A beautiful dog collar","product_code":"DC","sku":"DC-001","upc":"123456789012","status":"draft","category_id":"9aa62446-c3b0-42f5-8027-3648daed9d73","vendor_id":"9aa62446-c3b0-42f5-8027-3648daed9d73","brand_id":"9aa62446-c3b0-42f5-8027-3648daed9d73","options":[{"name":"Color","values":["Red","Blue"]},{"name":"Size","values":["Small","Medium","Large"]}],"msrp":99.99,"unit_price":49.99,"map":49.99,"moq":10,"quantity_multiplier":1}}'

Request examples

{
  "item": {
    "title": "Dog Collar",
    "description": "A beautiful dog collar",
    "product_code": "DC",
    "sku": "DC-001",
    "upc": "123456789012",
    "status": "draft",
    "category_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
    "vendor_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
    "brand_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
    "options": [
      {
        "name": "Color",
        "values": [
          "Red",
          "Blue"
        ]
      },
      {
        "name": "Size",
        "values": [
          "Small",
          "Medium",
          "Large"
        ]
      }
    ],
    "msrp": 99.99,
    "unit_price": 49.99,
    "map": 49.99,
    "moq": 10,
    "quantity_multiplier": 1
  }
}

Response examples (201)

{
  "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "title": "Dog Collar",
  "description": "A beautiful dog collar",
  "product_code": "DC",
  "sku": "DC-001",
  "upc": "123456789012",
  "status": "draft",
  "category_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "vendor_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "brand_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
  "options": [
    {
      "name": "Color",
      "values": [
        "Red",
        "Blue"
      ]
    },
    {
      "name": "Size",
      "values": [
        "Small",
        "Medium",
        "Large"
      ]
    }
  ],
  "msrp": 99.99,
  "unit_price": 49.99,
  "map": 49.99,
  "moq": 10,
  "quantity_multiplier": 1,
  "variants_count": 1,
  "category_name": "Toys",
  "vendor_name": "Acme Corp",
  "brand_name": "Acme Corp"
}