Get Items

GET /items

Get a list of items

Query parameters

  • page integer(int32)

    Page Number

  • limit integer(int32)

    Number of items per page

Responses

  • 200 application/json

    A list of items

    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.

      • 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

GET /items
curl \
 --request GET 'https://app.getfoundation.com/api/external/v1/items' \
 --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",
      "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"
    }
  ]
}