WooCommerce · JSON Structure

Woocommerce Store Api Add Cart Item Input Structure

Input for adding an item to the cart.

Type: object Properties: 5 Required: 2
eCommerceOpen SourceOrdersProductsWordPress

AddCartItemInput is a JSON Structure definition published by WooCommerce, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id quantity variation_id variation item_data

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-store-api-add-cart-item-input-structure.json",
  "name": "AddCartItemInput",
  "description": "Input for adding an item to the cart.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Product ID to add.",
      "example": 1
    },
    "quantity": {
      "type": "int32",
      "description": "Quantity to add.",
      "minimum": 1,
      "example": 1
    },
    "variation_id": {
      "type": "int32",
      "description": "Variation ID for variable products.",
      "example": 1
    },
    "variation": {
      "type": "array",
      "description": "Attribute key-value pairs for the variation.",
      "items": {
        "type": "object",
        "properties": {
          "attribute": {
            "type": "string",
            "description": "Attribute name."
          },
          "value": {
            "type": "string",
            "description": "Selected attribute value."
          }
        }
      },
      "example": [
        {
          "attribute": "string-value",
          "value": "string-value"
        }
      ]
    },
    "item_data": {
      "type": "array",
      "description": "Additional custom item data.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Data key name."
          },
          "value": {
            "type": "string",
            "description": "Data value."
          }
        }
      },
      "example": [
        {
          "name": "Example Name",
          "value": "string-value"
        }
      ]
    }
  },
  "required": [
    "id",
    "quantity"
  ]
}