Get Item By ID

GET /items/{itemId}

Get a single item by ID

Path parameters

  • itemId string(guid) Required

    ID of the item to operate on

Responses

  • 200 application/json

    A single item

    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

  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      401: Invalid Credentials

      404: Resource not found

      422: Unprocessable Entity

    • details string

      404: empty

      401: The credentials presented are not valid to access this resource

  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • error string

      401: Invalid Credentials

      404: Resource not found

      422: Unprocessable Entity

    • details string

      404: empty

      401: The credentials presented are not valid to access this resource

GET /items/{itemId}
curl \
 --request GET 'https://app.getfoundation.com/api/external/v1/items/{itemId}' \
 --header "X-API-Key: $API_KEY"
Response examples (200)
{
  "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"
}
Response examples (401)
{
  "error": "string",
  "details": "string"
}
Response examples (404)
{
  "error": "string",
  "details": "string"
}