Admin APIs

Get Variants for an Item

GET /items/{itemId}/variants
Api key auth

Get a list of variants for an item

Path parameters

  • itemId string(guid) Required

    ID of the item to return variants for

Query parameters

  • page integer(int32)

    Page Number

  • limit integer(int32)

    Number of items per page

Responses

  • 200 application/json

    A list of variants for the item

    Hide response attributes Show response attributes object
    • pagination object
      Hide pagination attributes Show pagination attributes object
      • current integer(int32)
      • previous integer(int32)
      • next integer(int32)
      • limit integer(int32)
      • total_pages integer(int32)
      • total_count integer(int32)
    • data array[object]
      Hide data attributes Show data attributes object
      • id string(guid)

        System generated unique identifier. Don't include this in POST request body.

      • parent_id string(guid)
      • parent_title string
      • parent_product_code string
      • title string

        Autogenerated - Variant title is a combination of all option values

      • description string
      • sku string
      • upc string
      • msrp string(float)
      • unit_price string(float)
      • map string(float)

        Minimum Advertised Price

      • moq integer(int32)

        Minimum Order Quantity

      • quantity_multiplier integer(int32)

        Multiple of quantity to be ordered

      • options array[object]
        Hide options attributes Show options attributes object
        • name string
        • value string
        • _destroy boolean
      • sku_status string

        Status of the variant SKU (active or inactive)

        Values are active or inactive.

      • category_id string(guid)

        Inherited from parent product

      • vendor_id string(guid)

        Inherited from parent product

      • brand_id string(guid)

        Inherited from parent product

      • category_name string

        Category Name to which the item belongs, Inherited from parent product

      • vendor_name string

        Vendor Name to which the item belongs, Inherited from parent product

      • brand_name string

        Brand Name to which the item belongs, Inherited from parent product
GET /items/{itemId}/variants 
curl \
 --request GET 'https://app.getfoundation.com/api/external/v1/items/{itemId}/variants' \
 --header "X-API-Key: $API_KEY"
Response examples (200) 
{
  "pagination": {
    "current": 42,
    "previous": 42,
    "next": 42,
    "limit": 42,
    "total_pages": 42,
    "total_count": 42
  },
  "data": [
    {
      "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
      "parent_id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
      "parent_title": "Dog Collar",
      "parent_product_code": "DC",
      "title": "Large / Leather",
      "description": "A beautiful red dog collar",
      "sku": "DC-001-R",
      "upc": "123456789012",
      "msrp": 99.99,
      "unit_price": 49.99,
      "map": 49.99,
      "moq": 10,
      "quantity_multiplier": 1,
      "options": [
        {
          "name": "Size",
          "value": "Large"
        },
        {
          "name": "Material",
          "value": "Leather"
        }
      ],
      "sku_status": "active",
      "category_id": "string",
      "vendor_id": "string",
      "brand_id": "string",
      "category_name": "Toys",
      "vendor_name": "Acme Corp",
      "brand_name": "Acme Corp"
    }
  ]
}